Microsoft.NetApp (stable:2025-08-01)

2025/11/14 • 14 updated methods

Accounts_ListBySubscription (updated)
Description :  List and describe all NetApp accounts in the subscription.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@removed_a357153c80514128923c6d894834ce09": {
                  "#name": "ldapConfiguration",
                  "Description": "LDAP Configuration for the account.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "domain",
                      "Description": "Name of the LDAP configuration domain",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "ldapServers",
                      "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "ldapOverTLS",
                      "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                      "Required": false,
                      "Type": "boolean"
                    },
                    {
                      "#name": "serverCACertificate",
                      "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                      "Format": "password",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateCNHost",
                      "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.NetApp/netAppAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetAppAccount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_List (updated)
Description :  List and describe all NetApp accounts in the resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "@removed_3872679959564c05aa549dd3d99c4d66": {
                  "#name": "ldapConfiguration",
                  "Description": "LDAP Configuration for the account.",
                  "Required": false,
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "domain",
                      "Description": "Name of the LDAP configuration domain",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "ldapServers",
                      "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                      "Required": false,
                      "Type": "array",
                      "$items": {
                        "Type": "string"
                      }
                    },
                    {
                      "#name": "ldapOverTLS",
                      "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                      "Required": false,
                      "Type": "boolean"
                    },
                    {
                      "#name": "serverCACertificate",
                      "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                      "Format": "password",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "certificateCNHost",
                      "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                      "Required": false,
                      "Type": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The NetAppAccount items on this page ,
Required: True ,
}
[
{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_Get (updated)
Description :  Get the NetApp account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@removed_da332d1fd09f491f8318c6de222326fb": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_CreateOrUpdate (updated)
Description :  Create or update the specified NetApp account within the resource group
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "@removed_7da62ed6adee48f4b40c26dfaac33faa": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@removed_3359229723af47c7a7d2f9a278ed937f": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "@removed_568cc6ff295b4495a3d722d1510b806f": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NetApp account resource ,
}
{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Accounts_Update (updated)
Description :  Patch the specified NetApp account
Reference :  Link ¶

⚶ Changes

{
  "#id": "Accounts_Update",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "@removed_a466de638a6947f6b1369e28ae2858ed": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "@removed_46a3837986c2487fad1b6f7b477d3ccf": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    },
    "202": {
      "$properties": {
        "properties": [
          {
            "@removed_67e11c38cdcf47a6ad11791f06dd1906": {
              "#name": "ldapConfiguration",
              "Description": "LDAP Configuration for the account.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "domain",
                  "Description": "Name of the LDAP configuration domain",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "ldapServers",
                  "Description": "List of LDAP server IP addresses (IPv4 only) for the LDAP domain.",
                  "Required": false,
                  "Type": "array",
                  "$items": {
                    "Type": "string"
                  }
                },
                {
                  "#name": "ldapOverTLS",
                  "Description": "Specifies whether or not the LDAP traffic needs to be secured via TLS.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "serverCACertificate",
                  "Description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded ldap servers CA certificate.",
                  "Format": "password",
                  "Required": false,
                  "Type": "string"
                },
                {
                  "#name": "certificateCNHost",
                  "Description": "The CN host name used while generating the certificate, LDAP Over TLS requires the CN host name to create DNS host entry.",
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
body:
{
Description: NetApp Account object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The identity used for the resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (202)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: NetApp account resource ,
}
{
properties:
{
Description: NetApp Account properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
activeDirectories:
{
Description: Active Directories ,
Required: False ,
}
[
{
activeDirectoryId:
{
Description: Id of the Active Directory ,
Required: False ,
}
string ,
username:
{
Description: A domain user account with permission to create machine accounts ,
Required: False ,
}
string ,
password:
{
Description: Plain text password of Active Directory domain administrator, value is masked in the response ,
Format: password ,
Required: False ,
}
string ,
domain:
{
Description: Name of the Active Directory domain ,
Required: False ,
}
string ,
dns:
{
Description: Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain ,
Required: False ,
}
string ,
status:
{
Description: Status of the Active Directory ,
Enum:
{
Created: Active Directory created but not in use ,
InUse: Active Directory in use by SMB Volume ,
Deleted: Active Directory Deleted ,
Error: Error with the Active Directory ,
Updating: Active Directory Updating ,
}
,
Required: False ,
}
enum ,
statusDetails:
{
Description: Any details in regards to the Status of the Active Directory ,
Required: False ,
}
string ,
smbServerName:
{
Description: NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes ,
Required: False ,
}
string ,
organizationalUnit:
{
Description: The Organizational Unit (OU) within the Windows Active Directory ,
Required: False ,
}
string ,
site:
{
Description: The Active Directory site the service will limit Domain Controller discovery to ,
Required: False ,
}
string ,
backupOperators:
{
Description: Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
administrators:
{
Description: Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier ,
Required: False ,
}
[
string ,
]
,
kdcIP:
{
Description: kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. ,
Required: False ,
}
string ,
adName:
{
Description: Name of the active directory machine. This optional parameter is used only while creating kerberos volume ,
Required: False ,
}
string ,
serverRootCACertificate:
{
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. ,
Format: password ,
Required: False ,
}
string ,
aesEncryption:
{
Description: If enabled, AES encryption will be enabled for SMB communication. ,
Required: False ,
}
boolean ,
ldapSigning:
{
Description: Specifies whether or not the LDAP traffic needs to be signed. ,
Required: False ,
}
boolean ,
securityOperators:
{
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 ,
Required: False ,
}
[
string ,
]
,
ldapOverTLS:
{
Description: Specifies whether or not the LDAP traffic needs to be secured via TLS. ,
Required: False ,
}
boolean ,
allowLocalNfsUsersWithLdap:
{
Description: If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. ,
Required: False ,
}
boolean ,
encryptDCConnections:
{
Description: If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. ,
Required: False ,
}
boolean ,
ldapSearchScope:
{
Description: LDAP Search scope options ,
Required: False ,
}
{
userDN:
{
Description: This specifies the user DN, which overrides the base DN for user lookups. ,
Required: False ,
}
string ,
groupDN:
{
Description: This specifies the group DN, which overrides the base DN for group lookups. ,
Required: False ,
}
string ,
groupMembershipFilter:
{
Description: This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. ,
Required: False ,
}
string ,
}
,
preferredServersForLdapClient:
{
Description: Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. ,
Required: False ,
}
string ,
}
,
]
,
encryption:
{
Description: Encryption settings ,
Required: False ,
}
{
keySource:
{
Description: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultProperties:
{
Description: Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
keyVaultId:
{
Description: UUID v4 used to identify the Azure Key Vault configuration ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The Uri of KeyVault. ,
Format: uri ,
Required: True ,
}
string ,
keyName:
{
Description: The name of KeyVault key. ,
Required: True ,
}
string ,
keyVaultResourceId:
{
Description: The resource ID of KeyVault. ,
Format: arm-id ,
Required: False ,
}
string ,
status:
{
Description: Status of the KeyVault connection. ,
Enum:
{
Created: KeyVault connection created but not in use ,
InUse: KeyVault connection in use by SMB Volume ,
Deleted: KeyVault connection Deleted ,
Error: Error with the KeyVault connection ,
Updating: KeyVault connection Updating ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. ,
Required: False ,
}
string ,
userAssignedIdentity:
{
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. ,
Required: False ,
}
string ,
federatedClientId:
{
Description: ClientId of the multi-tenant AAD Application. Used to access cross-tenant keyvaults. ,
Required: False ,
}
string ,
}
,
}
,
disableShowmount:
{
Description: Shows the status of disableShowmount for all volumes under the subscription, null equals false ,
Required: False ,
}
boolean ,
nfsV4IDDomain:
{
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. ,
Required: False ,
}
string ,
multiAdStatus:
{
Description: MultiAD Status for the account ,
Enum:
{
Disabled: Account is MultiAD disabled, Means its a SharedAD or SingleAD account. ,
Enabled: Account is MultiAD enabled ,
}
,
Required: False ,
}
enum ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
identity:
{
Description: The managed service identities assigned to this resource. ,
Required: False ,
}
{
principalId:
{
Description: The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. ,
Format: uuid ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). ,
Enum:
{
None: No description available. ,
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
SystemAssigned,UserAssigned: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_List (updated)
Description :  List all volumes within the capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "dataProtection": [
                  {
                    "replication": [
                      {
                        "@removed_d64ff93be22740bfbf6d27d7c558c762": {
                          "#name": "externalReplicationSetupStatus",
                          "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                          "Enum": [
                            [
                              "ClusterPeerRequired",
                              "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                            ],
                            [
                              "ClusterPeerPending",
                              "The peering needs to be accepted on your cluster before the setup can proceed"
                            ],
                            [
                              "VServerPeerRequired",
                              "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                            ],
                            [
                              "ReplicationCreateRequired",
                              "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                            ],
                            [
                              "NoActionRequired",
                              "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_feae39841b97430a8af8ab1a8f5ed25a": {
                          "#name": "externalReplicationSetupInfo",
                          "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_3d4893e0734c4d90b2b0064371ec8ff1": {
                          "#name": "mirrorState",
                          "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                          "Enum": [
                            [
                              "Uninitialized",
                              ""
                            ],
                            [
                              "Mirrored",
                              ""
                            ],
                            [
                              "Broken",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_124fe85268494e40a744aeacd550b743": {
                          "#name": "relationshipStatus",
                          "Description": "The status of the Volume Replication",
                          "Enum": [
                            [
                              "Idle",
                              ""
                            ],
                            [
                              "Transferring",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "@removed_329cc50761a646e1af81740942d2017d": {
                  "#name": "ldapServerType",
                  "Description": "Specifies the type of LDAP server for a given NFS volume.",
                  "Enum": [
                    [
                      "ActiveDirectory",
                      "The volume should use Active Directory for LDAP connections."
                    ],
                    [
                      "OpenLDAP",
                      "The volume should use OpenLDAP for LDAP connections."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_292eb32b9dd14a148611c44413b3aac2": {
                  "#name": "language",
                  "Description": "Language supported for volume.",
                  "Enum": [
                    [
                      "c.utf-8",
                      "Posix with UTF-8"
                    ],
                    [
                      "utf8mb4",
                      "UTF-8 with 4 byte character support"
                    ],
                    [
                      "ar",
                      "Arabic - Deprecated"
                    ],
                    [
                      "ar.utf-8",
                      "Arabic with UTF-8"
                    ],
                    [
                      "hr",
                      "Croatian - Deprecated"
                    ],
                    [
                      "hr.utf-8",
                      "Croatian with UTF-8"
                    ],
                    [
                      "cs",
                      "Czech - Deprecated"
                    ],
                    [
                      "cs.utf-8",
                      "Czech with UTF-8"
                    ],
                    [
                      "da",
                      "Danish - Deprecated"
                    ],
                    [
                      "da.utf-8",
                      "Danish with UTF-8"
                    ],
                    [
                      "nl",
                      "Dutch - Deprecated"
                    ],
                    [
                      "nl.utf-8",
                      "Dutch with UTF-8"
                    ],
                    [
                      "en",
                      "English - Deprecated"
                    ],
                    [
                      "en.utf-8",
                      "English with UTF-8"
                    ],
                    [
                      "fi",
                      "Finnish - Deprecated"
                    ],
                    [
                      "fi.utf-8",
                      "Finnish with UTF-8"
                    ],
                    [
                      "fr",
                      "French - Deprecated"
                    ],
                    [
                      "fr.utf-8",
                      "French with UTF-8"
                    ],
                    [
                      "de",
                      "German - Deprecated"
                    ],
                    [
                      "de.utf-8",
                      "German with UTF-8"
                    ],
                    [
                      "he",
                      "Hebrew - Deprecated"
                    ],
                    [
                      "he.utf-8",
                      "Hebrew with UTF-8"
                    ],
                    [
                      "hu",
                      "Hungarian - Deprecated"
                    ],
                    [
                      "hu.utf-8",
                      "Hungarian with UTF-8"
                    ],
                    [
                      "it",
                      "Italian - Deprecated"
                    ],
                    [
                      "it.utf-8",
                      "Italian with UTF-8"
                    ],
                    [
                      "ja",
                      "Japanese euc-j - Deprecated"
                    ],
                    [
                      "ja.utf-8",
                      "Japanese euc-j with UTF-8"
                    ],
                    [
                      "ja-v1",
                      "Japanese euc-j - Deprecated"
                    ],
                    [
                      "ja-v1.utf-8",
                      "Japanese euc-j with UTF-8"
                    ],
                    [
                      "ja-jp.pck",
                      "Japanese pck"
                    ],
                    [
                      "ja-jp.pck.utf-8",
                      "Japanese pck with UTF-8 - Deprecated"
                    ],
                    [
                      "ja-jp.932",
                      "Japanese cp932"
                    ],
                    [
                      "ja-jp.932.utf-8",
                      "Japanese cp932 with UTF-8 - Deprecated"
                    ],
                    [
                      "ja-jp.pck-v2",
                      "Japanese pck - sjis"
                    ],
                    [
                      "ja-jp.pck-v2.utf-8",
                      "Japanese pck - sjis with UTF-8 - Deprecated"
                    ],
                    [
                      "ko",
                      "Korean - Deprecated"
                    ],
                    [
                      "ko.utf-8",
                      "Korean with UTF-8"
                    ],
                    [
                      "no",
                      "Norwegian - Deprecated"
                    ],
                    [
                      "no.utf-8",
                      "Norwegian with UTF-8"
                    ],
                    [
                      "pl",
                      "Polish - Deprecated"
                    ],
                    [
                      "pl.utf-8",
                      "Polish with UTF-8"
                    ],
                    [
                      "pt",
                      "Portuguese - Deprecated"
                    ],
                    [
                      "pt.utf-8",
                      "Portuguese with UTF-8"
                    ],
                    [
                      "c",
                      "Posix - Deprecated"
                    ],
                    [
                      "ro",
                      "Romanian - Deprecated"
                    ],
                    [
                      "ro.utf-8",
                      "Romanian with UTF-8"
                    ],
                    [
                      "ru",
                      "Russian - Deprecated"
                    ],
                    [
                      "ru.utf-8",
                      "Russian with UTF-8"
                    ],
                    [
                      "zh",
                      "Simplified Chinese - Deprecated"
                    ],
                    [
                      "zh.utf-8",
                      "Simplified Chinese with UTF-8"
                    ],
                    [
                      "zh.gbk",
                      "Simplified gbk Chinese"
                    ],
                    [
                      "zh.gbk.utf-8",
                      "Simplified gbk Chinese with UTF-8 - Deprecated"
                    ],
                    [
                      "zh-tw.big5",
                      "Traditional Chinese BIG 5"
                    ],
                    [
                      "zh-tw.big5.utf-8",
                      "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                    ],
                    [
                      "zh-tw",
                      "Traditional Chinese EUC-TW"
                    ],
                    [
                      "zh-tw.utf-8",
                      "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                    ],
                    [
                      "sk",
                      "Slovak - Deprecated"
                    ],
                    [
                      "sk.utf-8",
                      "Slovak with UTF-8"
                    ],
                    [
                      "sl",
                      "Slovenian - Deprecated"
                    ],
                    [
                      "sl.utf-8",
                      "Slovenian with UTF-8"
                    ],
                    [
                      "es",
                      "Spanish - Deprecated"
                    ],
                    [
                      "es.utf-8",
                      "Spanish with UTF-8"
                    ],
                    [
                      "sv",
                      "Swedish - Deprecated"
                    ],
                    [
                      "sv.utf-8",
                      "Swedish with UTF-8"
                    ],
                    [
                      "tr",
                      "Turkish - Deprecated"
                    ],
                    [
                      "tr.utf-8",
                      "Turkish with UTF-8"
                    ],
                    [
                      "en-us",
                      "US English - Deprecated"
                    ],
                    [
                      "en-us.utf-8",
                      "US English with UTF-8"
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Get (updated)
Description :  Get the details of the specified volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_667bcb5b29fe4899a464b1c450d70687": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_30629c6200c54cf3a80ef34749611abe": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_e3af57481eed4d1b85de48dac733b44b": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_0e369ce3398b4957a2d3a025c44111e5": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_e18abb88c054400f8aac4a19adfdcbfd": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_baf9a179d7664dfc8360b23765992aad": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_CreateOrUpdate (updated)
Description :  Create or update the specified volume within the capacity pool
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_CreateOrUpdate",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_20d70795f6fe4f819417d7595eea00a4": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_9a5f54f98a954a1ca24cdb2c905f7200": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_e609e770f8d74cc0b2a316c4505e325f": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_886926f5f4034dd4a4a8db11385d9c51": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_37c983f75ce34105b168543a65ad63bd": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_c8b718ee6b484ce1ad088f2d171dd0e4": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_6bab89356b7340e790129d2d6f6af239": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_5cdfa63b292c46e89e06ff34063f006d": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_d2d3d72719004b3b945bd2cbfcdd490a": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_f31314bc965345ccb613bb09b721a827": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_e346d0c51d4a4774a065e05006c7e510": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_64ad7b3623f54d7ba1b785aff23699a0": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_a01d3c288c3344dba4010262805d3451": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_4287485cd3ab4bceaa14b714b1d1984e": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_a780b7e1f7514f399cc6d37e2c7815d9": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_68ad3f2da69741ce9a3cf216724ece2e": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_8baaded636b742688baf816bed8ba49e": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_80c53b2301204366b94c2b795f4e0ba2": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation:
{
Description: A link to the status monitor ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Volume resource ,
}
{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_Update (updated)
Description :  Patch the specified volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_Update",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_ce5a0510c46b47b2b171cb2bc90cee0f": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_1d927c93d5494d3180d47177fd2935b3": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_1cb62024111f4ff09d981a1844b9aad7": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_5bd756c34acd42b7a402303589151003": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_6215fe63d31e4c54a189a8f86d19cd70": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_6751178badb4457a872339e74ba9fbbf": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
body:
{
Description: Volume object supplied in the body of the operation. ,
Required: True ,
}
{
location:
{
Description: Resource location ,
Required: False ,
}
string ,
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Description: Patchable volume properties ,
Required: False ,
}
{
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: False ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
}
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
snapshotDirectoryVisible:
{
Description: If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots. ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_PopulateAvailabilityZone (updated)
Description :  This operation will populate availability zone information for a volume
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_PopulateAvailabilityZone",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_9080610207de43f2876d3d62b2224c8d": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_ef25f946449e46f8bd1d026645366835": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_c928df8d37fc4f37b533ec9d3f84034c": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_11dbaac0d81a44b082f45815f669653f": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_9b95c5e1af2b4c549688619d84e0323c": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_706dc9e1ab794c92ad3a662c8f01ce0c": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/populateAvailabilityZone
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Volumes_SplitCloneFromParent (updated)
Description :  Split operation to convert clone volume to an independent volume.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Volumes_SplitCloneFromParent",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "dataProtection": [
              {
                "replication": [
                  {
                    "@removed_72982eecb3ff407d8c79300beb3317f6": {
                      "#name": "externalReplicationSetupStatus",
                      "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                      "Enum": [
                        [
                          "ClusterPeerRequired",
                          "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                        ],
                        [
                          "ClusterPeerPending",
                          "The peering needs to be accepted on your cluster before the setup can proceed"
                        ],
                        [
                          "VServerPeerRequired",
                          "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                        ],
                        [
                          "ReplicationCreateRequired",
                          "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                        ],
                        [
                          "NoActionRequired",
                          "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_5cc3dbe5ffc74f49a2408b4c55fa8fcd": {
                      "#name": "externalReplicationSetupInfo",
                      "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_5d0fa55704334e27bc945a6c23cba0c7": {
                      "#name": "mirrorState",
                      "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                      "Enum": [
                        [
                          "Uninitialized",
                          ""
                        ],
                        [
                          "Mirrored",
                          ""
                        ],
                        [
                          "Broken",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_ffe539f8e422439c98f366e79423bc82": {
                      "#name": "relationshipStatus",
                      "Description": "The status of the Volume Replication",
                      "Enum": [
                        [
                          "Idle",
                          ""
                        ],
                        [
                          "Transferring",
                          ""
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            ]
          },
          {
            "@removed_2f7ed389bb6c403bab3919ec3ae1205c": {
              "#name": "ldapServerType",
              "Description": "Specifies the type of LDAP server for a given NFS volume.",
              "Enum": [
                [
                  "ActiveDirectory",
                  "The volume should use Active Directory for LDAP connections."
                ],
                [
                  "OpenLDAP",
                  "The volume should use OpenLDAP for LDAP connections."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          },
          {
            "@removed_8d590d0489374cc7850c92e404f8b558": {
              "#name": "language",
              "Description": "Language supported for volume.",
              "Enum": [
                [
                  "c.utf-8",
                  "Posix with UTF-8"
                ],
                [
                  "utf8mb4",
                  "UTF-8 with 4 byte character support"
                ],
                [
                  "ar",
                  "Arabic - Deprecated"
                ],
                [
                  "ar.utf-8",
                  "Arabic with UTF-8"
                ],
                [
                  "hr",
                  "Croatian - Deprecated"
                ],
                [
                  "hr.utf-8",
                  "Croatian with UTF-8"
                ],
                [
                  "cs",
                  "Czech - Deprecated"
                ],
                [
                  "cs.utf-8",
                  "Czech with UTF-8"
                ],
                [
                  "da",
                  "Danish - Deprecated"
                ],
                [
                  "da.utf-8",
                  "Danish with UTF-8"
                ],
                [
                  "nl",
                  "Dutch - Deprecated"
                ],
                [
                  "nl.utf-8",
                  "Dutch with UTF-8"
                ],
                [
                  "en",
                  "English - Deprecated"
                ],
                [
                  "en.utf-8",
                  "English with UTF-8"
                ],
                [
                  "fi",
                  "Finnish - Deprecated"
                ],
                [
                  "fi.utf-8",
                  "Finnish with UTF-8"
                ],
                [
                  "fr",
                  "French - Deprecated"
                ],
                [
                  "fr.utf-8",
                  "French with UTF-8"
                ],
                [
                  "de",
                  "German - Deprecated"
                ],
                [
                  "de.utf-8",
                  "German with UTF-8"
                ],
                [
                  "he",
                  "Hebrew - Deprecated"
                ],
                [
                  "he.utf-8",
                  "Hebrew with UTF-8"
                ],
                [
                  "hu",
                  "Hungarian - Deprecated"
                ],
                [
                  "hu.utf-8",
                  "Hungarian with UTF-8"
                ],
                [
                  "it",
                  "Italian - Deprecated"
                ],
                [
                  "it.utf-8",
                  "Italian with UTF-8"
                ],
                [
                  "ja",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-v1",
                  "Japanese euc-j - Deprecated"
                ],
                [
                  "ja-v1.utf-8",
                  "Japanese euc-j with UTF-8"
                ],
                [
                  "ja-jp.pck",
                  "Japanese pck"
                ],
                [
                  "ja-jp.pck.utf-8",
                  "Japanese pck with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.932",
                  "Japanese cp932"
                ],
                [
                  "ja-jp.932.utf-8",
                  "Japanese cp932 with UTF-8 - Deprecated"
                ],
                [
                  "ja-jp.pck-v2",
                  "Japanese pck - sjis"
                ],
                [
                  "ja-jp.pck-v2.utf-8",
                  "Japanese pck - sjis with UTF-8 - Deprecated"
                ],
                [
                  "ko",
                  "Korean - Deprecated"
                ],
                [
                  "ko.utf-8",
                  "Korean with UTF-8"
                ],
                [
                  "no",
                  "Norwegian - Deprecated"
                ],
                [
                  "no.utf-8",
                  "Norwegian with UTF-8"
                ],
                [
                  "pl",
                  "Polish - Deprecated"
                ],
                [
                  "pl.utf-8",
                  "Polish with UTF-8"
                ],
                [
                  "pt",
                  "Portuguese - Deprecated"
                ],
                [
                  "pt.utf-8",
                  "Portuguese with UTF-8"
                ],
                [
                  "c",
                  "Posix - Deprecated"
                ],
                [
                  "ro",
                  "Romanian - Deprecated"
                ],
                [
                  "ro.utf-8",
                  "Romanian with UTF-8"
                ],
                [
                  "ru",
                  "Russian - Deprecated"
                ],
                [
                  "ru.utf-8",
                  "Russian with UTF-8"
                ],
                [
                  "zh",
                  "Simplified Chinese - Deprecated"
                ],
                [
                  "zh.utf-8",
                  "Simplified Chinese with UTF-8"
                ],
                [
                  "zh.gbk",
                  "Simplified gbk Chinese"
                ],
                [
                  "zh.gbk.utf-8",
                  "Simplified gbk Chinese with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw.big5",
                  "Traditional Chinese BIG 5"
                ],
                [
                  "zh-tw.big5.utf-8",
                  "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                ],
                [
                  "zh-tw",
                  "Traditional Chinese EUC-TW"
                ],
                [
                  "zh-tw.utf-8",
                  "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                ],
                [
                  "sk",
                  "Slovak - Deprecated"
                ],
                [
                  "sk.utf-8",
                  "Slovak with UTF-8"
                ],
                [
                  "sl",
                  "Slovenian - Deprecated"
                ],
                [
                  "sl.utf-8",
                  "Slovenian with UTF-8"
                ],
                [
                  "es",
                  "Spanish - Deprecated"
                ],
                [
                  "es.utf-8",
                  "Spanish with UTF-8"
                ],
                [
                  "sv",
                  "Swedish - Deprecated"
                ],
                [
                  "sv.utf-8",
                  "Swedish with UTF-8"
                ],
                [
                  "tr",
                  "Turkish - Deprecated"
                ],
                [
                  "tr.utf-8",
                  "Turkish with UTF-8"
                ],
                [
                  "en-us",
                  "US English - Deprecated"
                ],
                [
                  "en-us.utf-8",
                  "US English with UTF-8"
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/splitCloneFromParent
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
poolName:
{
Description: The name of the capacity pool ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of the volume ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SnapshotPolicies_ListVolumes (updated)
Description :  Get volumes associated with snapshot policy
Reference :  Link ¶

⚶ Changes

{
  "#id": "SnapshotPolicies_ListVolumes",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "dataProtection": [
                  {
                    "replication": [
                      {
                        "@removed_1b750273c22d477ca8d42fdf793f697f": {
                          "#name": "externalReplicationSetupStatus",
                          "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                          "Enum": [
                            [
                              "ClusterPeerRequired",
                              "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                            ],
                            [
                              "ClusterPeerPending",
                              "The peering needs to be accepted on your cluster before the setup can proceed"
                            ],
                            [
                              "VServerPeerRequired",
                              "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                            ],
                            [
                              "ReplicationCreateRequired",
                              "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                            ],
                            [
                              "NoActionRequired",
                              "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_02a9db243d1542dda5212543ca96dbf8": {
                          "#name": "externalReplicationSetupInfo",
                          "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_98c830022f9445a69516b60757898ea0": {
                          "#name": "mirrorState",
                          "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                          "Enum": [
                            [
                              "Uninitialized",
                              ""
                            ],
                            [
                              "Mirrored",
                              ""
                            ],
                            [
                              "Broken",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      },
                      {
                        "@removed_aa9f7c985e3b43bca2e0f84bdabbfac8": {
                          "#name": "relationshipStatus",
                          "Description": "The status of the Volume Replication",
                          "Enum": [
                            [
                              "Idle",
                              ""
                            ],
                            [
                              "Transferring",
                              ""
                            ]
                          ],
                          "Required": false,
                          "Type": "string"
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "@removed_63d8655e0e86445c9328563d3ee7b761": {
                  "#name": "ldapServerType",
                  "Description": "Specifies the type of LDAP server for a given NFS volume.",
                  "Enum": [
                    [
                      "ActiveDirectory",
                      "The volume should use Active Directory for LDAP connections."
                    ],
                    [
                      "OpenLDAP",
                      "The volume should use OpenLDAP for LDAP connections."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              },
              {
                "@removed_e80a6f1fa2094e078bd5ba0d976c6915": {
                  "#name": "language",
                  "Description": "Language supported for volume.",
                  "Enum": [
                    [
                      "c.utf-8",
                      "Posix with UTF-8"
                    ],
                    [
                      "utf8mb4",
                      "UTF-8 with 4 byte character support"
                    ],
                    [
                      "ar",
                      "Arabic - Deprecated"
                    ],
                    [
                      "ar.utf-8",
                      "Arabic with UTF-8"
                    ],
                    [
                      "hr",
                      "Croatian - Deprecated"
                    ],
                    [
                      "hr.utf-8",
                      "Croatian with UTF-8"
                    ],
                    [
                      "cs",
                      "Czech - Deprecated"
                    ],
                    [
                      "cs.utf-8",
                      "Czech with UTF-8"
                    ],
                    [
                      "da",
                      "Danish - Deprecated"
                    ],
                    [
                      "da.utf-8",
                      "Danish with UTF-8"
                    ],
                    [
                      "nl",
                      "Dutch - Deprecated"
                    ],
                    [
                      "nl.utf-8",
                      "Dutch with UTF-8"
                    ],
                    [
                      "en",
                      "English - Deprecated"
                    ],
                    [
                      "en.utf-8",
                      "English with UTF-8"
                    ],
                    [
                      "fi",
                      "Finnish - Deprecated"
                    ],
                    [
                      "fi.utf-8",
                      "Finnish with UTF-8"
                    ],
                    [
                      "fr",
                      "French - Deprecated"
                    ],
                    [
                      "fr.utf-8",
                      "French with UTF-8"
                    ],
                    [
                      "de",
                      "German - Deprecated"
                    ],
                    [
                      "de.utf-8",
                      "German with UTF-8"
                    ],
                    [
                      "he",
                      "Hebrew - Deprecated"
                    ],
                    [
                      "he.utf-8",
                      "Hebrew with UTF-8"
                    ],
                    [
                      "hu",
                      "Hungarian - Deprecated"
                    ],
                    [
                      "hu.utf-8",
                      "Hungarian with UTF-8"
                    ],
                    [
                      "it",
                      "Italian - Deprecated"
                    ],
                    [
                      "it.utf-8",
                      "Italian with UTF-8"
                    ],
                    [
                      "ja",
                      "Japanese euc-j - Deprecated"
                    ],
                    [
                      "ja.utf-8",
                      "Japanese euc-j with UTF-8"
                    ],
                    [
                      "ja-v1",
                      "Japanese euc-j - Deprecated"
                    ],
                    [
                      "ja-v1.utf-8",
                      "Japanese euc-j with UTF-8"
                    ],
                    [
                      "ja-jp.pck",
                      "Japanese pck"
                    ],
                    [
                      "ja-jp.pck.utf-8",
                      "Japanese pck with UTF-8 - Deprecated"
                    ],
                    [
                      "ja-jp.932",
                      "Japanese cp932"
                    ],
                    [
                      "ja-jp.932.utf-8",
                      "Japanese cp932 with UTF-8 - Deprecated"
                    ],
                    [
                      "ja-jp.pck-v2",
                      "Japanese pck - sjis"
                    ],
                    [
                      "ja-jp.pck-v2.utf-8",
                      "Japanese pck - sjis with UTF-8 - Deprecated"
                    ],
                    [
                      "ko",
                      "Korean - Deprecated"
                    ],
                    [
                      "ko.utf-8",
                      "Korean with UTF-8"
                    ],
                    [
                      "no",
                      "Norwegian - Deprecated"
                    ],
                    [
                      "no.utf-8",
                      "Norwegian with UTF-8"
                    ],
                    [
                      "pl",
                      "Polish - Deprecated"
                    ],
                    [
                      "pl.utf-8",
                      "Polish with UTF-8"
                    ],
                    [
                      "pt",
                      "Portuguese - Deprecated"
                    ],
                    [
                      "pt.utf-8",
                      "Portuguese with UTF-8"
                    ],
                    [
                      "c",
                      "Posix - Deprecated"
                    ],
                    [
                      "ro",
                      "Romanian - Deprecated"
                    ],
                    [
                      "ro.utf-8",
                      "Romanian with UTF-8"
                    ],
                    [
                      "ru",
                      "Russian - Deprecated"
                    ],
                    [
                      "ru.utf-8",
                      "Russian with UTF-8"
                    ],
                    [
                      "zh",
                      "Simplified Chinese - Deprecated"
                    ],
                    [
                      "zh.utf-8",
                      "Simplified Chinese with UTF-8"
                    ],
                    [
                      "zh.gbk",
                      "Simplified gbk Chinese"
                    ],
                    [
                      "zh.gbk.utf-8",
                      "Simplified gbk Chinese with UTF-8 - Deprecated"
                    ],
                    [
                      "zh-tw.big5",
                      "Traditional Chinese BIG 5"
                    ],
                    [
                      "zh-tw.big5.utf-8",
                      "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                    ],
                    [
                      "zh-tw",
                      "Traditional Chinese EUC-TW"
                    ],
                    [
                      "zh-tw.utf-8",
                      "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                    ],
                    [
                      "sk",
                      "Slovak - Deprecated"
                    ],
                    [
                      "sk.utf-8",
                      "Slovak with UTF-8"
                    ],
                    [
                      "sl",
                      "Slovenian - Deprecated"
                    ],
                    [
                      "sl.utf-8",
                      "Slovenian with UTF-8"
                    ],
                    [
                      "es",
                      "Spanish - Deprecated"
                    ],
                    [
                      "es.utf-8",
                      "Spanish with UTF-8"
                    ],
                    [
                      "sv",
                      "Swedish - Deprecated"
                    ],
                    [
                      "sv.utf-8",
                      "Swedish with UTF-8"
                    ],
                    [
                      "tr",
                      "Turkish - Deprecated"
                    ],
                    [
                      "tr.utf-8",
                      "Turkish with UTF-8"
                    ],
                    [
                      "en-us",
                      "US English - Deprecated"
                    ],
                    [
                      "en-us.utf-8",
                      "US English with UTF-8"
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
snapshotPolicyName:
{
Description: The name of the snapshot policy ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Volume items on this page ,
Required: True ,
}
[
{
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
etag:
{
Description: "If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.") ,
Required: False ,
}
string ,
zones:
{
Description: The availability zones. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Get (updated)
Description :  Get details of the specified volume group
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeGroups_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "@removed_410bcba164634494a33c3fc7ffa1440a": {
                              "#name": "externalReplicationSetupStatus",
                              "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                              "Enum": [
                                [
                                  "ClusterPeerRequired",
                                  "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                                ],
                                [
                                  "ClusterPeerPending",
                                  "The peering needs to be accepted on your cluster before the setup can proceed"
                                ],
                                [
                                  "VServerPeerRequired",
                                  "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                                ],
                                [
                                  "ReplicationCreateRequired",
                                  "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                                ],
                                [
                                  "NoActionRequired",
                                  "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_040e5bb69f46431db7e5e931e5e4bd92": {
                              "#name": "externalReplicationSetupInfo",
                              "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_e1a75e13834241349b4f104e8468631b": {
                              "#name": "mirrorState",
                              "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                              "Enum": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_7c19b257a2fc45739de2b893ab7d87e4": {
                              "#name": "relationshipStatus",
                              "Description": "The status of the Volume Replication",
                              "Enum": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "@removed_6cc2d08722504dce877e2fc6a3420f75": {
                      "#name": "ldapServerType",
                      "Description": "Specifies the type of LDAP server for a given NFS volume.",
                      "Enum": [
                        [
                          "ActiveDirectory",
                          "The volume should use Active Directory for LDAP connections."
                        ],
                        [
                          "OpenLDAP",
                          "The volume should use OpenLDAP for LDAP connections."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_73a56535ef93401582685042697881af": {
                      "#name": "language",
                      "Description": "Language supported for volume.",
                      "Enum": [
                        [
                          "c.utf-8",
                          "Posix with UTF-8"
                        ],
                        [
                          "utf8mb4",
                          "UTF-8 with 4 byte character support"
                        ],
                        [
                          "ar",
                          "Arabic - Deprecated"
                        ],
                        [
                          "ar.utf-8",
                          "Arabic with UTF-8"
                        ],
                        [
                          "hr",
                          "Croatian - Deprecated"
                        ],
                        [
                          "hr.utf-8",
                          "Croatian with UTF-8"
                        ],
                        [
                          "cs",
                          "Czech - Deprecated"
                        ],
                        [
                          "cs.utf-8",
                          "Czech with UTF-8"
                        ],
                        [
                          "da",
                          "Danish - Deprecated"
                        ],
                        [
                          "da.utf-8",
                          "Danish with UTF-8"
                        ],
                        [
                          "nl",
                          "Dutch - Deprecated"
                        ],
                        [
                          "nl.utf-8",
                          "Dutch with UTF-8"
                        ],
                        [
                          "en",
                          "English - Deprecated"
                        ],
                        [
                          "en.utf-8",
                          "English with UTF-8"
                        ],
                        [
                          "fi",
                          "Finnish - Deprecated"
                        ],
                        [
                          "fi.utf-8",
                          "Finnish with UTF-8"
                        ],
                        [
                          "fr",
                          "French - Deprecated"
                        ],
                        [
                          "fr.utf-8",
                          "French with UTF-8"
                        ],
                        [
                          "de",
                          "German - Deprecated"
                        ],
                        [
                          "de.utf-8",
                          "German with UTF-8"
                        ],
                        [
                          "he",
                          "Hebrew - Deprecated"
                        ],
                        [
                          "he.utf-8",
                          "Hebrew with UTF-8"
                        ],
                        [
                          "hu",
                          "Hungarian - Deprecated"
                        ],
                        [
                          "hu.utf-8",
                          "Hungarian with UTF-8"
                        ],
                        [
                          "it",
                          "Italian - Deprecated"
                        ],
                        [
                          "it.utf-8",
                          "Italian with UTF-8"
                        ],
                        [
                          "ja",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-v1",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja-v1.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-jp.pck",
                          "Japanese pck"
                        ],
                        [
                          "ja-jp.pck.utf-8",
                          "Japanese pck with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.932",
                          "Japanese cp932"
                        ],
                        [
                          "ja-jp.932.utf-8",
                          "Japanese cp932 with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.pck-v2",
                          "Japanese pck - sjis"
                        ],
                        [
                          "ja-jp.pck-v2.utf-8",
                          "Japanese pck - sjis with UTF-8 - Deprecated"
                        ],
                        [
                          "ko",
                          "Korean - Deprecated"
                        ],
                        [
                          "ko.utf-8",
                          "Korean with UTF-8"
                        ],
                        [
                          "no",
                          "Norwegian - Deprecated"
                        ],
                        [
                          "no.utf-8",
                          "Norwegian with UTF-8"
                        ],
                        [
                          "pl",
                          "Polish - Deprecated"
                        ],
                        [
                          "pl.utf-8",
                          "Polish with UTF-8"
                        ],
                        [
                          "pt",
                          "Portuguese - Deprecated"
                        ],
                        [
                          "pt.utf-8",
                          "Portuguese with UTF-8"
                        ],
                        [
                          "c",
                          "Posix - Deprecated"
                        ],
                        [
                          "ro",
                          "Romanian - Deprecated"
                        ],
                        [
                          "ro.utf-8",
                          "Romanian with UTF-8"
                        ],
                        [
                          "ru",
                          "Russian - Deprecated"
                        ],
                        [
                          "ru.utf-8",
                          "Russian with UTF-8"
                        ],
                        [
                          "zh",
                          "Simplified Chinese - Deprecated"
                        ],
                        [
                          "zh.utf-8",
                          "Simplified Chinese with UTF-8"
                        ],
                        [
                          "zh.gbk",
                          "Simplified gbk Chinese"
                        ],
                        [
                          "zh.gbk.utf-8",
                          "Simplified gbk Chinese with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw.big5",
                          "Traditional Chinese BIG 5"
                        ],
                        [
                          "zh-tw.big5.utf-8",
                          "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw",
                          "Traditional Chinese EUC-TW"
                        ],
                        [
                          "zh-tw.utf-8",
                          "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                        ],
                        [
                          "sk",
                          "Slovak - Deprecated"
                        ],
                        [
                          "sk.utf-8",
                          "Slovak with UTF-8"
                        ],
                        [
                          "sl",
                          "Slovenian - Deprecated"
                        ],
                        [
                          "sl.utf-8",
                          "Slovenian with UTF-8"
                        ],
                        [
                          "es",
                          "Spanish - Deprecated"
                        ],
                        [
                          "es.utf-8",
                          "Spanish with UTF-8"
                        ],
                        [
                          "sv",
                          "Swedish - Deprecated"
                        ],
                        [
                          "sv.utf-8",
                          "Swedish with UTF-8"
                        ],
                        [
                          "tr",
                          "Turkish - Deprecated"
                        ],
                        [
                          "tr.utf-8",
                          "Turkish with UTF-8"
                        ],
                        [
                          "en-us",
                          "US English - Deprecated"
                        ],
                        [
                          "en-us.utf-8",
                          "US English with UTF-8"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
zones:
{
Description: Availability Zone ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
VolumeGroups_Create (updated)
Description :  Create a volume group along with specified volumes
Reference :  Link ¶

⚶ Changes

{
  "#id": "VolumeGroups_Create",
  "$parameters": {
    "body": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "@removed_2dbbc8bf5ff147fd8293eee82c753569": {
                              "#name": "externalReplicationSetupStatus",
                              "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                              "Enum": [
                                [
                                  "ClusterPeerRequired",
                                  "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                                ],
                                [
                                  "ClusterPeerPending",
                                  "The peering needs to be accepted on your cluster before the setup can proceed"
                                ],
                                [
                                  "VServerPeerRequired",
                                  "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                                ],
                                [
                                  "ReplicationCreateRequired",
                                  "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                                ],
                                [
                                  "NoActionRequired",
                                  "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_4c01ac6505cd490494a5bfde9c232cee": {
                              "#name": "externalReplicationSetupInfo",
                              "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_b8184bb458384735a7c0d6483421dcb4": {
                              "#name": "mirrorState",
                              "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                              "Enum": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_4dc11321b0884f21a588230978f2b488": {
                              "#name": "relationshipStatus",
                              "Description": "The status of the Volume Replication",
                              "Enum": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "@removed_43320821ce3d45e99b815b35a46d7301": {
                      "#name": "ldapServerType",
                      "Description": "Specifies the type of LDAP server for a given NFS volume.",
                      "Enum": [
                        [
                          "ActiveDirectory",
                          "The volume should use Active Directory for LDAP connections."
                        ],
                        [
                          "OpenLDAP",
                          "The volume should use OpenLDAP for LDAP connections."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_d52cafaf15a44b27ae1f006feee31399": {
                      "#name": "language",
                      "Description": "Language supported for volume.",
                      "Enum": [
                        [
                          "c.utf-8",
                          "Posix with UTF-8"
                        ],
                        [
                          "utf8mb4",
                          "UTF-8 with 4 byte character support"
                        ],
                        [
                          "ar",
                          "Arabic - Deprecated"
                        ],
                        [
                          "ar.utf-8",
                          "Arabic with UTF-8"
                        ],
                        [
                          "hr",
                          "Croatian - Deprecated"
                        ],
                        [
                          "hr.utf-8",
                          "Croatian with UTF-8"
                        ],
                        [
                          "cs",
                          "Czech - Deprecated"
                        ],
                        [
                          "cs.utf-8",
                          "Czech with UTF-8"
                        ],
                        [
                          "da",
                          "Danish - Deprecated"
                        ],
                        [
                          "da.utf-8",
                          "Danish with UTF-8"
                        ],
                        [
                          "nl",
                          "Dutch - Deprecated"
                        ],
                        [
                          "nl.utf-8",
                          "Dutch with UTF-8"
                        ],
                        [
                          "en",
                          "English - Deprecated"
                        ],
                        [
                          "en.utf-8",
                          "English with UTF-8"
                        ],
                        [
                          "fi",
                          "Finnish - Deprecated"
                        ],
                        [
                          "fi.utf-8",
                          "Finnish with UTF-8"
                        ],
                        [
                          "fr",
                          "French - Deprecated"
                        ],
                        [
                          "fr.utf-8",
                          "French with UTF-8"
                        ],
                        [
                          "de",
                          "German - Deprecated"
                        ],
                        [
                          "de.utf-8",
                          "German with UTF-8"
                        ],
                        [
                          "he",
                          "Hebrew - Deprecated"
                        ],
                        [
                          "he.utf-8",
                          "Hebrew with UTF-8"
                        ],
                        [
                          "hu",
                          "Hungarian - Deprecated"
                        ],
                        [
                          "hu.utf-8",
                          "Hungarian with UTF-8"
                        ],
                        [
                          "it",
                          "Italian - Deprecated"
                        ],
                        [
                          "it.utf-8",
                          "Italian with UTF-8"
                        ],
                        [
                          "ja",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-v1",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja-v1.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-jp.pck",
                          "Japanese pck"
                        ],
                        [
                          "ja-jp.pck.utf-8",
                          "Japanese pck with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.932",
                          "Japanese cp932"
                        ],
                        [
                          "ja-jp.932.utf-8",
                          "Japanese cp932 with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.pck-v2",
                          "Japanese pck - sjis"
                        ],
                        [
                          "ja-jp.pck-v2.utf-8",
                          "Japanese pck - sjis with UTF-8 - Deprecated"
                        ],
                        [
                          "ko",
                          "Korean - Deprecated"
                        ],
                        [
                          "ko.utf-8",
                          "Korean with UTF-8"
                        ],
                        [
                          "no",
                          "Norwegian - Deprecated"
                        ],
                        [
                          "no.utf-8",
                          "Norwegian with UTF-8"
                        ],
                        [
                          "pl",
                          "Polish - Deprecated"
                        ],
                        [
                          "pl.utf-8",
                          "Polish with UTF-8"
                        ],
                        [
                          "pt",
                          "Portuguese - Deprecated"
                        ],
                        [
                          "pt.utf-8",
                          "Portuguese with UTF-8"
                        ],
                        [
                          "c",
                          "Posix - Deprecated"
                        ],
                        [
                          "ro",
                          "Romanian - Deprecated"
                        ],
                        [
                          "ro.utf-8",
                          "Romanian with UTF-8"
                        ],
                        [
                          "ru",
                          "Russian - Deprecated"
                        ],
                        [
                          "ru.utf-8",
                          "Russian with UTF-8"
                        ],
                        [
                          "zh",
                          "Simplified Chinese - Deprecated"
                        ],
                        [
                          "zh.utf-8",
                          "Simplified Chinese with UTF-8"
                        ],
                        [
                          "zh.gbk",
                          "Simplified gbk Chinese"
                        ],
                        [
                          "zh.gbk.utf-8",
                          "Simplified gbk Chinese with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw.big5",
                          "Traditional Chinese BIG 5"
                        ],
                        [
                          "zh-tw.big5.utf-8",
                          "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw",
                          "Traditional Chinese EUC-TW"
                        ],
                        [
                          "zh-tw.utf-8",
                          "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                        ],
                        [
                          "sk",
                          "Slovak - Deprecated"
                        ],
                        [
                          "sk.utf-8",
                          "Slovak with UTF-8"
                        ],
                        [
                          "sl",
                          "Slovenian - Deprecated"
                        ],
                        [
                          "sl.utf-8",
                          "Slovenian with UTF-8"
                        ],
                        [
                          "es",
                          "Spanish - Deprecated"
                        ],
                        [
                          "es.utf-8",
                          "Spanish with UTF-8"
                        ],
                        [
                          "sv",
                          "Swedish - Deprecated"
                        ],
                        [
                          "sv.utf-8",
                          "Swedish with UTF-8"
                        ],
                        [
                          "tr",
                          "Turkish - Deprecated"
                        ],
                        [
                          "tr.utf-8",
                          "Turkish with UTF-8"
                        ],
                        [
                          "en-us",
                          "US English - Deprecated"
                        ],
                        [
                          "en-us.utf-8",
                          "US English with UTF-8"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "properties": [
          {
            "volumes": {
              "$properties": {
                "properties": [
                  {
                    "dataProtection": [
                      {
                        "replication": [
                          {
                            "@removed_1cddfc36a0c94b85b4d43df803be301b": {
                              "#name": "externalReplicationSetupStatus",
                              "Description": "Property that only applies to external replications. Provides a machine-readable value for the status of the external replication setup.",
                              "Enum": [
                                [
                                  "ClusterPeerRequired",
                                  "Your cluster needs to be peered by using the 'peerExternalCluster' action"
                                ],
                                [
                                  "ClusterPeerPending",
                                  "The peering needs to be accepted on your cluster before the setup can proceed"
                                ],
                                [
                                  "VServerPeerRequired",
                                  "Need to call 'authorizeExternalReplication' and accept the returned 'vserver peer accept' command on your cluster to finish setting up the external replication"
                                ],
                                [
                                  "ReplicationCreateRequired",
                                  "Need to call 'authorizeExternalReplication' to finish setting up the external replication"
                                ],
                                [
                                  "NoActionRequired",
                                  "External Replication setup is complete, you can now monitor the 'mirrorState' in the replication status for the health of the replication"
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_3b31c3cd1d9c4878b280f1acf2e9a3d1": {
                              "#name": "externalReplicationSetupInfo",
                              "Description": "Contains human-readable instructions on what the next step is to finish the external replication setup.",
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_94dd5b5ab9ec4e7a9f3b06bb4770d776": {
                              "#name": "mirrorState",
                              "Description": "The mirror state property describes the current status of data replication for a replication. It provides insight into whether the data is actively being mirrored, if the replication process has been paused, or if it has yet to be initialized.",
                              "Enum": [
                                [
                                  "Uninitialized",
                                  ""
                                ],
                                [
                                  "Mirrored",
                                  ""
                                ],
                                [
                                  "Broken",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          },
                          {
                            "@removed_5ceb8b1722b94deeac8198ce09d6981b": {
                              "#name": "relationshipStatus",
                              "Description": "The status of the Volume Replication",
                              "Enum": [
                                [
                                  "Idle",
                                  ""
                                ],
                                [
                                  "Transferring",
                                  ""
                                ]
                              ],
                              "Required": false,
                              "Type": "string"
                            }
                          }
                        ]
                      }
                    ]
                  },
                  {
                    "@removed_b07c330ba94e4dc3965653c452cdcbe0": {
                      "#name": "ldapServerType",
                      "Description": "Specifies the type of LDAP server for a given NFS volume.",
                      "Enum": [
                        [
                          "ActiveDirectory",
                          "The volume should use Active Directory for LDAP connections."
                        ],
                        [
                          "OpenLDAP",
                          "The volume should use OpenLDAP for LDAP connections."
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  },
                  {
                    "@removed_05f2ecc8fe3946d0ab5fa94cf0ab15b4": {
                      "#name": "language",
                      "Description": "Language supported for volume.",
                      "Enum": [
                        [
                          "c.utf-8",
                          "Posix with UTF-8"
                        ],
                        [
                          "utf8mb4",
                          "UTF-8 with 4 byte character support"
                        ],
                        [
                          "ar",
                          "Arabic - Deprecated"
                        ],
                        [
                          "ar.utf-8",
                          "Arabic with UTF-8"
                        ],
                        [
                          "hr",
                          "Croatian - Deprecated"
                        ],
                        [
                          "hr.utf-8",
                          "Croatian with UTF-8"
                        ],
                        [
                          "cs",
                          "Czech - Deprecated"
                        ],
                        [
                          "cs.utf-8",
                          "Czech with UTF-8"
                        ],
                        [
                          "da",
                          "Danish - Deprecated"
                        ],
                        [
                          "da.utf-8",
                          "Danish with UTF-8"
                        ],
                        [
                          "nl",
                          "Dutch - Deprecated"
                        ],
                        [
                          "nl.utf-8",
                          "Dutch with UTF-8"
                        ],
                        [
                          "en",
                          "English - Deprecated"
                        ],
                        [
                          "en.utf-8",
                          "English with UTF-8"
                        ],
                        [
                          "fi",
                          "Finnish - Deprecated"
                        ],
                        [
                          "fi.utf-8",
                          "Finnish with UTF-8"
                        ],
                        [
                          "fr",
                          "French - Deprecated"
                        ],
                        [
                          "fr.utf-8",
                          "French with UTF-8"
                        ],
                        [
                          "de",
                          "German - Deprecated"
                        ],
                        [
                          "de.utf-8",
                          "German with UTF-8"
                        ],
                        [
                          "he",
                          "Hebrew - Deprecated"
                        ],
                        [
                          "he.utf-8",
                          "Hebrew with UTF-8"
                        ],
                        [
                          "hu",
                          "Hungarian - Deprecated"
                        ],
                        [
                          "hu.utf-8",
                          "Hungarian with UTF-8"
                        ],
                        [
                          "it",
                          "Italian - Deprecated"
                        ],
                        [
                          "it.utf-8",
                          "Italian with UTF-8"
                        ],
                        [
                          "ja",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-v1",
                          "Japanese euc-j - Deprecated"
                        ],
                        [
                          "ja-v1.utf-8",
                          "Japanese euc-j with UTF-8"
                        ],
                        [
                          "ja-jp.pck",
                          "Japanese pck"
                        ],
                        [
                          "ja-jp.pck.utf-8",
                          "Japanese pck with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.932",
                          "Japanese cp932"
                        ],
                        [
                          "ja-jp.932.utf-8",
                          "Japanese cp932 with UTF-8 - Deprecated"
                        ],
                        [
                          "ja-jp.pck-v2",
                          "Japanese pck - sjis"
                        ],
                        [
                          "ja-jp.pck-v2.utf-8",
                          "Japanese pck - sjis with UTF-8 - Deprecated"
                        ],
                        [
                          "ko",
                          "Korean - Deprecated"
                        ],
                        [
                          "ko.utf-8",
                          "Korean with UTF-8"
                        ],
                        [
                          "no",
                          "Norwegian - Deprecated"
                        ],
                        [
                          "no.utf-8",
                          "Norwegian with UTF-8"
                        ],
                        [
                          "pl",
                          "Polish - Deprecated"
                        ],
                        [
                          "pl.utf-8",
                          "Polish with UTF-8"
                        ],
                        [
                          "pt",
                          "Portuguese - Deprecated"
                        ],
                        [
                          "pt.utf-8",
                          "Portuguese with UTF-8"
                        ],
                        [
                          "c",
                          "Posix - Deprecated"
                        ],
                        [
                          "ro",
                          "Romanian - Deprecated"
                        ],
                        [
                          "ro.utf-8",
                          "Romanian with UTF-8"
                        ],
                        [
                          "ru",
                          "Russian - Deprecated"
                        ],
                        [
                          "ru.utf-8",
                          "Russian with UTF-8"
                        ],
                        [
                          "zh",
                          "Simplified Chinese - Deprecated"
                        ],
                        [
                          "zh.utf-8",
                          "Simplified Chinese with UTF-8"
                        ],
                        [
                          "zh.gbk",
                          "Simplified gbk Chinese"
                        ],
                        [
                          "zh.gbk.utf-8",
                          "Simplified gbk Chinese with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw.big5",
                          "Traditional Chinese BIG 5"
                        ],
                        [
                          "zh-tw.big5.utf-8",
                          "Traditional Chinese BIG 5 with UTF-8 - Deprecated"
                        ],
                        [
                          "zh-tw",
                          "Traditional Chinese EUC-TW"
                        ],
                        [
                          "zh-tw.utf-8",
                          "Traditional Chinese EUC-TW with UTF-8 - Deprecated"
                        ],
                        [
                          "sk",
                          "Slovak - Deprecated"
                        ],
                        [
                          "sk.utf-8",
                          "Slovak with UTF-8"
                        ],
                        [
                          "sl",
                          "Slovenian - Deprecated"
                        ],
                        [
                          "sl.utf-8",
                          "Slovenian with UTF-8"
                        ],
                        [
                          "es",
                          "Spanish - Deprecated"
                        ],
                        [
                          "es.utf-8",
                          "Spanish with UTF-8"
                        ],
                        [
                          "sv",
                          "Swedish - Deprecated"
                        ],
                        [
                          "sv.utf-8",
                          "Swedish with UTF-8"
                        ],
                        [
                          "tr",
                          "Turkish - Deprecated"
                        ],
                        [
                          "tr.utf-8",
                          "Turkish with UTF-8"
                        ],
                        [
                          "en-us",
                          "US English - Deprecated"
                        ],
                        [
                          "en-us.utf-8",
                          "US English with UTF-8"
                        ]
                      ],
                      "Required": false,
                      "Type": "string"
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/volumeGroups/{volumeGroupName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
accountName:
{
Description: The name of the NetApp account ,
Required: True ,
}
string ,
volumeGroupName:
{
Description: The name of the volumeGroup ,
Required: True ,
}
string ,
body:
{
Description: Volume Group object supplied in the body of the operation. ,
Required: True ,
}
{
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
zones:
{
Description: Availability Zone ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Volume group resource for create ,
}
{
properties:
{
Description: Volume group properties ,
Required: False ,
}
{
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
groupMetaData:
{
Description: Volume group details ,
Required: False ,
}
{
groupDescription:
{
Description: Group Description ,
Required: False ,
}
string ,
applicationType:
{
Description: Application Type ,
Enum:
{
SAP-HANA: No description available. ,
ORACLE: No description available. ,
}
,
Required: False ,
}
enum ,
applicationIdentifier:
{
Description: Application specific identifier ,
Required: False ,
}
string ,
globalPlacementRules:
{
Description: Application specific placement rules for the volume group ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
volumesCount:
{
Description: Number of volumes in volume group ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
volumes:
{
Description: List of volumes from group ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: Resource name ,
Required: False ,
}
string ,
type:
{
Description: Resource type ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
zones:
{
Description: Availability Zone ,
Required: False ,
}
[
string ,
]
,
properties:
{
Description: Volume properties ,
Required: True ,
}
{
fileSystemId:
{
Description: Unique FileSystem Identifier. ,
Required: False ,
}
string ,
creationToken:
{
Description: A unique file path for the volume. Used when creating mount targets ,
Required: True ,
}
string ,
serviceLevel:
{
Description: The service level of the file system ,
Enum:
{
Standard: Standard service level ,
Premium: Premium service level ,
Ultra: Ultra service level ,
StandardZRS: Zone redundant storage service level. This will be deprecated soon. ,
Flexible: Flexible service level ,
}
,
Required: False ,
}
enum ,
usageThreshold:
{
Description: Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. ,
Format: int64 ,
Required: True ,
}
integer ,
exportPolicy:
{
Description: Set of export policy rules ,
Required: False ,
}
{
rules:
{
Description: Export policy rule ,
Required: False ,
}
[
{
ruleIndex:
{
Description: Order index ,
Format: int32 ,
Required: False ,
}
integer ,
unixReadOnly:
{
Description: Read only access ,
Required: False ,
}
boolean ,
unixReadWrite:
{
Description: Read and write access ,
Required: False ,
}
boolean ,
kerberos5ReadOnly:
{
Description: Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5ReadWrite:
{
Description: Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadOnly:
{
Description: Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5iReadWrite:
{
Description: Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadOnly:
{
Description: Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
kerberos5pReadWrite:
{
Description: Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
cifs:
{
Description: Allows CIFS protocol ,
Required: False ,
}
boolean ,
nfsv3:
{
Description: Allows NFSv3 protocol. Enable only for NFSv3 type volumes ,
Required: False ,
}
boolean ,
nfsv41:
{
Description: Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes ,
Required: False ,
}
boolean ,
allowedClients:
{
Description: Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names ,
Required: False ,
}
string ,
hasRootAccess:
{
Description: Has root access to volume ,
Required: False ,
}
boolean ,
chownMode:
{
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. ,
Enum:
{
Restricted: No description available. ,
Unrestricted: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
protocolTypes:
{
Description: Set of protocol types, default NFSv3, CIFS for SMB protocol ,
Required: False ,
}
[
string ,
]
,
provisioningState:
{
Description: Azure lifecycle management ,
Required: False ,
}
string ,
snapshotId:
{
Description: Resource identifier used to identify the Snapshot. ,
Format: arm-id ,
Required: False ,
}
string ,
deleteBaseSnapshot:
{
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 ,
Required: False ,
}
boolean ,
backupId:
{
Description: Resource identifier used to identify the Backup. ,
Format: arm-id ,
Required: False ,
}
string ,
baremetalTenantId:
{
Description: Unique Baremetal Tenant Identifier. ,
Required: False ,
}
string ,
subnetId:
{
Description: The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes ,
Required: True ,
}
string ,
networkFeatures:
{
Description: The original value of the network features type available to the volume at the time it was created. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
effectiveNetworkFeatures:
{
Description: The effective value of the network features type available to the volume, or current effective state of update. ,
Enum:
{
Basic: Basic network features. ,
Standard: Standard network features. ,
Basic_Standard: Updating from Basic to Standard network features. ,
Standard_Basic: Updating from Standard to Basic network features. ,
}
,
Required: False ,
}
enum ,
networkSiblingSetId:
{
Description: Network Sibling Set ID for the the group of volumes sharing networking resources. ,
Required: False ,
}
string ,
storageToNetworkProximity:
{
Description: Provides storage to network proximity information for the volume. ,
Enum:
{
Default: Basic storage to network connectivity. ,
T1: Standard T1 storage to network connectivity. ,
T2: Standard T2 storage to network connectivity. ,
AcrossT2: Standard AcrossT2 storage to network connectivity. ,
}
,
Required: False ,
}
enum ,
mountTargets:
{
Description: List of mount targets ,
Required: False ,
}
[
{
mountTargetId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: False ,
}
string ,
fileSystemId:
{
Description: UUID v4 used to identify the MountTarget ,
Required: True ,
}
string ,
ipAddress:
{
Description: The mount target's IPv4 address ,
Required: False ,
}
string ,
smbServerFqdn:
{
Description: The SMB server's Fully Qualified Domain Name, FQDN ,
Required: False ,
}
string ,
}
,
]
,
volumeType:
{
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 ,
Required: False ,
}
string ,
dataProtection:
{
Description: DataProtection type volumes include an object containing details of the replication ,
Required: False ,
}
{
backup:
{
Description: Backup Properties ,
Required: False ,
}
{
backupPolicyId:
{
Description: Backup Policy Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
policyEnforced:
{
Description: Policy Enforced ,
Required: False ,
}
boolean ,
backupVaultId:
{
Description: Backup Vault Resource ID ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
replication:
{
Description: Replication properties ,
Required: False ,
}
{
replicationId:
{
Description: Id ,
Required: False ,
}
string ,
endpointType:
{
Description: Indicates whether the local volume is the source or destination for the Volume Replication ,
Enum:
{
src: No description available. ,
dst: No description available. ,
}
,
Required: False ,
}
enum ,
replicationSchedule:
{
Description: Schedule ,
Enum:
{
_10minutely: No description available. ,
hourly: No description available. ,
daily: No description available. ,
}
,
Required: False ,
}
enum ,
remoteVolumeResourceId:
{
Description: The resource ID of the remote volume. Required for cross region and cross zone replication ,
Required: False ,
}
string ,
remotePath:
{
Description: The full path to a volume that is to be migrated into ANF. Required for Migration volumes ,
Required: False ,
}
{
externalHostName:
{
Description: The Path to a ONTAP Host ,
Required: True ,
}
string ,
serverName:
{
Description: The name of a server on the ONTAP Host ,
Required: True ,
}
string ,
volumeName:
{
Description: The name of a volume on the server ,
Required: True ,
}
string ,
}
,
remoteVolumeRegion:
{
Description: The remote region for the other end of the Volume Replication. ,
Required: False ,
}
string ,
destinationReplications:
{
Description: A list of destination replications ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource ID of the remote volume ,
Format: arm-id ,
Required: False ,
}
string ,
replicationType:
{
Description: Indicates whether the replication is cross zone or cross region. ,
Enum:
{
CrossRegionReplication: Cross region replication ,
CrossZoneReplication: Cross zone replication ,
}
,
Required: False ,
}
enum ,
region:
{
Description: The remote region for the destination volume. ,
Required: False ,
}
string ,
zone:
{
Description: The remote zone for the destination volume. ,
Required: False ,
}
string ,
}
,
]
,
}
,
snapshot:
{
Description: Snapshot properties. ,
Required: False ,
}
{
snapshotPolicyId:
{
Description: Snapshot Policy ResourceId ,
Required: False ,
}
string ,
}
,
volumeRelocation:
{
Description: VolumeRelocation properties ,
Required: False ,
}
{
relocationRequested:
{
Description: Has relocation been requested for this volume ,
Required: False ,
}
boolean ,
readyToBeFinalized:
{
Description: Has relocation finished and is ready to be cleaned up ,
Required: False ,
}
boolean ,
}
,
}
,
acceptGrowCapacityPoolForShortTermCloneSplit:
{
Description: While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted. ,
Enum:
{
Accepted: Auto grow capacity pool for short term clone split is accepted. ,
Declined: Auto grow capacity pool for short term clone split is declined. Short term clone volume creation will not be allowed, to create short term clone volume accept auto grow capacity pool. ,
}
,
Required: False ,
}
enum ,
isRestoring:
{
Description: Restoring ,
Required: False ,
}
boolean ,
snapshotDirectoryVisible:
{
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). ,
Required: False ,
}
boolean ,
kerberosEnabled:
{
Description: Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later ,
Required: False ,
}
boolean ,
securityStyle:
{
Description: The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol ,
Enum:
{
ntfs: No description available. ,
unix: No description available. ,
}
,
Required: False ,
}
enum ,
smbEncryption:
{
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 ,
Required: False ,
}
boolean ,
smbAccessBasedEnumeration:
{
Description: Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbAccessBasedEnumeration share setting is disabled ,
Enabled: smbAccessBasedEnumeration share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbNonBrowsable:
{
Description: Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume ,
Enum:
{
Disabled: smbNonBrowsable share setting is disabled ,
Enabled: smbNonBrowsable share setting is enabled ,
}
,
Required: False ,
}
enum ,
smbContinuouslyAvailable:
{
Description: Enables continuously available share property for smb volume. Only applicable for SMB volume ,
Required: False ,
}
boolean ,
throughputMibps:
{
Description: Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume ,
Format: float ,
Required: False ,
}
number ,
actualThroughputMibps:
{
Description: Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel ,
Format: float ,
Required: False ,
}
number ,
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' ,
Enum:
{
Microsoft.NetApp: Microsoft-managed key encryption ,
Microsoft.KeyVault: Customer-managed key encryption ,
}
,
Required: False ,
}
enum ,
keyVaultPrivateEndpointResourceId:
{
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'. ,
Required: False ,
}
string ,
ldapEnabled:
{
Description: Specifies whether LDAP is enabled or not for a given NFS volume. ,
Required: False ,
}
boolean ,
coolAccess:
{
Description: Specifies whether Cool Access(tiering) is enabled for the volume. ,
Required: False ,
}
boolean ,
coolnessPeriod:
{
Description: Specifies the number of days after which data that is not accessed by clients will be tiered. ,
Format: int32 ,
Required: False ,
}
integer ,
coolAccessRetrievalPolicy:
{
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: No description available. ,
OnRead: No description available. ,
Never: No description available. ,
}
,
Required: False ,
}
enum ,
coolAccessTieringPolicy:
{
Description: coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. ,
Enum:
{
Auto: No description available. ,
SnapshotOnly: No description available. ,
}
,
Required: False ,
}
enum ,
unixPermissions:
{
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. ,
Required: False ,
}
string ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
fileAccessLogs:
{
Description: Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. ,
Enum:
{
Enabled: fileAccessLogs are enabled ,
Disabled: fileAccessLogs are not enabled ,
}
,
Required: False ,
}
enum ,
avsDataStore:
{
Description: Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose ,
Enum:
{
Enabled: avsDataStore is enabled ,
Disabled: avsDataStore is disabled ,
}
,
Required: False ,
}
enum ,
dataStoreResourceId:
{
Description: Data store resource unique identifier ,
Required: False ,
}
[
string ,
]
,
isDefaultQuotaEnabled:
{
Description: Specifies if default quota is enabled for the volume. ,
Required: False ,
}
boolean ,
defaultUserQuotaInKiBs:
{
Description: Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . ,
Format: int64 ,
Required: False ,
}
integer ,
defaultGroupQuotaInKiBs:
{
Description: Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. ,
Format: int64 ,
Required: False ,
}
integer ,
maximumNumberOfFiles:
{
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. ,
Format: int64 ,
Required: False ,
}
integer ,
volumeGroupName:
{
Description: Volume Group Name ,
Required: False ,
}
string ,
capacityPoolResourceId:
{
Description: Pool Resource Id used in case of creating a volume through volume group ,
Required: False ,
}
string ,
proximityPlacementGroup:
{
Description: Proximity placement group associated with the volume ,
Required: False ,
}
string ,
t2Network:
{
Description: T2 network information ,
Required: False ,
}
string ,
volumeSpecName:
{
Description: Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log ,
Required: False ,
}
string ,
encrypted:
{
Description: Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. ,
Required: False ,
}
boolean ,
placementRules:
{
Description: Application specific placement rules for the particular volume ,
Required: False ,
}
[
{
key:
{
Description: Key for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
value:
{
Description: Value for an application specific parameter for the placement of volumes in the volume group ,
Required: True ,
}
string ,
}
,
]
,
enableSubvolumes:
{
Description: Flag indicating whether subvolume operations are enabled on the volume ,
Enum:
{
Enabled: subvolumes are enabled ,
Disabled: subvolumes are not enabled ,
}
,
Required: False ,
}
enum ,
provisionedAvailabilityZone:
{
Description: The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. ,
Required: False ,
}
string ,
isLargeVolume:
{
Description: Specifies whether volume is a Large Volume or Regular Volume. ,
Required: False ,
}
boolean ,
originatingResourceId:
{
Description: Id of the snapshot or backup that the volume is restored from. ,
Required: False ,
}
string ,
inheritedSizeInBytes:
{
Description: Space shared by short term clone volume with parent volume in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
location:
{
Description: Resource location ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}