swagger: '2.0'
info:
title: Microsoft Azure Microsoft NetApp
description: Microsoft NetApp Azure Resource Provider specification
version: 2023-07-01-preview
x-ms-code-generation-settings:
name: AzureNetAppFilesManagementClient
consumes:
- application/json
produces:
- application/json
schemes:
- https
host: management.azure.com
security:
- azure_auth:
- user_impersonation
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Azure Active Directory OAuth2 Flow
scopes:
user_impersonation: impersonate your user account
paths:
/providers/Microsoft.NetApp/operations:
get:
tags:
- Operations
summary: Microsoft Azure Describes The Resource Provider
description: Lists all of the available Microsoft.NetApp Rest API operations
operationId: microsoftAzureOperationsList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/OperationListResult'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
OperationList:
$ref: examples/OperationList.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkNameAvailability:
post:
tags:
- NetApp Resource
summary: Microsoft Azure Check Resource Name Availability
description: Check if a resource name is available.
operationId: microsoftAzureNetappresourceChecknameavailability
parameters:
- name: body
in: body
description: Name availability request.
required: true
schema:
$ref: '#/definitions/ResourceNameAvailabilityRequest'
x-ms-client-flatten: true
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CheckAvailabilityResponse'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
CheckNameAvailability:
$ref: examples/CheckNameAvailability.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkFilePathAvailability:
post:
tags:
- NetApp Resource
summary: Microsoft Azure Check File Path Availability
description: Check if a file path is available.
operationId: microsoftAzureNetappresourceCheckfilepathavailability
parameters:
- name: body
in: body
description: File path availability request.
required: true
schema:
$ref: '#/definitions/FilePathAvailabilityRequest'
x-ms-client-flatten: true
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CheckAvailabilityResponse'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
CheckFilePathAvailability:
$ref: examples/CheckFilePathAvailability.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/checkQuotaAvailability:
post:
tags:
- NetApp Resource
summary: Microsoft Azure Check Quota Availability
description: Check if a quota is available.
operationId: microsoftAzureNetappresourceCheckquotaavailability
parameters:
- name: body
in: body
description: Quota availability request.
required: true
schema:
$ref: '#/definitions/QuotaAvailabilityRequest'
x-ms-client-flatten: true
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/CheckAvailabilityResponse'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
CheckQuotaAvailability:
$ref: examples/CheckQuotaAvailability.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits:
get:
tags:
- NetApp Resource
summary: Microsoft Azure Get Quota Limits
description: Get the default and current limits for quotas
operationId: microsoftAzureNetappresourcequotalimitsList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SubscriptionQuotaItemList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
QuotaLimits:
$ref: examples/QuotaLimits_List.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/quotaLimits/{quotaLimitName}:
get:
tags:
- NetApp Resource
summary: Microsoft Azure Get Quota Limits
description: Get the default and current subscription quota limit
operationId: microsoftAzureNetappresourcequotalimitsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: '#/parameters/QuotaLimitName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/SubscriptionQuotaItem'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
QuotaLimits:
$ref: examples/QuotaLimits_Get.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos:
get:
summary: 'Microsoft Azure Describes Region Specific Information'
description: Provides region specific information.
tags:
- NetApp Resource
operationId: microsoftAzureNetappresourceregioninfosList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/regionInfosList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
RegionInfos_List:
$ref: examples/RegionInfos_List.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfos/default:
get:
summary: 'Microsoft Azure Describes Region Specific Information'
description: >-
Provides storage to network proximity and logical zone mapping
information.
tags:
- NetApp Resource
operationId: microsoftAzureNetappresourceregioninfosGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/regionInfoResource'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName:
x-ms-examples:
RegionInfos_Get:
$ref: examples/RegionInfos_Get.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/regionInfo:
get:
summary: 'Microsoft Azure Describes Region Specific Information'
description: >-
Provides storage to network proximity and logical zone mapping
information.
tags:
- NetApp Resource
operationId: microsoftAzureNetappresourceQueryregioninfo
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/regionInfo'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
RegionInfo_Query:
$ref: examples/RegionInfo.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/queryNetworkSiblingSet:
post:
tags:
- NetApp Resource
summary: Microsoft Azure Describe A Network Sibling Set
description: Get details of the specified network sibling set.
operationId: microsoftAzureNetappresourceQuerynetworksiblingset
parameters:
- name: body
in: body
description: Network sibling set to query.
required: true
schema:
$ref: '#/definitions/QueryNetworkSiblingSetRequest'
x-ms-client-flatten: true
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/networkSiblingSet'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
NetworkSiblingSet_Query:
$ref: examples/NetworkSiblingSet_Query.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/locations/{location}/updateNetworkSiblingSet:
post:
tags:
- NetApp Resource
summary: Microsoft Azure Update The Network Features Of A Network Sibling Set
description: Update the network features of the specified network sibling set.
operationId: microsoftAzureNetappresourceUpdatenetworksiblingset
parameters:
- name: body
in: body
description: Update for the specified network sibling set.
required: true
schema:
$ref: '#/definitions/UpdateNetworkSiblingSetRequest'
x-ms-client-flatten: true
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/networkSiblingSet'
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
NetworkFeatures_Update:
$ref: examples/NetworkSiblingSet_Update.json
/subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts:
get:
summary: Microsoft Azure Describe All Netapp Accounts In A Subscription
description: List and describe all NetApp accounts in the subscription.
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsListbysubscription
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/netAppAccountList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Accounts_List:
$ref: examples/Accounts_List.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts:
get:
summary: Microsoft Azure Describe All Netapp Accounts In A Resource Group
description: List and describe all NetApp accounts in the resource group.
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/netAppAccountList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Accounts_List:
$ref: examples/Accounts_List.json
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}:
get:
summary: Microsoft Azure Describe A Netapp Account
description: Get the NetApp account
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/netAppAccount'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Accounts_Get:
$ref: examples/Accounts_Get.json
put:
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsCreateorupdate
summary: Microsoft Azure Create Or Update A Netapp Account
description: Create or update the specified NetApp account within the resource group
parameters:
- name: body
description: NetApp Account object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/netAppAccount'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - account updated
schema:
$ref: '#/definitions/netAppAccount'
'201':
description: Account created
schema:
$ref: '#/definitions/netAppAccount'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Accounts_CreateOrUpdate:
$ref: examples/Accounts_CreateOrUpdate.json
Accounts_CreateOrUpdateWithActiveDirectory:
$ref: examples/Accounts_CreateOrUpdateAD.json
delete:
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsDelete
summary: Microsoft Azure Delete A Netapp Account
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
description: Delete the specified NetApp account
responses:
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Accounts_Delete:
$ref: examples/Accounts_Delete.json
patch:
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsUpdate
summary: Microsoft Azure Update A Netapp Account
description: Patch the specified NetApp account
parameters:
- name: body
description: NetApp Account object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/netAppAccountPatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - account updated
schema:
$ref: '#/definitions/netAppAccount'
'202':
description: Accepted
schema:
$ref: '#/definitions/netAppAccount'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Accounts_Update:
$ref: examples/Accounts_Update.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/renewCredentials
: post:
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsRenewcredentials
summary: Microsoft Azure Renew Identity Credentials
description: >-
Renew identity credentials that are used to authenticate to key vault,
for customer-managed key encryption. If encryption.identity.principalId
does not match identity.principalId, running this operation will fix it.
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Accounts_RenewCredentials:
$ref: examples/Accounts_RenewCredentials.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateEncryption
: post:
tags:
- NetApp Accounts
operationId: microsoftAzureAccountsMigrateencryptionkey
summary: 'Microsoft Azure Migrate Volumes Encryption Key Source'
description: >-
Migrates all volumes in a VNet to a different encryption key source
(Microsoft-managed key or Azure Key Vault). Operation fails if targeted
volumes share encryption sibling set with volumes from another account.
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: The required parameters to perform encryption migration.
in: body
required: false
schema:
$ref: '#/definitions/encryptionMigrationRequest'
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Accounts_MigrateEncryptionKey:
$ref: examples/Accounts_MigrateEncryptionKey.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools
: get:
summary: Microsoft Azure Describe All Capacity Pools
description: List all capacity pools in the NetApp Account
tags:
- Capacity Pools
operationId: microsoftAzurePoolsList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/capacityPoolList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Pools_List:
$ref: examples/Pools_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}
: get:
summary: Microsoft Azure Describe A Capacity Pool
description: Get details of the specified capacity pool
tags:
- Capacity Pools
operationId: microsoftAzurePoolsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/capacityPool'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Pools_Get:
$ref: examples/Pools_Get.json
put:
tags:
- Capacity Pools
operationId: microsoftAzurePoolsCreateorupdate
summary: Microsoft Azure Create Or Update The Specified Capacity Pool Within The Resource Group
description: Create or Update a capacity pool
parameters:
- name: body
description: Capacity pool object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/capacityPool'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - pool updated
schema:
$ref: '#/definitions/capacityPool'
'201':
description: Pool created
schema:
$ref: '#/definitions/capacityPool'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Pools_CreateOrUpdate:
$ref: examples/Pools_CreateOrUpdate.json
patch:
tags:
- Capacity Pools
operationId: microsoftAzurePoolsUpdate
summary: Microsoft Azure Update A Capacity Pool
description: Patch the specified capacity pool
parameters:
- name: body
description: Capacity pool object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/capacityPoolPatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/capacityPool'
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Pools_Update:
$ref: examples/Pools_Update.json
delete:
tags:
- Capacity Pools
operationId: microsoftAzurePoolsDelete
summary: Microsoft Azure Delete A Capacity Pool
description: Delete the specified capacity pool
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Pools_Delete:
$ref: examples/Pools_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
: get:
summary: Microsoft Azure Describe All Volumes
description: List all volumes within the capacity pool
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
tags:
- Volumes
operationId: microsoftAzureVolumesList
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Volumes_List:
$ref: examples/Volumes_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
: get:
tags:
- Volumes
operationId: microsoftAzureVolumesGet
summary: Microsoft Azure Describe A Volume
description: Get the details of the specified volume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volume'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Volumes_Get:
$ref: examples/Volumes_Get.json
put:
tags:
- Volumes
operationId: microsoftAzureVolumesCreateorupdate
summary: Microsoft Azure Create Or Update A Volume
description: Create or update the specified volume within the capacity pool
parameters:
- name: body
description: Volume object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volume'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Ok - volume updated
schema:
$ref: '#/definitions/volume'
'201':
description: Volume created
schema:
$ref: '#/definitions/volume'
'202':
description: >-
Accepted -- Create request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Volumes_CreateOrUpdate:
$ref: examples/Volumes_CreateOrUpdate.json
patch:
tags:
- Volumes
operationId: microsoftAzureVolumesUpdate
summary: Microsoft Azure Update A Volume
description: Patch the specified volume
parameters:
- name: body
description: Volume object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volumePatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volume'
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_Update:
$ref: examples/Volumes_Update.json
delete:
tags:
- Volumes
operationId: microsoftAzureVolumesDelete
summary: Microsoft Azure Delete A Volume
description: Delete the specified volume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- in: query
name: forceDelete
type: boolean
description: >-
An option to force delete the volume. Will cleanup resources
connected to the particular volume
required: false
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_Delete:
$ref: examples/Volumes_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone
: post:
tags:
- Volumes
summary: Microsoft Azure Populate Availability Zone
description: This operation will populate availability zone information for a volume
operationId: microsoftAzureVolumesPopulateavailabilityzone
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volume'
'202':
description: >-
Accepted -- populate availability zone accepted; operation will
complete asynchronously
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_PopulateAvailabilityZones:
$ref: examples/Volumes_PopulateAvailabilityZones.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revert
: post:
tags:
- Volumes Revert
summary: Microsoft Azure Revert A Volume To One Of Its Snapshots
description: Revert a volume to the snapshot specified in the body
operationId: microsoftAzureVolumesRevert
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Object for snapshot to revert supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volumeRevert'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_Revert:
$ref: examples/Volumes_Revert.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resetCifsPassword
: post:
tags:
- Reset Cifs Password
summary: Microsoft Azure Reset Cifs Password
description: Reset cifs password from volume
operationId: microsoftAzureVolumesResetcifspassword
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Volumes_ResetCifsPassword:
$ref: examples/Volumes_ResetCifsPassword.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent
: post:
tags:
- Split Clone Volume
summary: Microsoft Azure Split Clone From Parent Volume
description: ' Split operation to convert clone volume to an independent volume.'
operationId: microsoftAzureVolumesSplitclonefromparent
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_SplitClone:
$ref: examples/Volumes_SplitClone.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakFileLocks
: post:
tags:
- File Locks
summary: Microsoft Azure Break File Locks
description: Break all the file locks on a volume
operationId: microsoftAzureVolumesBreakfilelocks
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: >-
Optional body to provide the ability to clear file locks with
selected options
in: body
required: false
schema:
$ref: '#/definitions/breakFileLocksRequest'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_BreakFileLocks:
$ref: examples/Volumes_BreakFileLocks.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/getGroupIdListForLdapUser
: post:
tags:
- Group ID List for LDAP User
summary: 'Microsoft Azure Get Group Id List For Ldap User'
description: Returns the list of group Ids for a specific LDAP User
operationId: microsoftAzureVolumesListgetgroupidlistforldapuser
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Returns group Id list for a specific LDAP user
in: body
required: true
schema:
$ref: '#/definitions/getGroupIdListForLDAPUserRequest'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/getGroupIdListForLDAPUserResponse'
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
GetGroupIdListForUser:
$ref: examples/GroupIdListForLDAPUser.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/breakReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Break Volume Replication
description: Break the replication connection on the destination volume
operationId: microsoftAzureVolumesBreakreplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Optional body to force break the replication.
in: body
required: false
schema:
$ref: '#/definitions/breakReplicationRequest'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_BreakReplication:
$ref: examples/Volumes_BreakReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reestablishReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Re Establish Volume Replication
description: >-
Re-establish a previously deleted replication between 2 volumes that
have a common ad-hoc or policy-based snapshots
operationId: microsoftAzureVolumesReestablishreplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: body for the id of the source volume.
in: body
required: true
schema:
$ref: '#/definitions/reestablishReplicationRequest'
responses:
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_ReestablishReplication:
$ref: examples/Volumes_ReestablishReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/replicationStatus
: get:
tags:
- Volumes Replication
summary: Microsoft Azure Get Volume Replication Status
description: Get the status of the replication
operationId: microsoftAzureVolumesReplicationstatus
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/replicationStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Volumes_ReplicationStatus:
$ref: examples/Volumes_ReplicationStatus.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/listReplications
: post:
tags:
- Volumes Replication
summary: Microsoft Azure List Replications For Volume
description: List all replications for a specified volume
operationId: microsoftAzureVolumesListreplications
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/listReplications'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Volumes_ListReplications:
$ref: examples/Volumes_ListReplications.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/resyncReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Resync Volume Replication
description: >-
Resync the connection on the destination volume. If the operation is ran
on the source volume it will reverse-resync the connection and sync from
destination to source.
operationId: microsoftAzureVolumesResyncreplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_ResyncReplication:
$ref: examples/Volumes_ResyncReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/deleteReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Delete Volume Replication
description: >-
Delete the replication connection on the destination volume, and send
release to the source replication
operationId: microsoftAzureVolumesDeletereplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_DeleteReplication:
$ref: examples/Volumes_DeleteReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/authorizeReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Authorize Source Volume Replication
description: Authorize the replication connection on the source volume
operationId: microsoftAzureVolumesAuthorizereplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Authorize request object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/authorizeRequest'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_AuthorizeReplication:
$ref: examples/Volumes_AuthorizeReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/reinitializeReplication
: post:
tags:
- Volumes Replication
summary: Microsoft Azure Reinitialize Volume Replication
description: Re-Initializes the replication connection on the destination volume
operationId: microsoftAzureVolumesReinitializereplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_ReInitializeReplication:
$ref: examples/Volumes_ReInitializeReplication.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/peerClusterForOnPremMigration
: post:
summary: Microsoft Azure Start Cluster Peering
description: Starts peering the cluster for this migration volume
tags:
- Volumes OnPrem Migration
operationId: microsoftAzureVolumesPeerclusterforonpremmigration
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Cluster peer request object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/peerClusterForVolumeMigrationRequest'
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/clusterPeerCommandResponse'
x-ms-examples:
Volumes_PeerClusterForOnPremMigration:
$ref: examples/Volumes_PeerClusterForOnPremMigration.json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/clusterPeerCommandResponse'
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/createOnPremMigrationReplication
: post:
summary: Microsoft Azure Start Migration Process
description: >-
Starts SVM peering and returns a command to be run on the external ONTAP
to accept it. Once the SVMs have been peered a SnapMirror will be
created
tags:
- Volumes OnPrem Migration
operationId: microsoftAzureVolumesCreateonpremmigrationreplication
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
final-state-schema: '#/definitions/svmPeerCommandResponse'
x-ms-examples:
Volumes_CreateOnPremMigrationReplication:
$ref: examples/Volumes_CreateOnPremMigrationReplication.json
responses:
'200':
description: OK
schema:
$ref: '#/definitions/svmPeerCommandResponse'
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeOnPremMigration
: post:
summary: Microsoft Azure Finalize Migration Process
description: >-
Finalizes the migration of a volume by performing a final sync on the
replication, breaking and releasing the replication, and breaking the
cluster peering if no other migration is active.
tags:
- Volumes OnPrem Migration Finalize
operationId: microsoftAzureVolumesFinalizeonpremmigration
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_FinalizeOnPremMigration:
$ref: examples/Volumes_FinalizeOnPremMigration.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/performReplicationTransfer
: post:
tags:
- Volumes OnPrem Migration
summary: Microsoft Azure Perform A Replication Transfer
description: >-
Performs an adhoc replication transfer on a volume with volumeType
Migration
operationId: microsoftAzureVolumesPerformreplicationtransfer
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_PerformReplicationTransfer:
$ref: examples/Volumes_PerformReplicationTransfer.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/poolChange
: post:
tags:
- Pool Change
summary: Microsoft Azure Change Pool For Volume
description: Moves volume to another pool
operationId: microsoftAzureVolumesPoolchange
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Move volume to the pool supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/poolChangeRequest'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Volumes_AuthorizeReplication:
$ref: examples/Volumes_PoolChange.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/relocate
: post:
tags:
- Volumes Relocation
summary: Microsoft Azure Relocate Volume
description: Relocates volume to a new stamp
operationId: microsoftAzureVolumesRelocate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Relocate volume request
in: body
required: false
schema:
$ref: '#/definitions/relocateVolumeRequest'
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Volumes_Relocate:
$ref: examples/Volumes_Relocate.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/finalizeRelocation
: post:
tags:
- Volumes Relocation
summary: Microsoft Azure Finalize Volume Relocation
description: Finalizes the relocation of the volume and cleans up the old volume.
operationId: microsoftAzureVolumesFinalizerelocation
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Volumes_FinalizeRelocation:
$ref: examples/Volumes_FinalizeRelocation.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/revertRelocation
: post:
tags:
- Volumes Relocation
summary: Microsoft Azure Revert Volume Relocation
description: >-
Reverts the volume relocation process, cleans up the new volume and
starts using the former-existing volume.
operationId: microsoftAzureVolumesRevertrelocation
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
Volumes_RevertRelocation:
$ref: examples/Volumes_RevertRelocation.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots
: get:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsList
summary: Microsoft Azure Describe All Snapshots
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
description: List all snapshots associated with the volume
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshotsList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Snapshots_List:
$ref: examples/Snapshots_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}
: get:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsGet
summary: Microsoft Azure Describe A Snapshot
description: Get details of the specified snapshot
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SnapshotName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshot'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Snapshots_Get:
$ref: examples/Snapshots_Get.json
put:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsCreate
summary: Microsoft Azure Create A Snapshot
description: Create the specified snapshot within the given volume
parameters:
- name: body
description: Snapshot object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/snapshot'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SnapshotName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'201':
description: Snapshot created
schema:
$ref: '#/definitions/snapshot'
'202':
description: >-
Accepted -- Create request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Snapshots_Create:
$ref: examples/Snapshots_Create.json
patch:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsUpdate
summary: Microsoft Azure Update A Snapshot
description: Patch a snapshot
parameters:
- name: body
description: Snapshot object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/snapshotPatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SnapshotName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshot'
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Snapshots_Update:
$ref: examples/Snapshots_Update.json
delete:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsDelete
summary: Microsoft Azure Delete A Snapshot
description: Delete snapshot
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SnapshotName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Snapshots_Delete:
$ref: examples/Snapshots_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/snapshots/{snapshotName}/restoreFiles
: post:
tags:
- Snapshots
operationId: microsoftAzureSnapshotsRestorefiles
summary: Microsoft Azure Create A New Snapshot Restore Files Request
description: >-
Restore the specified files from the specified snapshot to the active
filesystem
parameters:
- name: body
description: Restore payload supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/snapshotRestoreFiles'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SnapshotName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - terminal state
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Snapshots_SingleFileRestore:
$ref: examples/Snapshots_SingleFileRestore.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies
: get:
operationId: microsoftAzureSnapshotpoliciesList
description: List snapshot policy
tags:
- Snapshot Policy
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshotPoliciesList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SnapshotPolicies_List:
$ref: examples/SnapshotPolicies_List.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Netapp Netappaccounts Accountname Snapshotpolicies
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}
: get:
operationId: microsoftAzureSnapshotpoliciesGet
description: Get a snapshot Policy
tags:
- Snapshot Policy
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/SnapshotPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshotPolicy'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SnapshotPolicies_Get:
$ref: examples/SnapshotPolicies_Get.json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Netapp Netappaccounts Accountname Snapshotpolicies Snapshotpolicyname
put:
operationId: microsoftAzureSnapshotpoliciesCreate
description: Create a snapshot policy
tags:
- Snapshot Policy
parameters:
- name: body
description: Snapshot policy object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/snapshotPolicy'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/SnapshotPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - snapshot Policy updated
schema:
$ref: '#/definitions/snapshotPolicy'
'201':
description: Snapshot Policy created
schema:
$ref: '#/definitions/snapshotPolicy'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: false
x-ms-examples:
SnapshotPolicies_Create:
$ref: examples/SnapshotPolicies_Create.json
summary: >-
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Netapp Netappaccounts Accountname Snapshotpolicies Snapshotpolicyname
patch:
tags:
- Snapshot Policy
operationId: microsoftAzureSnapshotpoliciesUpdate
description: Patch a snapshot policy
parameters:
- name: body
description: Snapshot policy object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/snapshotPolicyPatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/SnapshotPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshotPolicy'
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
schema:
$ref: '#/definitions/snapshotPolicy'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
SnapshotPolicies_Update:
$ref: examples/SnapshotPolicies_Update.json
summary: >-
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Netapp Netappaccounts Accountname Snapshotpolicies Snapshotpolicyname
delete:
operationId: microsoftAzureSnapshotpoliciesDelete
description: Delete snapshot policy
tags:
- Snapshot Policy
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/SnapshotPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
SnapshotPolicies_Delete:
$ref: examples/SnapshotPolicies_Delete.json
summary: >-
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Netapp Netappaccounts Accountname Snapshotpolicies Snapshotpolicyname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes
: get:
tags:
- Snapshot Policy List Volumes
summary: Microsoft Azure Get Volumes For Snapshot Policy
description: Get volumes associated with snapshot policy
operationId: microsoftAzureSnapshotpoliciesListvolumes
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/SnapshotPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/snapshotPolicyVolumeList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
SnapshotPolicies_ListVolumes:
$ref: examples/SnapshotPolicies_ListVolumes.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current
: get:
tags:
- Backups
summary: Microsoft Azure Get The Latest Backup Status Of A Volume
description: Get the latest status of the backup for a volume
operationId: microsoftAzureBackupsGetlateststatus
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName:
x-ms-examples:
Volumes_BackupStatus:
$ref: examples/Volumes_LatestBackupStatus.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestRestoreStatus/current
: get:
tags:
- Restore
summary: Microsoft Azure Get The Latest Restore Status Of A Volume
description: Get the latest status of the restore for a volume
operationId: microsoftAzureBackupsGetvolumelatestrestorestatus
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/restoreStatus'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-pageable:
nextLinkName:
x-ms-examples:
Volumes_RestoreStatus:
$ref: examples/Volumes_LatestRestoreStatus.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups
: get:
tags:
- Backups
summary: Microsoft Azure List Backups
description: List all backups Under a Backup Vault
operationId: microsoftAzureBackupsListbyvault
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- in: query
name: $filter
type: string
description: >-
An option to specify the VolumeResourceId. If present, then only
returns the backups under the specified volume
required: false
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupsList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Backups_List:
$ref: examples/BackupsUnderBackupVault_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}
: get:
summary: Microsoft Azure Describe The Backup Under Backup Vault
description: Get the specified Backup under Backup Vault.
tags:
- Backups
operationId: microsoftAzureBackupsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: '#/parameters/BackupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backup'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
BackupsUnderBackupVault_Get:
$ref: examples/BackupsUnderBackupVault_Get.json
put:
tags:
- Backups
summary: Microsoft Azure Create A Backup
description: Create a backup under the Backup Vault
operationId: microsoftAzureBackupsCreate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: '#/parameters/BackupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Backup object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backup'
responses:
'200':
description: OK - backup created updated
schema:
$ref: '#/definitions/backup'
'201':
description: Backup created
schema:
$ref: '#/definitions/backup'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
BackupsUnderBackupVault_Create:
$ref: examples/BackupsUnderBackupVault_Create.json
patch:
tags:
- Backups
summary: Microsoft Azure Patch A Backup
description: Patch a Backup under the Backup Vault
operationId: microsoftAzureBackupsUpdate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: '#/parameters/BackupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Backup object supplied in the body of the operation.
in: body
schema:
$ref: '#/definitions/backupPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backup'
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
schema:
$ref: '#/definitions/backup'
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupsUnderBackupVault_Update:
$ref: examples/BackupsUnderBackupVault_Update.json
delete:
tags:
- Backups
summary: Microsoft Azure Delete Backup
description: Delete a Backup under the Backup Vault
operationId: microsoftAzureBackupsDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: '#/parameters/BackupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
headers:
Location:
type: string
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupsUnderBackupVault_Delete:
$ref: examples/BackupsUnderBackupVault_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies
: get:
tags:
- Backup Policy
summary: Microsoft Azure List Backup Policies
description: List backup policies for Netapp Account
operationId: microsoftAzureBackuppoliciesList
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupPoliciesList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Backups_List:
$ref: examples/BackupPolicies_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupPolicies/{backupPolicyName}
: get:
tags:
- Backup Policy
summary: Microsoft Azure Get A Backup Policy
description: Get a particular backup Policy
operationId: microsoftAzureBackuppoliciesGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupPolicy'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Backups_Get:
$ref: examples/BackupPolicies_Get.json
put:
tags:
- Backup Policy
summary: Microsoft Azure Create A Backup Policy
description: Create a backup policy for Netapp Account
operationId: microsoftAzureBackuppoliciesCreate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Backup policy object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backupPolicy'
responses:
'200':
description: Backup Policy created
schema:
$ref: '#/definitions/backupPolicy'
'201':
description: Backup created
schema:
$ref: '#/definitions/backupPolicy'
'202':
description: >-
Accepted -- Create request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
BackupPolicies_Create:
$ref: examples/BackupPolicies_Create.json
patch:
tags:
- Backup Policy
summary: Microsoft Azure Patch A Backup Policy
description: Patch a backup policy for Netapp Account
operationId: microsoftAzureBackuppoliciesUpdate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Backup policy object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backupPolicyPatch'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupPolicy'
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
schema:
$ref: '#/definitions/backupPolicy'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
BackupPolicies_Update:
$ref: examples/BackupPolicies_Update.json
delete:
tags:
- Backup Policy
summary: Microsoft Azure Delete A Backup Policy
description: Delete backup policy
operationId: microsoftAzureBackuppoliciesDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupPolicyName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Create or update request accepted; operation will
complete asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Backups_Delete:
$ref: examples/BackupPolicies_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules
: get:
tags:
- VolumeQuotaRules
operationId: microsoftAzureVolumequotarulesListbyvolume
summary: Microsoft Azure Get All Quota Rules For A Volume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
description: List all quota rules associated with the volume
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeQuotaRulesList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
VolumeQuotaRules_List:
$ref: examples/VolumeQuotaRules_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/volumeQuotaRules/{volumeQuotaRuleName}
: get:
tags:
- VolumeQuotaRules
operationId: microsoftAzureVolumequotarulesGet
summary: Microsoft Azure Describe A Quota Rule
description: Get details of the specified quota rule
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/VolumeQuotaRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeQuotaRule'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
VolumeQuotaRules_Get:
$ref: examples/VolumeQuotaRules_Get.json
put:
tags:
- VolumeQuotaRules
operationId: microsoftAzureVolumequotarulesCreate
summary: Microsoft Azure Create A Quota Rule
description: Create the specified quota rule within the given volume
parameters:
- name: body
description: Quota rule object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volumeQuotaRule'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/VolumeQuotaRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - VolumeQuotaRule updated
schema:
$ref: '#/definitions/volumeQuotaRule'
'201':
description: Quota rule Created
schema:
$ref: '#/definitions/volumeQuotaRule'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
VolumeQuotaRules_Create:
$ref: examples/VolumeQuotaRules_Create.json
patch:
tags:
- VolumeQuotaRules
operationId: microsoftAzureVolumequotarulesUpdate
summary: Microsoft Azure Update A Quota Rule
description: Patch a quota rule
parameters:
- name: body
description: Quota rule object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volumeQuotaRulePatch'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/VolumeQuotaRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeQuotaRule'
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
VolumeQuotaRules_Update:
$ref: examples/VolumeQuotaRules_Update.json
delete:
tags:
- VolumeQuotaRules
operationId: microsoftAzureVolumequotarulesDelete
summary: Microsoft Azure Delete A Quota Rule
description: Delete quota rule
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/VolumeQuotaRuleName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
VolumeQuotaRules_Delete:
$ref: examples/VolumeQuotaRules_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups
: get:
summary: Microsoft Azure Describe All Volume Groups
description: List all volume groups for given account
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
tags:
- Volume Groups
operationId: microsoftAzureVolumegroupsListbynetappaccount
x-ms-pageable:
nextLinkName:
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeGroupList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
VolumeGroups_List_SapHana:
$ref: examples/VolumeGroups_List_SapHana.json
VolumeGroups_List_Oracle:
$ref: examples/VolumeGroups_List_Oracle.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
: get:
summary: Microsoft Azure Describe A Volume Group
description: Get details of the specified volume group
tags:
- Volume Groups
operationId: microsoftAzureVolumegroupsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/VolumeGroupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/volumeGroupDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
VolumeGroups_Get_SapHana:
$ref: examples/VolumeGroups_Get_SapHana.json
VolumeGroups_Get_Oracle:
$ref: examples/VolumeGroups_Get_Oracle.json
put:
tags:
- Volume Groups
operationId: microsoftAzureVolumegroupsCreate
summary: >-
Microsoft Azure Create The Specified Volume Group And Volumes Creating Volume Group Will Create All The Volumes Specified In Request Body Implicitly Once Volumes Are Created Using Volume Group, Those Will Be Treated As Regular Volumes Thereafter
description: Create a volume group along with specified volumes
parameters:
- name: body
description: Volume Group object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/volumeGroupDetails'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/VolumeGroupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'201':
description: Volume group created
schema:
$ref: '#/definitions/volumeGroupDetails'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
VolumeGroups_Create_SapHana:
$ref: examples/VolumeGroups_Create_SapHana.json
VolumeGroups_Create_Oracle:
$ref: examples/VolumeGroups_Create_Oracle.json
delete:
tags:
- Volume Groups
operationId: microsoftAzureVolumegroupsDelete
summary: Microsoft Azure Delete A Volume Group
description: >-
Delete the specified volume group only if there are no volumes under
volume group.
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/VolumeGroupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-examples:
VolumeGroups_Delete:
$ref: examples/VolumeGroups_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes
: get:
tags:
- Subvolumes
operationId: microsoftAzureSubvolumesListbyvolume
summary: Microsoft Azure List Of All The Subvolumes
description: Returns a list of the subvolumes in the volume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subvolumesList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Subvolumes_List:
$ref: examples/Subvolumes_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}
: get:
tags:
- Subvolumes
summary: Microsoft Azure Get The Path Associated With The Subvolumename
description: Returns the path associated with the subvolumeName provided
operationId: microsoftAzureSubvolumesGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SubvolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subvolumeInfo'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Subvolumes_Get:
$ref: examples/Subvolumes_Get.json
put:
tags:
- Subvolumes
summary: Microsoft Azure Create Or Clone A New Subvolume
description: >-
Creates a subvolume in the path or clones the subvolume mentioned in the
parentPath
operationId: microsoftAzureSubvolumesCreate
parameters:
- name: body
description: Subvolume object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/subvolumeInfo'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SubvolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK - updated
schema:
$ref: '#/definitions/subvolumeInfo'
'201':
description: Subvolume created
schema:
$ref: '#/definitions/subvolumeInfo'
'202':
description: >-
Accepted -- Create request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Subvolumes_Create:
$ref: examples/Subvolumes_Create.json
patch:
tags:
- Subvolumes
operationId: microsoftAzureSubvolumesUpdate
summary: Microsoft Azure Update A Subvolume
description: Patch a subvolume
parameters:
- name: body
description: Subvolume object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/subvolumePatchRequest'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SubvolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
schema:
$ref: '#/definitions/subvolumeInfo'
description: OK
'202':
description: >-
Accepted -- Update request accepted; operation will complete
asynchronously
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Subvolumes_Update:
$ref: examples/Subvolumes_Update.json
delete:
tags:
- Subvolumes
operationId: microsoftAzureSubvolumesDelete
summary: Microsoft Azure Delete A Subvolume
description: Delete subvolume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SubvolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Subvolumes_Delete:
$ref: examples/Subvolumes_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata
: post:
tags:
- Subvolumes
operationId: microsoftAzureSubvolumesGetmetadata
summary: Microsoft Azure Describe A Subvolume
description: Get details of the specified subvolume
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: '#/parameters/SubvolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/subvolumeModel'
'202':
description: Accepted
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
Subvolumes_Metadata:
$ref: examples/Subvolumes_Metadata.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults
: get:
summary: Microsoft Azure Describe All Backup Vaults
description: List and describe all Backup Vaults in the NetApp account.
tags:
- Backup Vaults
operationId: microsoftAzureBackupvaultsListbynetappaccount
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
x-ms-pageable:
nextLinkName: nextLink
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupVaultsList'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
BackupVaults_List:
$ref: examples/BackupVaults_List.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}
: get:
summary: Microsoft Azure Describe The Backup Vault
description: Get the Backup Vault
tags:
- Backup Vaults
operationId: microsoftAzureBackupvaultsGet
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/backupVault'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
BackupVaults_Get:
$ref: examples/BackupVaults_Get.json
put:
tags:
- Backup Vaults
summary: Microsoft Azure Create Or Update A Backup Vault
description: Create or update the specified Backup Vault in the NetApp account
operationId: microsoftAzureBackupvaultsCreateorupdate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: BackupVault object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backupVault'
responses:
'200':
description: OK - backupVault updated
schema:
$ref: '#/definitions/backupVault'
'201':
description: backupVault created
schema:
$ref: '#/definitions/backupVault'
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: azure-async-operation
x-ms-examples:
BackupVault_CreateOrUpdate:
$ref: examples/BackupVaults_Create.json
patch:
summary: Microsoft Azure Update Netapp Backup Vault
description: Patch the specified NetApp Backup Vault
tags:
- Backup Vaults
operationId: microsoftAzureBackupvaultsUpdate
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- name: body
description: Backup Vault object supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backupVaultPatch'
responses:
'200':
description: OK - Backup Vault updated.
schema:
$ref: '#/definitions/backupVault'
'202':
description: Accepted
schema:
$ref: '#/definitions/backupVault'
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupVaults_Update:
$ref: examples/BackupVaults_Update.json
delete:
summary: Microsoft Azure Delete Netapp Backup Vault
description: Delete the specified Backup Vault
tags:
- Backup Vaults
operationId: microsoftAzureBackupvaultsDelete
parameters:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: >-
Accepted -- Delete request accepted; operation will complete
asynchronously
headers:
Location:
type: string
'204':
description: NoContent -- Resource does not exist.
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupVaults_Delete:
$ref: examples/BackupVaults_Delete.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/backupVaults/{backupVaultName}/backups/{backupName}/restoreFiles
: post:
tags:
- Backups
operationId: microsoftAzureBackupsunderbackupvaultRestorefiles
summary: Microsoft Azure Create A New Backup Restore Files Request
description: >-
Restore the specified files from the specified backup to the active
filesystem
parameters:
- name: body
description: Restore payload supplied in the body of the operation.
in: body
required: true
schema:
$ref: '#/definitions/backupRestoreFiles'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/BackupVaultName'
- $ref: '#/parameters/BackupName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
Backups_SingleFileRestore:
$ref: examples/BackupsUnderBackupVault_SingleFileRestore.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/migrateBackups
: post:
tags:
- Backups
operationId: microsoftAzureBackupsundervolumeMigratebackups
summary: Microsoft Azure Create A New Migrate Request For Backups Under Volume
description: Migrate the backups under volume to backup vault
parameters:
- name: body
description: >-
Migrate backups under volume payload supplied in the body of the
operation.
in: body
required: true
schema:
$ref: '#/definitions/backupsMigrationRequest'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: '#/parameters/PoolName'
- $ref: '#/parameters/VolumeName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupsUnderVolume_Migrate:
$ref: examples/BackupsUnderVolume_Migrate.json
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/migrateBackups
: post:
tags:
- Backups
operationId: microsoftAzureBackupsunderaccountMigratebackups
summary: Microsoft Azure Create A New Migrate Request For Backups Under Account
description: Migrate the backups under a NetApp account to backup vault
parameters:
- name: body
description: >-
Migrate backups under an account payload supplied in the body of the
operation.
in: body
required: true
schema:
$ref: '#/definitions/backupsMigrationRequest'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- $ref: '#/parameters/AccountName'
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
responses:
'202':
description: Accepted
headers:
Location:
type: string
default:
description: Error response describing why the operation failed.
schema:
$ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
x-ms-examples:
BackupsUnderAccount_Migrate:
$ref: examples/BackupsUnderAccount_Migrate.json
definitions:
OperationListResult:
description: >-
Result of the request to list Cloud Volume operations. It contains a list
of operations and a URL link to get the next set of results.
properties:
value:
type: array
items:
$ref: '#/definitions/Operation'
x-ms-identifiers:
- name
description: List of Storage operations supported by the Storage resource provider.
Operation:
description: Microsoft.NetApp REST API operation definition.
type: object
properties:
name:
description: 'Operation name: {provider}/{resource}/{operation}'
type: string
display:
description: Display metadata associated with the operation.
properties:
provider:
description: 'Service provider: Microsoft NetApp.'
type: string
resource:
description: Resource on which the operation is performed etc.
type: string
operation:
description: 'Type of operation: get, read, delete, etc.'
type: string
description:
description: Operation description.
type: string
origin:
type: string
description: The origin of operations.
properties:
$ref: '#/definitions/OperationProperties'
description: Properties of operation, include metric specifications.
x-ms-client-flatten: true
OperationProperties:
description: Properties of operation, include metric specifications.
properties:
serviceSpecification:
$ref: '#/definitions/ServiceSpecification'
description: One property of operation, include metric specifications.
ServiceSpecification:
description: One property of operation, include metric specifications.
properties:
metricSpecifications:
description: Metric specifications of operation.
type: array
items:
$ref: '#/definitions/MetricSpecification'
x-ms-identifiers:
- name
logSpecifications:
description: Log specification of operation.
type: array
items:
$ref: '#/definitions/LogSpecification'
x-ms-identifiers:
- name
MetricSpecification:
description: Metric specification of operation.
properties:
name:
type: string
description: Name of metric specification.
displayName:
type: string
description: Display name of metric specification.
displayDescription:
type: string
description: Display description of metric specification.
unit:
type: string
description: Unit could be Bytes or Count.
supportedAggregationTypes:
description: Support metric aggregation type.
uniqueItems: false
type: array
items:
enum:
- Average
type: string
x-ms-enum:
name: MetricAggregationType
modelAsString: true
supportedTimeGrainTypes:
type: array
description: The supported time grain types for the metrics.
items:
type: string
internalMetricName:
type: string
description: The internal metric name.
enableRegionalMdmAccount:
description: Whether or not the service is using regional MDM accounts.
type: boolean
sourceMdmAccount:
type: string
description: The source MDM account.
sourceMdmNamespace:
type: string
description: The source MDM namespace.
dimensions:
description: Dimensions of blobs, including blob type and access tier.
type: array
items:
$ref: '#/definitions/Dimension'
x-ms-identifiers:
- name
aggregationType:
type: string
description: Aggregation type could be Average.
fillGapWithZero:
type: boolean
description: The property to decide fill gap with zero or not.
category:
type: string
description: The category this metric specification belong to, could be Capacity.
resourceIdDimensionNameOverride:
type: string
description: Account Resource Id.
isInternal:
description: Whether the metric is internal.
type: boolean
LogSpecification:
description: Log Definition of a single resource metric.
type: object
properties:
name:
description: Name of log specification.
type: string
displayName:
description: Display name of log specification.
type: string
Dimension:
description: Dimension of blobs, possibly be blob type or access tier.
properties:
name:
type: string
description: Display name of dimension.
displayName:
type: string
description: Display name of dimension.
CheckAvailabilityResponse:
description: Information regarding availability of a resource.
type: object
properties:
isAvailable:
description: >-
true indicates name is valid and available.
false indicates the name is invalid, unavailable, or
both.
type: boolean
reason:
description: >-
Invalid indicates the name provided does not match Azure
App Service naming requirements. AlreadyExists indicates
that the name is already in use and is therefore unavailable.
enum:
- Invalid
- AlreadyExists
type: string
x-ms-enum:
name: InAvailabilityReasonType
modelAsString: true
message:
description: >-
If reason == invalid, provide the user with the reason why the given
name is invalid, and provide the resource naming requirements so that
the user can select a valid name. If reason == AlreadyExists, explain
that resource name is already in use, and direct them to select a
different name.
type: string
regionInfosList:
description: List of regionInfo resources
type: object
properties:
value:
description: A list of regionInfo resources
type: array
items:
$ref: '#/definitions/regionInfoResource'
nextLink:
type: string
description: URL to get the next set of results.
regionInfoResource:
description: Information regarding regionInfo Item.
type: object
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
description: regionInfo properties
$ref: '#/definitions/regionInfo'
x-ms-client-flatten: true
regionInfo:
description: Provides region specific information.
type: object
properties:
storageToNetworkProximity:
title: Storage to Network Proximity
description: Provides storage to network proximity information in the region.
type: string
enum:
- Default
- T1
- T2
- AcrossT2
- T1AndT2
- T1AndAcrossT2
- T2AndAcrossT2
- T1AndT2AndAcrossT2
x-ms-enum:
name: RegionStorageToNetworkProximity
modelAsString: true
values:
- value: Default
description: Basic network connectivity.
- value: T1
description: Standard T1 network connectivity.
- value: T2
description: Standard T2 network connectivity.
- value: AcrossT2
description: Standard AcrossT2 network connectivity.
- value: T1AndT2
description: Standard T1 and T2 network connectivity.
- value: T1AndAcrossT2
description: Standard T1 and AcrossT2 network connectivity.
- value: T2AndAcrossT2
description: Standard T2 and AcrossT2 network connectivity.
- value: T1AndT2AndAcrossT2
description: Standard T1, T2 and AcrossT2 network connectivity.
example: T2
availabilityZoneMappings:
title: Logical availability zone mappings.
description: >-
Provides logical availability zone mappings for the subscription for a
region.
type: array
x-ms-identifiers:
- availabilityZone
items:
type: object
properties:
availabilityZone:
description: Logical availability zone.
type: string
example: '1'
isAvailable:
description: Available availability zone
type: boolean
example: true
ResourceNameAvailabilityRequest:
description: Resource name availability request content.
required:
- name
- type
- resourceGroup
type: object
properties:
name:
description: Resource name to verify.
type: string
type:
description: Resource type used for verification.
enum:
- Microsoft.NetApp/netAppAccounts
- Microsoft.NetApp/netAppAccounts/capacityPools
- Microsoft.NetApp/netAppAccounts/capacityPools/volumes
- Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots
type: string
x-ms-enum:
name: CheckNameResourceTypes
modelAsString: true
resourceGroup:
description: Resource group name.
type: string
FilePathAvailabilityRequest:
description: >-
File path availability request content - availability is based on the name
and the subnetId.
required:
- name
- subnetId
type: object
properties:
name:
description: File path to verify.
type: string
subnetId:
type: string
description: >-
The Azure Resource URI for a delegated subnet. Must have the
delegation Microsoft.NetApp/volumes
availabilityZone:
title: Logical availability zone
type: string
example: '1'
x-nullable: true
description: >-
The Azure Resource logical availability zone which is used within zone
mapping lookup for the subscription and region. The lookup will
retrieve the physical zone where volume is placed.
QuotaAvailabilityRequest:
description: Quota availability request content.
required:
- name
- type
- resourceGroup
type: object
properties:
name:
description: Name of the resource to verify.
type: string
type:
description: Resource type used for verification.
enum:
- Microsoft.NetApp/netAppAccounts
- Microsoft.NetApp/netAppAccounts/capacityPools
- Microsoft.NetApp/netAppAccounts/capacityPools/volumes
- Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots
type: string
x-ms-enum:
name: CheckQuotaNameResourceTypes
modelAsString: true
resourceGroup:
description: Resource group name.
type: string
SubscriptionQuotaItemList:
description: List of Subscription Quota Items
type: object
properties:
value:
description: A list of SubscriptionQuotaItems
type: array
items:
$ref: '#/definitions/SubscriptionQuotaItem'
SubscriptionQuotaItem:
description: Information regarding Subscription Quota Item.
type: object
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
description: SubscriptionQuotaItem properties
$ref: '#/definitions/SubscriptionQuotaItemProperties'
x-ms-client-flatten: true
SubscriptionQuotaItemProperties:
description: SubscriptionQuotaItem Properties
type: object
properties:
current:
description: The current quota value.
readOnly: true
type: integer
format: int32
default:
description: The default quota value.
readOnly: true
type: integer
format: int32
netAppAccountList:
description: List of NetApp account resources
type: object
properties:
value:
type: array
description: Multiple NetApp accounts
items:
$ref: '#/definitions/netAppAccount'
nextLink:
type: string
description: URL to get the next set of results.
netAppAccount:
description: NetApp account resource
type: object
required:
- location
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
etag:
readOnly: true
type: string
description: >-
A unique read-only string that changes whenever the resource is
updated.
properties:
description: NetApp Account properties
$ref: '#/definitions/accountProperties'
x-ms-client-flatten: true
identity:
description: The identity used for the resource.
$ref: >-
../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity
netAppAccountPatch:
description: NetApp account patch resource
type: object
x-ms-azure-resource: true
properties:
location:
type: string
description: Resource location
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: NetApp Account properties
$ref: '#/definitions/accountProperties'
x-ms-client-flatten: true
identity:
description: The identity used for the resource.
$ref: >-
../../../../../common-types/resource-management/v5/managedidentity.json#/definitions/ManagedServiceIdentity
accountProperties:
description: NetApp account properties
type: object
properties:
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
activeDirectories:
description: Active Directories
type: array
items:
$ref: '#/definitions/activeDirectory'
x-ms-identifiers:
- activeDirectoryId
encryption:
description: Encryption settings
$ref: '#/definitions/accountEncryption'
disableShowmount:
type: boolean
readOnly: true
x-nullable: true
description: >-
Shows the status of disableShowmount for all volumes under the
subscription, null equals false
nfsV4IDDomain:
type: string
description: >-
Domain for NFSv4 user ID mapping. This property will be set for all
NetApp accounts in the subscription and region and only affect non
ldap NFSv4 volumes.
maxLength: 255
pattern: ^[a-zA-Z0-9][a-zA-Z0-9.-]{0,253}[a-zA-Z0-9]$
x-nullable: true
example: defaultv4IDDomain.com
isMultiAdEnabled:
type: boolean
readOnly: true
x-nullable: true
description: This will have true value only if account is Multiple AD enabled.
activeDirectory:
description: Active Directory
type: object
properties:
activeDirectoryId:
type: string
x-nullable: true
description: Id of the Active Directory
username:
type: string
description: A domain user account with permission to create machine accounts
password:
type: string
x-ms-secret: true
maxLength: 64
description: >-
Plain text password of Active Directory domain administrator, value is
masked in the response
domain:
type: string
description: Name of the Active Directory domain
dns:
type: string
description: >-
Comma separated list of DNS server IP addresses (IPv4 only) for the
Active Directory domain
pattern: >-
^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((,
?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
example: 101.102.103.104,101.102.103.105
status:
type: string
description: Status of the Active Directory
readOnly: true
enum:
- Created
- Updating
- InUse
- Deleted
- Error
x-ms-enum:
name: ActiveDirectoryStatus
modelAsString: true
values:
- value: Created
description: Active Directory created but not in use
- value: InUse
description: Active Directory in use by SMB Volume
- value: Deleted
description: Active Directory Deleted
- value: Error
description: Error with the Active Directory
- value: Updating
description: Active Directory Updating
statusDetails:
type: string
description: Any details in regards to the Status of the Active Directory
readOnly: true
smbServerName:
type: string
description: >-
NetBIOS name of the SMB server. This name will be registered as a
computer account in the AD and used to mount volumes
organizationalUnit:
type: string
default: CN=Computers
description: The Organizational Unit (OU) within the Windows Active Directory
site:
type: string
description: >-
The Active Directory site the service will limit Domain Controller
discovery to
backupOperators:
description: >-
Users to be added to the Built-in Backup Operator active directory
group. A list of unique usernames without domain specifier
type: array
items:
type: string
maxLength: 255
minLength: 1
example:
- user1
- user2
administrators:
description: >-
Users to be added to the Built-in Administrators active directory
group. A list of unique usernames without domain specifier
type: array
items:
type: string
maxLength: 255
minLength: 1
example:
- user1
- user2
kdcIP:
type: string
pattern: >-
^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((,
?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$
description: >-
kdc server IP addresses for the active directory machine. This
optional parameter is used only while creating kerberos volume.
example: 101.102.103.104
adName:
type: string
maxLength: 64
minLength: 1
description: >-
Name of the active directory machine. This optional parameter is used
only while creating kerberos volume
example: ADServerName
serverRootCACertificate:
type: string
maxLength: 10240
minLength: 1
description: >-
When LDAP over SSL/TLS is enabled, the LDAP client is required to have
base64 encoded Active Directory Certificate Service's self-signed root
CA certificate, this optional parameter is used only for dual protocol
with LDAP user-mapping volumes.
x-ms-secret: true
example: >-
LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
aesEncryption:
type: boolean
description: If enabled, AES encryption will be enabled for SMB communication.
ldapSigning:
type: boolean
description: Specifies whether or not the LDAP traffic needs to be signed.
securityOperators:
type: array
description: >-
Domain Users in the Active directory to be given SeSecurityPrivilege
privilege (Needed for SMB Continuously available shares for SQL). A
list of unique usernames without domain specifier
items:
type: string
maxLength: 255
minLength: 1
example:
- user1
- user2
ldapOverTLS:
type: boolean
description: Specifies whether or not the LDAP traffic needs to be secured via TLS.
allowLocalNfsUsersWithLdap:
type: boolean
description: ' If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.'
encryptDCConnections:
type: boolean
description: >-
If enabled, Traffic between the SMB server to Domain Controller (DC)
will be encrypted.
ldapSearchScope:
description: LDAP Search scope options
$ref: '#/definitions/ldapSearchScopeOpt'
preferredServersForLdapClient:
type: string
maxLength: 32
pattern: >-
^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((,
?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))?)?$
description: >-
Comma separated list of IPv4 addresses of preferred servers for LDAP
client. At most two comma separated IPv4 addresses can be passed.
example: 101.102.103.104, 101.102.103.105
ldapSearchScopeOpt:
type: object
description: 'LDAP search scope '
properties:
userDN:
type: string
description: >-
This specifies the user DN, which overrides the base DN for user
lookups.
maxLength: 255
example: OU=fin,OU=hr,dc=domain,dc=com
groupDN:
type: string
description: >-
This specifies the group DN, which overrides the base DN for group
lookups.
maxLength: 255
example: OU=fin,OU=hr,dc=domain,dc=com
groupMembershipFilter:
type: string
description: >-
This specifies the custom LDAP search filter to be used when looking
up group membership from LDAP server.
maxLength: 255
example: cn=*99
accountEncryption:
type: object
description: Encryption settings
properties:
keySource:
type: string
description: >-
The encryption keySource (provider). Possible values
(case-insensitive): Microsoft.NetApp, Microsoft.KeyVault
enum:
- Microsoft.NetApp
- Microsoft.KeyVault
x-ms-enum:
name: KeySource
modelAsString: true
values:
- value: Microsoft.NetApp
description: Microsoft-managed key encryption
- value: Microsoft.KeyVault
description: Customer-managed key encryption
default: Microsoft.NetApp
keyVaultProperties:
$ref: '#/definitions/KeyVaultProperties'
description: >-
Properties provided by KeVault. Applicable if keySource is
'Microsoft.KeyVault'.
identity:
$ref: '#/definitions/EncryptionIdentity'
description: >-
Identity used to authenticate to KeyVault. Applicable if keySource is
'Microsoft.KeyVault'.
KeyVaultProperties:
description: Properties of key vault.
type: object
required:
- keyVaultUri
- keyName
- keyVaultResourceId
properties:
keyVaultId:
type: string
description: UUID v4 used to identify the Azure Key Vault configuration
readOnly: true
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca7778
keyVaultUri:
type: string
description: The Uri of KeyVault.
keyName:
type: string
description: The name of KeyVault key.
keyVaultResourceId:
type: string
description: The resource ID of KeyVault.
status:
type: string
description: Status of the KeyVault connection.
readOnly: true
enum:
- Created
- Updating
- InUse
- Deleted
- Error
x-ms-enum:
name: KeyVaultStatus
modelAsString: true
values:
- value: Created
description: KeyVault connection created but not in use
- value: InUse
description: KeyVault connection in use by SMB Volume
- value: Deleted
description: KeyVault connection Deleted
- value: Error
description: Error with the KeyVault connection
- value: Updating
description: KeyVault connection Updating
EncryptionIdentity:
description: Identity used to authenticate with key vault.
type: object
properties:
principalId:
type: string
description: >-
The principal ID (object ID) of the identity used to authenticate with
key vault. Read-only.
readOnly: true
userAssignedIdentity:
type: string
description: >-
The ARM resource identifier of the user assigned identity used to
authenticate with key vault. Applicable if identity.type has
'UserAssigned'. It should match key of
identity.userAssignedIdentities.
capacityPoolList:
description: List of capacity pool resources
type: object
properties:
value:
description: List of Capacity pools
type: array
items:
$ref: '#/definitions/capacityPool'
nextLink:
type: string
description: URL to get the next set of results.
capacityPool:
description: Capacity pool resource
type: object
required:
- location
- properties
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
etag:
readOnly: true
type: string
description: >-
A unique read-only string that changes whenever the resource is
updated.
properties:
description: Capacity pool properties
$ref: '#/definitions/poolProperties'
x-ms-client-flatten: true
poolProperties:
description: Pool properties
type: object
required:
- size
- serviceLevel
properties:
poolId:
title: poolId
type: string
readOnly: true
description: UUID v4 used to identify the Pool
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca7778
size:
title: size
type: integer
format: int64
description: >-
Provisioned size of the pool (in bytes). Allowed values are in 1TiB
chunks (value must be multiply of 4398046511104).
default: 4398046511104
serviceLevel:
title: serviceLevel
$ref: '#/definitions/serviceLevel'
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
totalThroughputMibps:
type: number
description: Total throughput of pool in MiB/s
example: 164.221
readOnly: true
utilizedThroughputMibps:
type: number
description: Utilized throughput of pool in MiB/s
example: 164.221
readOnly: true
qosType:
title: qosType
type: string
description: The qos type of the pool
enum:
- Auto
- Manual
x-ms-enum:
name: qosType
modelAsString: true
values:
- value: Auto
description: qos type Auto
- value: Manual
description: qos type Manual
example: Manual
default: Auto
coolAccess:
type: boolean
default: false
example: false
description: If enabled (true) the pool can contain cool Access enabled volumes.
encryptionType:
title: encryptionType
type: string
x-nullable: true
description: >-
Encryption type of the capacity pool, set encryption type for data at
rest for this pool and all volumes in it. This value can only be set
when creating new pool.
x-ms-mutability:
- read
- create
enum:
- Single
- Double
x-ms-enum:
name: encryptionType
modelAsString: true
values:
- value: Single
description: >-
EncryptionType Single, volumes will use single encryption at
rest
- value: Double
description: >-
EncryptionType Double, volumes will use double encryption at
rest
example: Single
default: Single
capacityPoolPatch:
description: Capacity pool patch resource
type: object
x-ms-azure-resource: true
properties:
location:
type: string
description: Resource location
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Capacity pool properties
$ref: '#/definitions/poolPatchProperties'
x-ms-client-flatten: true
poolPatchProperties:
description: Patchable pool properties
type: object
properties:
size:
title: size
type: integer
format: int64
description: >-
Provisioned size of the pool (in bytes). Allowed values are in 1TiB
chunks (value must be multiply of 4398046511104).
default: 4398046511104
qosType:
title: qosType
type: string
description: The qos type of the pool
enum:
- Auto
- Manual
x-ms-enum:
name: qosType
modelAsString: true
values:
- value: Auto
description: qos type Auto
- value: Manual
description: qos type Manual
example: Manual
default: Auto
coolAccess:
type: boolean
example: false
description: If enabled (true) the pool can contain cool Access enabled volumes.
volumeList:
description: List of volume resources
type: object
properties:
value:
description: List of volumes
type: array
items:
$ref: '#/definitions/volume'
nextLink:
type: string
description: URL to get the next set of results.
volume:
description: Volume resource
type: object
required:
- location
- properties
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
etag:
readOnly: true
type: string
description: >-
A unique read-only string that changes whenever the resource is
updated.
zones:
type: array
description: Availability Zone
x-ms-mutability:
- read
- create
items:
type: string
maxLength: 255
minLength: 1
example: '1'
properties:
description: Volume properties
$ref: '#/definitions/volumeProperties'
x-ms-client-flatten: true
resourceIdentity:
type: object
description: Identity for the resource.
properties:
principalId:
description: Object id of the identity resource
type: string
readOnly: true
tenantId:
description: The tenant id of the resource
type: string
readOnly: true
type:
description: 'Type of Identity. Supported values are: ''None'', ''SystemAssigned'''
type: string
resourceTags:
type: object
additionalProperties:
type: string
description: Tags are a list of key-value pairs that describe the resource
volumeProperties:
description: Volume properties
type: object
required:
- creationToken
- usageThreshold
- subnetId
properties:
fileSystemId:
title: FileSystem ID
type: string
readOnly: true
description: Unique FileSystem Identifier.
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca7778
creationToken:
title: Creation Token or File Path
type: string
description: A unique file path for the volume. Used when creating mount targets
pattern: ^[a-zA-Z][a-zA-Z0-9\-]{0,79}$
minLength: 1
maxLength: 80
example: some-amazing-filepath
serviceLevel:
title: serviceLevel
$ref: '#/definitions/serviceLevel'
usageThreshold:
title: usageThreshold
type: integer
format: int64
description: >-
Maximum storage quota allowed for a file system in bytes. This is a
soft quota used for alerting only. Minimum size is 100 GiB. Upper
limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on
exceptional basis. Specified in bytes.
minimum: 107374182400
maximum: 2638827906662400
default: 107374182400
example: 107374182400
exportPolicy:
title: exportPolicy
description: Set of export policy rules
properties:
rules:
title: Export policy rule
description: Export policy rule
type: array
items:
$ref: '#/definitions/exportPolicyRule'
x-ms-identifiers:
- ruleIndex
protocolTypes:
title: protocolTypes
description: Set of protocol types, default NFSv3, CIFS for SMB protocol
type: array
items:
type: string
example:
- NFSv4.1
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
snapshotId:
title: Snapshot ID
type: string
x-nullable: true
x-ms-mutability:
- read
- create
description: UUID v4 or resource identifier used to identify the Snapshot.
example: 9760acf5-4638-11e7-9bdb-020073ca3333
deleteBaseSnapshot:
type: boolean
description: >-
If enabled (true) the snapshot the volume was created from will be
automatically deleted after the volume create operation has finished. Defaults to false
backupId:
title: Backup ID
type: string
x-nullable: true
x-ms-mutability:
- read
- create
description: UUID v4 or resource identifier used to identify the Backup.
example: 9760acf5-4638-11e7-9bdb-020073ca3333
baremetalTenantId:
title: Baremetal Tenant ID
type: string
readOnly: true
description: Unique Baremetal Tenant Identifier.
example: 9560acf5-4e3a-12e7-9bdb-02007cca7779
subnetId:
type: string
description: >-
The Azure Resource URI for a delegated subnet. Must have the
delegation Microsoft.NetApp/volumes
networkFeatures:
$ref: '#/definitions/networkFeatures'
networkSiblingSetId:
title: Network Sibling Set ID
description: >-
Network Sibling Set ID for the the group of volumes sharing networking
resources.
type: string
readOnly: true
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
storageToNetworkProximity:
title: Storage to Network Proximity
description: Provides storage to network proximity information for the volume.
type: string
enum:
- Default
- T1
- T2
- AcrossT2
readOnly: true
x-ms-enum:
name: VolumeStorageToNetworkProximity
modelAsString: true
values:
- value: Default
description: Basic storage to network connectivity.
- value: T1
description: Standard T1 storage to network connectivity.
- value: T2
description: Standard T2 storage to network connectivity.
- value: AcrossT2
description: Standard AcrossT2 storage to network connectivity.
example: T1
mountTargets:
title: mountTargets
type: array
readOnly: true
description: List of mount targets
items:
$ref: '#/definitions/mountTargetProperties'
x-ms-identifiers:
- fileSystemId
volumeType:
type: string
description: >-
What type of volume is this. For destination volumes in Cross Region
Replication, set type to DataProtection. For creating clone volume,
set type to ShortTermClone
example: DataProtection
dataProtection:
title: DataProtection
description: >-
DataProtection type volumes include an object containing details of
the replication
properties:
backup:
title: Backup
description: Backup Properties
type: object
$ref: '#/definitions/volumeBackupProperties'
replication:
title: Replication
description: Replication properties
type: object
$ref: '#/definitions/replicationObject'
snapshot:
title: Snapshot
description: Snapshot properties.
$ref: '#/definitions/volumeSnapshotProperties'
volumeRelocation:
title: VolumeRelocation
description: VolumeRelocation properties
type: object
$ref: '#/definitions/volumeRelocationProperties'
isRestoring:
type: boolean
description: Restoring
snapshotDirectoryVisible:
type: boolean
default: true
description: >-
If enabled (true) the volume will contain a read-only snapshot
directory which provides access to each of the volume's snapshots
(defaults to true).
kerberosEnabled:
type: boolean
description: >-
Describe if a volume is KerberosEnabled. To be use with swagger
version 2020-05-01 or later
x-ms-mutability:
- read
- create
example: false
default: false
securityStyle:
type: string
description: >-
The security style of volume, default unix, defaults to ntfs for dual
protocol or CIFS protocol
default: unix
enum:
- ntfs
- unix
x-ms-enum:
name: SecurityStyle
modelAsString: true
smbEncryption:
type: boolean
description: >-
Enables encryption for in-flight smb3 data. Only applicable for
SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or
later
example: false
default: false
smbAccessBasedEnumeration:
$ref: '#/definitions/smbAccessBasedEnumeration'
smbNonBrowsable:
$ref: '#/definitions/smbNonBrowsable'
smbContinuouslyAvailable:
type: boolean
description: >-
Enables continuously available share property for smb volume. Only
applicable for SMB volume
example: false
default: false
throughputMibps:
title: >-
Maximum throughput in MiB/s that can be achieved by this volume and
this will be accepted as input only for manual qosType volume
type: number
x-nullable: true
example: 128.223
actualThroughputMibps:
type: number
description: >-
Actual throughput in MiB/s for auto qosType volumes calculated based
on size and serviceLevel
example: 164.221
readOnly: true
encryptionKeySource:
description: >-
Source of key used to encrypt data in volume. Applicable if NetApp
account has encryption.keySource = 'Microsoft.KeyVault'. Possible
values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
type: string
enum:
- Microsoft.NetApp
- Microsoft.KeyVault
x-ms-enum:
name: EncryptionKeySource
modelAsString: true
values:
- value: Microsoft.NetApp
description: Microsoft-managed key encryption
- value: Microsoft.KeyVault
description: Customer-managed key encryption
default: Microsoft.NetApp
keyVaultPrivateEndpointResourceId:
type: string
description: >-
The resource ID of private endpoint for KeyVault. It must reside in
the same VNET as the volume. Only applicable if encryptionKeySource =
'Microsoft.KeyVault'.
ldapEnabled:
type: boolean
description: Specifies whether LDAP is enabled or not for a given NFS volume.
example: false
default: false
coolAccess:
type: boolean
description: Specifies whether Cool Access(tiering) is enabled for the volume.
example: false
default: false
coolnessPeriod:
type: integer
description: >-
Specifies the number of days after which data that is not accessed by
clients will be tiered.
example: 7
minimum: 7
maximum: 183
format: int32
coolAccessRetrievalPolicy:
$ref: '#/definitions/coolAccessRetrievalPolicy'
unixPermissions:
type: string
description: >-
UNIX permissions for NFS volume accepted in octal 4 digit format.
First digit selects the set user ID(4), set group ID (2) and sticky
(1) attributes. Second digit selects permission for the owner of the
file: read (4), write (2) and execute (1). Third selects permissions
for other users in the same group. the fourth for other users not in
the group. 0755 - gives read/write/execute permissions to owner and
read/execute to group and other users.
minLength: 4
maxLength: 4
x-nullable: true
example: '0770'
cloneProgress:
description: >-
When a volume is being restored from another volume's snapshot, will
show the percentage completion of this cloning process. When this
value is empty/null there is no cloning process currently happening on
this volume. This value will update every 5 minutes during cloning.
type: integer
format: int32
example: 10
x-nullable: true
readOnly: true
fileAccessLogs:
type: string
description: >-
Flag indicating whether file access logs are enabled for the volume,
based on active diagnostic settings present on the volume.
readOnly: true
enum:
- Enabled
- Disabled
x-ms-enum:
name: fileAccessLogs
modelAsString: true
values:
- value: Enabled
description: fileAccessLogs are enabled
- value: Disabled
description: fileAccessLogs are not enabled
example: Disabled
default: Disabled
avsDataStore:
title: avsDataStore
type: string
description: >-
Specifies whether the volume is enabled for Azure VMware Solution
(AVS) datastore purpose
enum:
- Enabled
- Disabled
x-ms-enum:
name: avsDataStore
modelAsString: true
values:
- value: Enabled
description: avsDataStore is enabled
- value: Disabled
description: avsDataStore is disabled
example: Enabled
default: Disabled
dataStoreResourceId:
title: dataStoreResourceId
description: Data store resource unique identifier
type: array
items:
type: string
readOnly: true
isDefaultQuotaEnabled:
type: boolean
description: Specifies if default quota is enabled for the volume.
example: false
default: false
defaultUserQuotaInKiBs:
type: integer
format: int64
description: >-
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is
set, the minimum value of 4 KiBs applies .
example: 4
default: 0
defaultGroupQuotaInKiBs:
type: integer
format: int64
description: >-
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is
set, the minimum value of 4 KiBs applies.
example: 4
default: 0
maximumNumberOfFiles:
type: integer
format: int64
readOnly: true
description: >-
Maximum number of files allowed. Needs a service request in order to
be changed. Only allowed to be changed if volume quota is more than
4TiB.
example: 100000000
volumeGroupName:
type: string
description: Volume Group Name
readOnly: true
capacityPoolResourceId:
type: string
description: >-
Pool Resource Id used in case of creating a volume through volume
group
proximityPlacementGroup:
type: string
description: Proximity placement group associated with the volume
example: >-
/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.Compute/proximityPlacementGroups/testppg
t2Network:
type: string
description: T2 network information
example: Test-T2-Alias
readOnly: true
volumeSpecName:
type: string
description: >-
Volume spec name is the application specific designation or identifier
for the particular volume in a volume group for e.g. data, log
example: Data
encrypted:
type: boolean
description: >-
Specifies if the volume is encrypted or not. Only available on volumes
created or updated after 2022-01-01.
readOnly: true
placementRules:
title: Volume placement rules
description: Application specific placement rules for the particular volume
type: array
items:
$ref: '#/definitions/placementKeyValuePairs'
x-ms-identifiers:
- key
enableSubvolumes:
type: string
description: Flag indicating whether subvolume operations are enabled on the volume
example: Enabled
default: Disabled
enum:
- Enabled
- Disabled
x-ms-enum:
name: enableSubvolumes
modelAsString: true
values:
- value: Enabled
description: subvolumes are enabled
- value: Disabled
description: subvolumes are not enabled
provisionedAvailabilityZone:
title: Provisioned Availability Zone
type: string
readOnly: true
description: >-
The availability zone where the volume is provisioned. This refers to
the logical availability zone where the volume resides.
example: '2'
x-nullable: true
isLargeVolume:
title: Is Large Volume
type: boolean
description: Specifies whether volume is a Large Volume or Regular Volume.
example: false
default: false
originatingResourceId:
title: Originating Resource Id
type: string
description: Id of the snapshot or backup that the volume is restored from.
example: >-
/subscriptions/aaaaaaaa-1234-1234-1224-234567891011/resourceGroups/testGroup/providers/Microsoft.NetApp/netAppAccounts/accountOriginatingResourceId/capacityPools/originatingResourceIdPool/volumes/theOriginalVolume/snapshots/theSnapshot
readOnly: true
x-nullable: true
inheritedSizeInBytes:
title: inheritedSizeInBytes
type: integer
format: int64
description: Space shared by short term clone volume with parent volume in bytes.
readOnly: true
x-nullable: true
exportPolicyRule:
description: Volume Export Policy Rule
type: object
properties:
ruleIndex:
type: integer
description: Order index
format: int32
unixReadOnly:
type: boolean
description: Read only access
unixReadWrite:
type: boolean
description: Read and write access
kerberos5ReadOnly:
type: boolean
description: >-
Kerberos5 Read only access. To be use with swagger version 2020-05-01
or later
example: false
default: false
kerberos5ReadWrite:
type: boolean
description: >-
Kerberos5 Read and write access. To be use with swagger version
2020-05-01 or later
example: false
default: false
kerberos5iReadOnly:
type: boolean
description: >-
Kerberos5i Read only access. To be use with swagger version 2020-05-01
or later
example: false
default: false
kerberos5iReadWrite:
type: boolean
description: >-
Kerberos5i Read and write access. To be use with swagger version
2020-05-01 or later
example: false
default: false
kerberos5pReadOnly:
type: boolean
description: >-
Kerberos5p Read only access. To be use with swagger version 2020-05-01
or later
example: false
default: false
kerberos5pReadWrite:
type: boolean
description: >-
Kerberos5p Read and write access. To be use with swagger version
2020-05-01 or later
example: false
default: false
cifs:
type: boolean
description: Allows CIFS protocol
nfsv3:
type: boolean
description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41:
type: boolean
description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
allowedClients:
type: string
description: >-
Client ingress specification as comma separated string with IPv4
CIDRs, IPv4 host addresses and host names
hasRootAccess:
type: boolean
description: Has root access to volume
example: true
default: true
chownMode:
type: string
description: >-
This parameter specifies who is authorized to change the ownership of
a file. restricted - Only root user can change the ownership of the
file. unrestricted - Non-root users can change ownership of files that
they own.
default: Restricted
enum:
- Restricted
- Unrestricted
x-ms-enum:
name: ChownMode
modelAsString: true
volumeBackupProperties:
description: Volume Backup Properties
type: object
properties:
backupPolicyId:
type: string
description: Backup Policy Resource ID
policyEnforced:
type: boolean
description: Policy Enforced
backupEnabled:
type: boolean
description: Backup Enabled
backupVaultId:
type: string
description: Backup Vault Resource ID
replicationObject:
description: Replication properties
type: object
required:
- remoteVolumeResourceId
properties:
replicationId:
type: string
description: Id
readOnly: true
endpointType:
type: string
description: >-
Indicates whether the local volume is the source or destination for
the Volume Replication
enum:
- src
- dst
x-ms-enum:
name: EndpointType
modelAsString: true
replicationSchedule:
type: string
description: Schedule
enum:
- _10minutely
- hourly
- daily
x-ms-enum:
name: ReplicationSchedule
modelAsString: true
remoteVolumeResourceId:
type: string
description: >-
The resource ID of the remote volume. Required for cross region and
cross zone replication
x-ms-mutability:
- read
- create
remotePath:
description: >-
The full path to a volume that is to be migrated into ANF. Required
for Migration volumes
type: object
$ref: '#/definitions/remotePath'
x-ms-mutability:
- read
- create
remoteVolumeRegion:
type: string
description: The remote region for the other end of the Volume Replication.
remotePath:
description: >-
The full path to a volume that is to be migrated into ANF. Required for
Migration volumes
type: object
required:
- externalHostName
- serverName
- volumeName
properties:
externalHostName:
type: string
description: The Path to a ONTAP Host
serverName:
type: string
description: The name of a server on the ONTAP Host
volumeName:
type: string
description: The name of a volume on the server
replication:
description: Replication properties
type: object
required:
- remoteVolumeResourceId
properties:
endpointType:
type: string
description: >-
Indicates whether the local volume is the source or destination for
the Volume Replication
enum:
- src
- dst
x-ms-enum:
name: EndpointType
modelAsString: true
replicationSchedule:
type: string
description: Schedule
enum:
- _10minutely
- hourly
- daily
x-ms-enum:
name: ReplicationSchedule
modelAsString: true
remoteVolumeResourceId:
type: string
description: The resource ID of the remote volume.
remoteVolumeRegion:
type: string
description: The remote region for the other end of the Volume Replication.
volumeRelocationProperties:
description: Volume relocation properties
type: object
properties:
relocationRequested:
type: boolean
description: Has relocation been requested for this volume
readyToBeFinalized:
type: boolean
readOnly: true
description: Has relocation finished and is ready to be cleaned up
volumeSnapshotProperties:
description: Volume Snapshot Properties
type: object
properties:
snapshotPolicyId:
type: string
description: Snapshot Policy ResourceId
replicationStatus:
description: Replication status
type: object
properties:
healthy:
type: boolean
description: Replication health check
relationshipStatus:
type: string
description: Status of the mirror relationship
enum:
- Idle
- Transferring
x-ms-enum:
name: RelationshipStatus
modelAsString: true
mirrorState:
type: string
description: The status of the replication
enum:
- Uninitialized
- Mirrored
- Broken
x-ms-enum:
name: MirrorState
modelAsString: true
totalProgress:
type: string
description: The progress of the replication
errorMessage:
type: string
description: Displays error message if the replication is in an error state
listReplications:
description: List Replications
type: object
properties:
value:
description: A list of replications
type: array
items:
$ref: '#/definitions/replication'
x-ms-identifiers: []
volumePatch:
description: Volume patch resource
type: object
x-ms-azure-resource: true
properties:
location:
type: string
description: Resource location
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Patchable volume properties
$ref: '#/definitions/volumePatchProperties'
x-ms-client-flatten: true
volumePatchProperties:
description: Patchable volume properties
type: object
properties:
serviceLevel:
title: serviceLevel
$ref: '#/definitions/serviceLevel'
usageThreshold:
title: usageThreshold
type: integer
format: int64
description: >-
Maximum storage quota allowed for a file system in bytes. This is a
soft quota used for alerting only. Minimum size is 100 GiB. Upper
limit is 100TiB, 500Tib for LargeVolume or 2400Tib for LargeVolume on
exceptional basis. Specified in bytes.
minimum: 107374182400
maximum: 2638827906662400
default: 107374182400
example: 107374182400
exportPolicy:
title: exportPolicy
description: Set of export policy rules
properties:
rules:
title: Export policy rule
description: Export policy rule
type: array
items:
$ref: '#/definitions/exportPolicyRule'
x-ms-identifiers:
- ruleIndex
throughputMibps:
title: >-
Maximum throughput in MiB/s that can be achieved by this volume and
this will be accepted as input only for manual qosType volume
type: number
example: 128.22
dataProtection:
title: DataProtection
description: >-
DataProtection type volumes include an object containing details of
the replication
properties:
backup:
title: Backup
description: Backup Properties
type: object
$ref: '#/definitions/volumeBackupProperties'
snapshot:
title: Snapshot
description: Snapshot properties.
$ref: '#/definitions/volumeSnapshotProperties'
isDefaultQuotaEnabled:
type: boolean
description: Specifies if default quota is enabled for the volume.
example: false
default: false
defaultUserQuotaInKiBs:
type: integer
format: int64
description: >-
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is
set, the minimum value of 4 KiBs applies .
example: 4
default: 0
defaultGroupQuotaInKiBs:
type: integer
format: int64
description: >-
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is
set, the minimum value of 4 KiBs applies.
example: 4
default: 0
unixPermissions:
type: string
description: >-
UNIX permissions for NFS volume accepted in octal 4 digit format.
First digit selects the set user ID(4), set group ID (2) and sticky
(1) attributes. Second digit selects permission for the owner of the
file: read (4), write (2) and execute (1). Third selects permissions
for other users in the same group. the fourth for other users not in
the group. 0755 - gives read/write/execute permissions to owner and
read/execute to group and other users.
minLength: 4
maxLength: 4
x-nullable: true
example: '0770'
coolAccess:
type: boolean
description: Specifies whether Cool Access(tiering) is enabled for the volume.
example: false
coolnessPeriod:
type: integer
description: >-
Specifies the number of days after which data that is not accessed by
clients will be tiered.
example: 7
minimum: 7
maximum: 183
format: int32
coolAccessRetrievalPolicy:
$ref: '#/definitions/coolAccessRetrievalPolicy'
snapshotDirectoryVisible:
type: boolean
description: >-
If enabled (true) the volume will contain a read-only snapshot
directory which provides access to each of the volume's snapshots.
smbAccessBasedEnumeration:
$ref: '#/definitions/smbAccessBasedEnumeration'
smbNonBrowsable:
$ref: '#/definitions/smbNonBrowsable'
mountTarget:
description: Mount Target
type: object
required:
- location
- properties
properties:
location:
type: string
description: Resource location
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
x-ms-client-flatten: true
properties:
description: Mount Target Properties
$ref: '#/definitions/mountTargetProperties'
x-ms-client-flatten: true
mountTargetProperties:
description: Mount target properties
type: object
required:
- fileSystemId
properties:
mountTargetId:
title: mountTargetId
type: string
readOnly: true
description: UUID v4 used to identify the MountTarget
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
fileSystemId:
title: fileSystemId
type: string
description: UUID v4 used to identify the MountTarget
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
ipAddress:
title: ipAddress
description: The mount target's IPv4 address
type: string
readOnly: true
example: 1.2.3.4
smbServerFqdn:
title: smbServerFQDN
description: The SMB server's Fully Qualified Domain Name, FQDN
type: string
example: fullyqualified.domainname.com
snapshotsList:
description: List of Snapshots
type: object
properties:
value:
description: A list of Snapshots
type: array
items:
$ref: '#/definitions/snapshot'
snapshot:
description: Snapshot of a Volume
type: object
required:
- location
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
location:
type: string
description: Resource location
x-ms-mutability:
- read
- create
properties:
description: Snapshot Properties
$ref: '#/definitions/snapshotProperties'
x-ms-client-flatten: true
snapshotPatch:
description: Snapshot patch
type: object
properties: {}
snapshotProperties:
description: Snapshot properties
type: object
properties:
snapshotId:
title: snapshotId
type: string
readOnly: true
description: UUID v4 used to identify the Snapshot
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
created:
title: name
type: string
format: date-time
readOnly: true
description: The creation date of the snapshot
example: '2017-08-15 13:23:33'
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
snapshotPolicyProperties:
description: Snapshot policy properties
type: object
properties:
hourlySchedule:
title: hourlySchedule
description: Schedule for hourly snapshots
type: object
$ref: '#/definitions/hourlySchedule'
dailySchedule:
title: dailySchedule
description: Schedule for daily snapshots
type: object
$ref: '#/definitions/dailySchedule'
weeklySchedule:
title: weeklySchedule
description: Schedule for weekly snapshots
type: object
$ref: '#/definitions/weeklySchedule'
monthlySchedule:
title: monthlySchedule
description: Schedule for monthly snapshots
type: object
$ref: '#/definitions/monthlySchedule'
enabled:
type: boolean
description: The property to decide policy is enabled or not
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
snapshotPolicy:
description: Snapshot policy information
type: object
required:
- location
- properties
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
etag:
readOnly: true
type: string
description: >-
A unique read-only string that changes whenever the resource is
updated.
properties:
description: Snapshot policy Properties
$ref: '#/definitions/snapshotPolicyProperties'
x-ms-client-flatten: true
snapshotPoliciesList:
description: List of Snapshot Policies
type: object
properties:
value:
description: A list of snapshot policies
type: array
items:
$ref: '#/definitions/snapshotPolicy'
snapshotPolicyDetails:
description: Snapshot policy properties
type: object
properties:
location:
type: string
description: Resource location
x-ms-mutability:
- read
- create
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Snapshot policy Properties
$ref: '#/definitions/snapshotPolicyProperties'
x-ms-client-flatten: true
snapshotPolicyPatch:
description: Snapshot policy Details for create and update
type: object
properties:
location:
type: string
description: Resource location
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Snapshot Policy properties
$ref: '#/definitions/snapshotPolicyProperties'
x-ms-client-flatten: true
snapshotPolicyVolumeList:
description: Volumes associated with snapshot policy
type: object
properties:
value:
description: List of volumes
type: array
items:
$ref: '#/definitions/volume'
hourlySchedule:
description: Hourly Schedule properties
type: object
properties:
snapshotsToKeep:
type: integer
description: Hourly snapshot count to keep
format: int32
minute:
type: integer
description: Indicates which minute snapshot should be taken
example: 30
format: int32
usedBytes:
type: integer
description: Resource size in bytes, current storage usage for the volume in bytes
format: int64
dailySchedule:
description: Daily Schedule properties
type: object
properties:
snapshotsToKeep:
type: integer
description: Daily snapshot count to keep
format: int32
hour:
type: integer
description: Indicates which hour in UTC timezone a snapshot should be taken
example: 11
format: int32
minute:
type: integer
description: Indicates which minute snapshot should be taken
example: 30
format: int32
usedBytes:
type: integer
description: Resource size in bytes, current storage usage for the volume in bytes
format: int64
weeklySchedule:
description: >-
Weekly Schedule properties, make a snapshot every week at a specific day
or days
type: object
properties:
snapshotsToKeep:
type: integer
description: Weekly snapshot count to keep
format: int32
day:
type: string
description: >-
Indicates which weekdays snapshot should be taken, accepts a comma
separated list of week day names in english
example: Sunday,Monday
hour:
type: integer
description: Indicates which hour in UTC timezone a snapshot should be taken
example: 11
format: int32
minute:
type: integer
description: Indicates which minute snapshot should be taken
example: 30
format: int32
usedBytes:
type: integer
description: Resource size in bytes, current storage usage for the volume in bytes
format: int64
monthlySchedule:
description: Monthly Schedule properties
type: object
properties:
snapshotsToKeep:
type: integer
description: Monthly snapshot count to keep
format: int32
daysOfMonth:
type: string
description: >-
Indicates which days of the month snapshot should be taken. A comma
delimited string.
example: 1,11,21
hour:
type: integer
description: Indicates which hour in UTC timezone a snapshot should be taken
example: 11
format: int32
minute:
type: integer
description: Indicates which minute snapshot should be taken
example: 30
format: int32
usedBytes:
type: integer
description: Resource size in bytes, current storage usage for the volume in bytes
format: int64
volumeRevert:
description: revert a volume to the snapshot
type: object
properties:
snapshotId:
type: string
description: Resource id of the snapshot
authorizeRequest:
description: Authorize request
type: object
properties:
remoteVolumeResourceId:
type: string
description: Resource id of the remote volume
breakReplicationRequest:
description: Break replication request
type: object
properties:
forceBreakReplication:
type: boolean
description: >-
If replication is in status transferring and you want to force break
the replication, set to true
reestablishReplicationRequest:
description: Re-establish request object supplied in the body of the operation.
type: object
properties:
sourceVolumeId:
type: string
description: Resource id of the source volume for the replication
relocateVolumeRequest:
description: Relocate volume request
type: object
properties:
creationToken:
type: string
description: New creation token for the volume that controls the mount point name
breakFileLocksRequest:
description: Break file locks request
type: object
properties:
clientIp:
type: string
description: To clear file locks on a volume for a particular client
pattern: >-
^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
example: 101.102.103.104
confirmRunningDisruptiveOperation:
type: boolean
description: >-
Break File locks could be a disruptive operation for application as
locks on the volume will be broken, if want to process, set to true.
default: false
poolChangeRequest:
description: Pool change request
type: object
required:
- newPoolResourceId
properties:
newPoolResourceId:
type: string
description: Resource id of the pool to move volume to
backupsList:
description: List of Backups
type: object
properties:
value:
description: A list of Backups
type: array
items:
$ref: '#/definitions/backup'
nextLink:
type: string
description: URL to get the next set of results.
backup:
description: Backup under a Backup Vault
type: object
required:
- properties
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
description: Backup Properties
$ref: '#/definitions/backupProperties'
x-ms-client-flatten: true
backupPatch:
description: Backup patch
type: object
properties:
properties:
description: Backup Patch Properties
$ref: '#/definitions/backupPatchProperties'
x-ms-client-flatten: true
backupProperties:
description: Backup properties
type: object
required:
- volumeResourceId
properties:
backupId:
title: backupId
type: string
readOnly: true
description: UUID v4 used to identify the Backup
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
creationDate:
title: creationDate
type: string
format: date-time
readOnly: true
description: The creation date of the backup
example: '2017-08-15 13:23:33'
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
size:
type: integer
readOnly: true
description: Size of backup in bytes
format: int64
label:
type: string
description: Label for backup
backupType:
title: backupType
type: string
readOnly: true
description: Type of backup Manual or Scheduled
enum:
- Manual
- Scheduled
x-ms-enum:
name: backupType
modelAsString: true
values:
- value: Manual
description: Manual backup
- value: Scheduled
description: Scheduled backup
example: Manual
failureReason:
type: string
readOnly: true
description: Failure reason
volumeResourceId:
type: string
description: ResourceId used to identify the Volume
x-ms-mutability:
- read
- create
useExistingSnapshot:
type: boolean
description: >-
Manual backup an already existing snapshot. This will always be false
for scheduled backups and true/false for manual backups
example: true
default: false
x-ms-mutability:
- read
- create
snapshotName:
type: string
description: The name of the snapshot
x-ms-mutability:
- read
- create
backupPolicyResourceId:
type: string
readOnly: true
description: ResourceId used to identify the backup policy
backupPatchProperties:
description: Backup patch properties
type: object
properties:
label:
type: string
description: Label for backup
backupPolicyProperties:
description: Backup policy properties
type: object
properties:
backupPolicyId:
type: string
readOnly: true
description: Backup Policy Resource ID
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
dailyBackupsToKeep:
type: integer
description: Daily backups count to keep
format: int32
weeklyBackupsToKeep:
type: integer
description: Weekly backups count to keep
format: int32
monthlyBackupsToKeep:
type: integer
description: Monthly backups count to keep
format: int32
volumesAssigned:
type: integer
readOnly: true
description: Volumes using current backup policy
format: int32
enabled:
type: boolean
description: The property to decide policy is enabled or not
volumeBackups:
description: A list of volumes assigned to this policy
readOnly: true
type: array
items:
$ref: '#/definitions/volumeBackups'
x-ms-identifiers:
- volumeName
backupPolicy:
description: Backup policy information
type: object
required:
- location
- properties
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
etag:
readOnly: true
type: string
description: >-
A unique read-only string that changes whenever the resource is
updated.
properties:
description: Backup policy Properties
$ref: '#/definitions/backupPolicyProperties'
x-ms-client-flatten: true
backupPoliciesList:
description: List of Backup Policies
type: object
properties:
value:
description: A list of backup policies
type: array
items:
$ref: '#/definitions/backupPolicy'
backupPolicyPatch:
description: Backup policy Details for create and update
type: object
x-ms-azure-resource: true
properties:
location:
type: string
description: Resource location
x-ms-mutability:
- read
- create
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Backup policy Properties
$ref: '#/definitions/backupPolicyProperties'
x-ms-client-flatten: true
volumeBackups:
description: Volume details using the backup policy
type: object
readOnly: true
properties:
volumeName:
type: string
description: Volume name
backupsCount:
type: integer
description: Total count of backups for volume
format: int32
policyEnabled:
type: boolean
description: Policy enabled
backupStatus:
description: Backup status
type: object
properties:
healthy:
type: boolean
readOnly: true
description: Backup health status
relationshipStatus:
type: string
readOnly: true
description: Status of the backup mirror relationship
enum:
- Idle
- Transferring
- Failed
- Unknown
x-ms-enum:
name: RelationshipStatus
modelAsString: true
mirrorState:
type: string
readOnly: true
description: The status of the backup
enum:
- Uninitialized
- Mirrored
- Broken
x-ms-enum:
name: MirrorState
modelAsString: true
unhealthyReason:
type: string
readOnly: true
description: Reason for the unhealthy backup relationship
errorMessage:
type: string
readOnly: true
description: Displays error message if the backup is in an error state
lastTransferSize:
type: integer
format: int64
readOnly: true
description: Displays the last transfer size
lastTransferType:
type: string
readOnly: true
description: Displays the last transfer type
totalTransferBytes:
type: integer
format: int64
readOnly: true
description: Displays the total bytes transferred
transferProgressBytes:
type: integer
format: int64
readOnly: true
description: >-
Displays the total number of bytes transferred for the ongoing
operation
restoreStatus:
description: Restore status
type: object
properties:
healthy:
type: boolean
readOnly: true
description: Restore health status
relationshipStatus:
type: string
readOnly: true
description: Status of the restore SnapMirror relationship
enum:
- Idle
- Transferring
- Failed
- Unknown
x-ms-enum:
name: RelationshipStatus
modelAsString: true
mirrorState:
type: string
readOnly: true
description: The status of the restore
enum:
- Uninitialized
- Mirrored
- Broken
x-ms-enum:
name: MirrorState
modelAsString: true
unhealthyReason:
type: string
readOnly: true
description: Reason for the unhealthy restore relationship
errorMessage:
type: string
readOnly: true
description: Displays error message if the restore is in an error state
totalTransferBytes:
type: integer
format: int64
readOnly: true
description: Displays the total bytes transferred
getGroupIdListForLDAPUserRequest:
description: Get group Id list for LDAP User request
type: object
required:
- username
properties:
username:
type: string
description: username is required to fetch the group to which user is part of
maxLength: 255
minLength: 1
getGroupIdListForLDAPUserResponse:
description: Group Id list for Ldap user
type: object
properties:
groupIdsForLdapUser:
description: Group Id list
type: array
items:
type: string
example:
- '123'
- '224'
cloudError:
x-ms-external: true
properties:
error:
$ref: '#/definitions/cloudErrorBody'
description: Cloud error body.
description: An error response from the service.
cloudErrorBody:
x-ms-external: true
properties:
code:
type: string
description: >-
An identifier for the error. Codes are invariant and are intended to
be consumed programmatically.
message:
type: string
description: >-
A message describing the error, intended to be suitable for display in
a user interface.
description: An error response from the service.
serviceLevel:
title: serviceLevel
type: string
description: The service level of the file system
enum:
- Standard
- Premium
- Ultra
- StandardZRS
default: Premium
x-ms-enum:
name: ServiceLevel
modelAsString: true
values:
- value: Standard
description: Standard service level
- value: Premium
description: Premium service level
- value: Ultra
description: Ultra service level
- value: StandardZRS
description: Zone redundant storage service level
volumeQuotaRulesList:
description: List of Volume Quota Rules
type: object
properties:
value:
description: A list of Volume Quota Rules
type: array
items:
$ref: '#/definitions/volumeQuotaRule'
volumeQuotaRule:
description: Quota Rule of a Volume
type: object
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
properties:
description: Volume Quota Rule Properties
$ref: '#/definitions/volumeQuotaRulesProperties'
x-ms-client-flatten: true
volumeQuotaRulePatch:
description: Patchable Quota Rule of a Volume
type: object
properties:
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
properties:
description: Volume Quota Rule Properties
$ref: '#/definitions/volumeQuotaRulesProperties'
x-ms-client-flatten: true
volumeQuotaRulesProperties:
description: Volume Quota Rule properties
type: object
properties:
provisioningState:
$ref: '#/definitions/netappProvisioningState'
quotaSizeInKiBs:
type: integer
description: Size of quota
format: int64
example: '100006'
quotaType:
title: quotaType
type: string
description: Type of quota
x-ms-mutability:
- read
- create
enum:
- DefaultUserQuota
- DefaultGroupQuota
- IndividualUserQuota
- IndividualGroupQuota
x-ms-enum:
name: type
modelAsString: true
values:
- value: DefaultUserQuota
description: Default user quota
- value: DefaultGroupQuota
description: Default group quota
- value: IndividualUserQuota
description: Individual user quota
- value: IndividualGroupQuota
description: Individual group quota
example: DefaultUserQuota
quotaTarget:
type: string
description: >-
UserID/GroupID/SID based on the quota target type. UserID and groupID
can be found by running ‘id’ or ‘getent’ command for the user or group
and SID can be found by running
x-ms-mutability:
- read
- create
volumeGroupList:
description: List of volume group resources
type: object
properties:
value:
description: List of volume Groups
type: array
items:
$ref: '#/definitions/volumeGroup'
volumeGroup:
description: Volume group resource
type: object
properties:
location:
type: string
description: Resource location
x-ms-mutability:
- read
- create
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
properties:
description: Volume group properties
$ref: '#/definitions/volumeGroupListProperties'
x-ms-client-flatten: true
volumeGroupDetails:
description: Volume group resource for create
type: object
properties:
location:
type: string
description: Resource location
x-ms-mutability:
- read
- create
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
properties:
description: Volume group properties
$ref: '#/definitions/volumeGroupProperties'
x-ms-client-flatten: true
volumeGroupMetaData:
description: Volume group properties
type: object
properties:
groupDescription:
type: string
description: Group Description
example: group description
applicationType:
type: string
description: Application Type
enum:
- SAP-HANA
- ORACLE
x-ms-enum:
name: ApplicationType
modelAsString: true
example: SAP-HANA
applicationIdentifier:
type: string
description: Application specific identifier
example: SH1
globalPlacementRules:
title: Global volume placement rules
description: Application specific placement rules for the volume group
type: array
items:
$ref: '#/definitions/placementKeyValuePairs'
x-ms-identifiers:
- key
volumesCount:
type: integer
format: int64
description: Number of volumes in volume group
example: 5
readOnly: true
volumeGroupProperties:
description: Volume group properties
type: object
properties:
provisioningState:
type: string
description: Azure lifecycle management
example: Available
readOnly: true
groupMetaData:
title: groupMetaData
description: Volume group details
type: object
$ref: '#/definitions/volumeGroupMetaData'
volumes:
description: List of volumes from group
type: array
items:
$ref: '#/definitions/volumeGroupVolumeProperties'
volumeGroupListProperties:
description: Volume group properties
type: object
properties:
provisioningState:
type: string
description: Azure lifecycle management
example: Available
readOnly: true
groupMetaData:
title: groupMetaData
description: Volume group details
type: object
$ref: '#/definitions/volumeGroupMetaData'
volumeGroupVolumeProperties:
description: Volume resource
type: object
x-ms-azure-resource: true
required:
- properties
properties:
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
description: Resource name
type:
type: string
readOnly: true
description: Resource type
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
zones:
type: array
description: Availability Zone
x-ms-mutability:
- read
- create
items:
type: string
maxLength: 255
minLength: 1
example: '1'
properties:
description: Volume properties
$ref: '#/definitions/volumeProperties'
x-ms-client-flatten: true
placementKeyValuePairs:
description: >-
Application specific parameters for the placement of volumes in the volume
group
type: object
required:
- key
- value
properties:
key:
type: string
description: >-
Key for an application specific parameter for the placement of volumes
in the volume group
example: key1
value:
type: string
description: >-
Value for an application specific parameter for the placement of
volumes in the volume group
example: value1
networkSiblingSet:
title: Network sibling set
description: Describes the contents of a network sibling set.
type: object
properties:
networkSiblingSetId:
$ref: '#/definitions/networkSiblingSetId'
subnetId:
$ref: '#/definitions/subnetId'
networkSiblingSetStateId:
$ref: '#/definitions/networkSiblingSetStateId'
networkFeatures:
$ref: '#/definitions/networkFeatures'
provisioningState:
$ref: '#/definitions/networkSiblingSetProvisioningState'
nicInfoList:
type: array
x-ms-identifiers: []
description: List of NIC information
items:
$ref: '#/definitions/nicInfo'
QueryNetworkSiblingSetRequest:
title: QueryNetworkSiblingSetRequest
description: Network sibling set query.
type: object
required:
- networkSiblingSetId
- subnetId
properties:
networkSiblingSetId:
$ref: '#/definitions/networkSiblingSetId'
subnetId:
$ref: '#/definitions/subnetId'
UpdateNetworkSiblingSetRequest:
title: UpdateNetworkSiblingSetRequest
description: Network sibling set update.
type: object
required:
- networkSiblingSetId
- subnetId
- networkSiblingSetStateId
- networkFeatures
properties:
networkSiblingSetId:
$ref: '#/definitions/networkSiblingSetId'
subnetId:
$ref: '#/definitions/subnetId'
networkSiblingSetStateId:
$ref: '#/definitions/networkSiblingSetStateId'
networkFeatures:
$ref: '#/definitions/networkFeatures'
description: Network features available to the volume
networkFeatures:
title: Network features
description: Network features available to the volume, or current state of update.
type: string
enum:
- Basic
- Standard
- Basic_Standard
- Standard_Basic
x-ms-enum:
name: NetworkFeatures
modelAsString: true
values:
- value: Basic
description: Basic network features.
- value: Standard
description: Standard network features.
- value: Basic_Standard
description: Updating from Basic to Standard network features.
- value: Standard_Basic
description: Updating from Standard to Basic network features.
example: Standard
default: Basic
networkSiblingSetProvisioningState:
readOnly: true
type: string
description: >-
Gets the status of the NetworkSiblingSet at the time the operation was
called.
enum:
- Succeeded
- Failed
- Canceled
- Updating
x-ms-enum:
name: NetworkSiblingSetProvisioningState
modelAsString: true
networkSiblingSetId:
title: Network Sibling Set ID
description: >-
Network Sibling Set ID for a group of volumes sharing networking resources
in a subnet.
type: string
pattern: >-
^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
maxLength: 36
minLength: 36
example: 9760acf5-4638-11e7-9bdb-020073ca3333
networkSiblingSetStateId:
title: Network sibling set state Id
description: >-
Network sibling set state Id identifying the current state of the sibling
set.
type: string
example: '12345_44420.8001578125'
nicInfo:
title: NIC information
description: >-
NIC information and list of volumes for which the NIC has the primary
mount ip address.
type: object
properties:
ipAddress:
$ref: '#/definitions/ipAddress'
volumeResourceIds:
$ref: '#/definitions/volumeResourceIds'
ipAddress:
title: ipAddress
type: string
readOnly: true
example: 1.2.3.4
volumeResourceIds:
title: Volume resource Ids
type: array
items:
title: Resource Id of volume
type: string
format: arm-id
x-ms-arm-id-details:
allowedResources:
- type: Microsoft.NetApp/netAppAccounts/capacityPools/volumes
subnetId:
title: Subnet resource Id
description: >-
The Azure Resource URI for a delegated subnet. Must have the delegation
Microsoft.NetApp/volumes. Example
/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}
type: string
format: arm-id
x-ms-arm-id-details:
allowedResources:
- type: Microsoft.Network/virtualNetworks/subnets
snapshotRestoreFiles:
description: Restore payload for Single File Snapshot Restore
type: object
x-ms-azure-resource: true
required:
- filePaths
properties:
filePaths:
description: List of files to be restored
type: array
minItems: 1
maxItems: 10
items:
type: string
maxLength: 1024
minLength: 1
example:
- /dir1/customer1.db
- /dir1/customer2.db
destinationPath:
description: Destination folder where the files will be restored
type: string
example: /AVSdataStore
backupRestoreFiles:
description: Restore payload for Single File Backup Restore
type: object
required:
- fileList
- destinationVolumeId
properties:
fileList:
description: List of files to be restored
type: array
minItems: 1
maxItems: 8
items:
type: string
maxLength: 1024
minLength: 1
example:
- /dir1/customer1.db
- /dir1/customer2.db
restoreFilePath:
description: >-
Destination folder where the files will be restored. The path name
should start with a forward slash. If it is omitted from request then
restore is done at the root folder of the destination volume by
default
type: string
pattern: ^\/.*$
example: /AVSdataStore
destinationVolumeId:
description: >-
Resource Id of the destination volume on which the files need to be
restored
type: string
example: >-
/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1
subvolumesList:
description: List of Subvolumes
type: object
properties:
value:
description: A list of Subvolumes
type: array
items:
$ref: '#/definitions/subvolumeInfo'
nextLink:
type: string
description: URL to get the next set of results.
subvolumeInfo:
description: Subvolume Information properties
type: object
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
properties:
properties:
description: Subvolume Properties
$ref: '#/definitions/subvolumeProperties'
x-ms-client-flatten: true
subvolumePatchRequest:
description: Subvolume Patch Request properties
type: object
x-ms-azure-resource: true
properties:
properties:
description: Subvolume Properties
$ref: '#/definitions/subvolumePatchParams'
x-ms-client-flatten: true
subvolumePatchParams:
description: Parameters with which a subvolume can be updated
type: object
properties:
size:
title: size
type: integer
x-nullable: true
format: int64
description: Truncate subvolume to the provided size in bytes
example: 5
path:
title: path
type: string
description: path to the subvolume
example: /pathToSubvolume
subvolumeProperties:
description: This represents path associated with the subvolume
type: object
properties:
path:
title: path
type: string
description: Path to the subvolume
example: /subvolume1
size:
title: size
type: integer
x-nullable: true
format: int64
description: Truncate subvolume to the provided size in bytes
example: 5
parentPath:
title: name
x-nullable: true
type: string
description: parent path to the subvolume
example: /parentPath
provisioningState:
type: string
description: Azure lifecycle management
readOnly: true
example: Available
subvolumeModel:
description: >-
Result of the post subvolume and action is to get metadata of the
subvolume.
type: object
properties:
id:
type: string
readOnly: true
description: Resource Id
name:
type: string
readOnly: true
description: Resource name
type:
type: string
readOnly: true
description: Resource type
properties:
description: It represents the minimal properties of the subvolume.
$ref: '#/definitions/subvolumeModelProperties'
x-ms-client-flatten: true
subvolumeModelProperties:
description: >-
Properties which represents actual subvolume model which is stored as a
file in the system.
type: object
properties:
path:
title: path
type: string
description: Path to the subvolume
example: /subvolume1
parentPath:
title: parentpath
type: string
description: Path to the parent subvolume
example: /parentPath
size:
title: size
type: integer
format: int64
description: Size of subvolume
example: 5
bytesUsed:
title: bytesUsed
type: integer
format: int64
description: Bytes used
example: 5
permissions:
title: permissions
type: string
description: Permissions of the subvolume
example: '777'
creationTimeStamp:
title: creationTimeStamp
type: string
format: date-time
description: Creation time and date
example: '2017-08-15T13:23:33Z'
accessedTimeStamp:
title: accessedTimeStamp
type: string
format: date-time
description: Most recent access time and date
example: '2017-08-15T13:23:33Z'
modifiedTimeStamp:
title: modifiedTimeStamp
type: string
format: date-time
description: Most recent modification time and date
example: '2017-08-15T13:23:33Z'
changedTimeStamp:
title: changedTimeStamp
type: string
format: date-time
description: Most recent change time and date
example: '2017-08-15T13:23:33Z'
provisioningState:
type: string
description: Azure lifecycle management
example: Available
netappProvisioningState:
readOnly: true
type: string
description: >-
Gets the status of the VolumeQuotaRule at the time the operation was
called.
enum:
- Accepted
- Creating
- Patching
- Deleting
- Moving
- Failed
- Succeeded
x-ms-enum:
name: ProvisioningState
modelAsString: false
encryptionMigrationRequest:
description: Encryption migration request
type: object
required:
- virtualNetworkId
- privateEndpointId
properties:
virtualNetworkId:
title: virtualNetworkId
type: string
description: Identifier for the virtual network
example: >-
/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet1
privateEndpointId:
title: privateEndpointId
type: string
description: Identifier of the private endpoint to reach the Azure Key Vault
example: >-
/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.Network/privateEndpoints/privateIP1
backupVaultsList:
description: List of Backup Vaults
type: object
properties:
value:
description: A list of Backup Vaults
type: array
items:
$ref: '#/definitions/backupVault'
nextLink:
type: string
description: URL to get the next set of results.
backupVault:
description: Backup Vault information
type: object
x-ms-azure-resource: true
required:
- location
allOf:
- $ref: >-
../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
properties:
properties:
description: Backup Vault Properties
$ref: '#/definitions/backupVaultProperties'
x-ms-client-flatten: true
backupVaultPatch:
description: Backup Vault information
type: object
x-ms-azure-resource: true
properties:
tags:
description: Resource tags
$ref: '#/definitions/resourceTags'
backupVaultProperties:
description: Backup Vault properties
type: object
properties:
provisioningState:
type: string
readOnly: true
description: Azure lifecycle management
backupsMigrationRequest:
description: Migrate Backups Request
type: object
x-ms-azure-resource: true
required:
- backupVaultId
properties:
backupVaultId:
type: string
description: The ResourceId of the Backup Vault
example: >-
/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/backupVaults/backupVault1
coolAccessRetrievalPolicy:
type: string
description: >-
coolAccessRetrievalPolicy determines the data retrieval behavior from the
cool tier to standard storage based on the read pattern for cool access
enabled volumes. The possible values for this field are:
Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.
OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.
Never - No client-driven data is pulled from cool tier to standard storage.
enum:
- Default
- OnRead
- Never
x-ms-enum:
name: coolAccessRetrievalPolicy
modelAsString: true
clusterPeerCommandResponse:
description: Information about cluster peering process
type: object
properties:
peerAcceptCommand:
description: >-
A command that needs to be run on the external ONTAP to accept cluster
peering. Will only be present if clusterPeeringStatus is
pending
type: string
svmPeerCommandResponse:
description: Information about SVM peering process
type: object
properties:
svmPeeringCommand:
description: >-
A command that needs to be run on the external ONTAP to accept SVM
peering. Will only be present if svmPeeringStatus is
pending
type: string
peerClusterForVolumeMigrationRequest:
description: Source cluster properties for a cluster peer request
type: object
required:
- peerAddresses
properties:
peerAddresses:
type: array
minItems: 1
description: >-
A list of IC-LIF IPs that can be used to connect to the on-prem
cluster
example:
- 0.0.0.1
- 0.0.0.2
- 0.0.0.3
- 0.0.0.4
- 0.0.0.5
- 0.0.0.6
items:
type: string
remotePath:
description: >-
The full path to a volume that is to be migrated into ANF. Required
for Migration volumes
type: object
$ref: '#/definitions/remotePath'
x-ms-mutability:
- read
- create
smbAccessBasedEnumeration:
title: smbAccessBasedEnumeration
type: string
description: >-
Enables access-based enumeration share property for SMB Shares. Only
applicable for SMB/DualProtocol volume
enum:
- Disabled
- Enabled
x-ms-enum:
name: smbAccessBasedEnumeration
modelAsString: true
values:
- value: Disabled
description: smbAccessBasedEnumeration share setting is disabled
- value: Enabled
description: smbAccessBasedEnumeration share setting is enabled
x-nullable: true
example: Enabled
smbNonBrowsable:
title: smbNonBrowsable
type: string
description: >-
Enables non-browsable property for SMB Shares. Only applicable for
SMB/DualProtocol volume
enum:
- Disabled
- Enabled
x-ms-enum:
name: smbNonBrowsable
modelAsString: true
values:
- value: Disabled
description: smbNonBrowsable share setting is disabled
- value: Enabled
description: smbNonBrowsable share setting is enabled
example: Enabled
parameters:
AccountName:
name: accountName
type: string
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$
in: path
required: true
description: The name of the NetApp account
x-ms-parameter-location: method
PoolName:
name: poolName
type: string
in: path
required: true
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
minLength: 1
maxLength: 64
description: The name of the capacity pool
x-ms-parameter-location: method
VolumeName:
name: volumeName
type: string
in: path
required: true
pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
minLength: 1
maxLength: 64
description: The name of the volume
x-ms-parameter-location: method
MountTargetName:
name: mountTargetName
type: string
in: path
required: true
description: The name of the mount target
x-ms-parameter-location: method
SnapshotName:
name: snapshotName
type: string
in: path
required: true
description: The name of the snapshot
x-ms-parameter-location: method
SnapshotPolicyName:
name: snapshotPolicyName
type: string
in: path
required: true
description: The name of the snapshot policy
x-ms-parameter-location: method
BackupName:
name: backupName
type: string
in: path
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_.]{0,255}$
required: true
description: The name of the backup
x-ms-parameter-location: method
BackupPolicyName:
name: backupPolicyName
in: path
required: true
type: string
description: Backup policy Name which uniquely identify backup policy.
x-ms-parameter-location: method
QuotaLimitName:
name: quotaLimitName
type: string
in: path
required: true
description: The name of the Quota Limit
x-ms-parameter-location: method
VolumeGroupName:
name: volumeGroupName
type: string
in: path
required: true
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
minLength: 1
maxLength: 64
description: The name of the volumeGroup
x-ms-parameter-location: method
SubvolumeName:
name: subvolumeName
in: path
required: true
type: string
description: The name of the subvolume.
pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$
minLength: 1
maxLength: 64
x-ms-parameter-location: method
VolumeQuotaRuleName:
name: volumeQuotaRuleName
type: string
in: path
required: true
description: The name of volume quota rule
x-ms-parameter-location: method
BackupVaultName:
name: backupVaultName
in: path
required: true
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$
type: string
description: The name of the Backup Vault
x-ms-parameter-location: method
tags:
- name: Backup Policy
- name: Backup Vaults
- name: Backups
- name: Capacity Pools
- name: File Locks
- name: Group ID List for LDAP User
- name: NetApp Accounts
- name: NetApp Resource
- name: Operations
- name: Pool Change
- name: Reset Cifs Password
- name: Restore
- name: Snapshot Policy
- name: Snapshot Policy List Volumes
- name: Snapshots
- name: Split Clone Volume
- name: Subvolumes
- name: Volume Groups
- name: VolumeQuotaRules
- name: Volumes
- name: Volumes OnPrem Migration
- name: Volumes OnPrem Migration Finalize
- name: Volumes Relocation
- name: Volumes Replication
- name: Volumes Revert