az netappfiles volume
Note
This reference is part of the netappfiles-preview extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az netappfiles volume command. Learn more about extensions.
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage Azure NetApp Files (ANF) Volume Resources.
Create update delete operations for Azure NetApp Files Volumes.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az netappfiles volume create |
Create or Update a volume. |
Extension | Preview |
| az netappfiles volume latest-backup-status |
Get the latest backup status of a volume. |
Extension | Preview |
| az netappfiles volume latest-backup-status current |
Get the latest backup status of the current volume. |
Extension | Preview |
| az netappfiles volume latest-backup-status current show |
Get the latest status of the backup for a volume. |
Extension | Preview |
| az netappfiles volume list |
List all volumes within the capacity pool. |
Extension | Preview |
| az netappfiles volume migrate-backup |
Migrate the backups under volume to backup vault. |
Extension | Preview |
| az netappfiles volume show |
Get the details of the specified volume. |
Extension | Preview |
| az netappfiles volume update |
Update the specified volume within the capacity pool. |
Extension | Preview |
| az netappfiles volume wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az netappfiles volume create
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Create or Update a volume.
Create the specified volume within the capacity pool.
az netappfiles volume create --account-name
--creation-token
--name
--pool-name
--resource-group
--subnet
--vnet
[--avs-data-store {Disabled, Enabled}]
[--backup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--backup-id]
[--backup-policy-id]
[--backup-vault-id]
[--capacity-pool-resource-id]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--default-group-quota]
[--default-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--default-user-quota]
[--delete-base-snapshot {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-subvolumes {Disabled, Enabled}]
[--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
[--endpoint-type {dst, src}]
[--is-large-volume {0, 1, f, false, n, no, t, true, y, yes}]
[--is-restoring {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--key-vault-private-endpoint-resource-id]
[--ldap-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--location]
[--network-features {Basic, Standard}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--placement-rules]
[--policy-enforced {0, 1, f, false, n, no, t, true, y, yes}]
[--ppg]
[--protocol-types]
[--relocation-requested {0, 1, f, false, n, no, t, true, y, yes}]
[--remote-volume-id]
[--remote-volume-region]
[--replication-id]
[--replication-schedule {_10minutely, daily, hourly}]
[--rules]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-ca {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-non-browsable {Disabled, Enabled}]
[--snapshot-dir-visible {0, 1, f, false, n, no, t, true, y, yes}]
[--snapshot-id]
[--snapshot-policy-id]
[--tags]
[--throughput-mibps]
[--unix-permissions]
[--usage-threshold]
[--volume-spec-name]
[--volume-type]
[--zones]Examples
Create an ANF volume
az netappfiles volume create -g group --account-name aname --pool-name pname --volume-name vname -l location --service-level "Premium" --usage-threshold 107374182400 --creation-token "unique-token" --protocol-types NFSv3 --vnet myvnet --subnet-id "/subscriptions/mysubsid/resourceGroups/myrg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/default" --rules "[{allowed_clients:'0.0.0.0/0',rule_index:1,unix_read_only:true,unix_read_write:false,cifs:false,nfsv3:true,nfsv41:false}]"Required Parameters
The name of the NetApp account.
A unique file path for the volume. Used when creating mount targets.
The name of the volume.
The name of the capacity pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.
Name or Resource ID of the vnet. If you want to use a vnet in other resource group or subscription, please provide the Resource ID instead of the name of the vnet.
Optional Parameters
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
Backup Enabled.
UUID v4 or resource identifier used to identify the Backup.
Backup Policy Resource ID.
Backup Vault Resource ID.
Pool Resource Id used in case of creating a volume through volume group.
Specifies whether Cool Access(tiering) is enabled for the volume.
Specifies the number of days after which data that is not accessed by clients will be tiered.
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
Specifies if default quota is enabled for the volume.
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.
Flag indicating whether subvolume operations are enabled on the volume.
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'.
Indicates whether the local volume is the source or destination for the Volume Replication.
Specifies whether volume is a Large Volume or Regular Volume.
Restoring.
Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
Specifies whether LDAP is enabled or not for a given NFS volume.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Basic network, or Standard features available to the volume.
Do not wait for the long-running operation to finish.
Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Policy Enforced.
Proximity placement group associated with the volume.
Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Has relocation been requested for this volume.
The resource ID of the remote volume.
The remote region for the other end of the Volume Replication.
Id.
Schedule.
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
ServiceLevel.
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.
Enables continuously available share property for smb volume. Only applicable for SMB volume.
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.
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).
UUID v4 or resource identifier used to identify the Snapshot.
Snapshot Policy ResourceId.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
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.
Maximum storage quota allowed for a file system in bytes.
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.
Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az netappfiles volume list
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
List all volumes within the capacity pool.
az netappfiles volume list --account-name
--pool-name
--resource-group
[--max-items]
[--next-token]Required Parameters
The name of the NetApp account.
The name of the capacity pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az netappfiles volume migrate-backup
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Migrate the backups under volume to backup vault.
az netappfiles volume migrate-backup --backup-vault-id
[--account-name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--volume-name]Required Parameters
The ResourceId of the Backup Vault.
Optional Parameters
The name of the NetApp account.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
The name of the capacity pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the volume.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az netappfiles volume show
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Get the details of the specified volume.
az netappfiles volume show [--account-name]
[--ids]
[--name]
[--pool-name]
[--resource-group]
[--subscription]Optional Parameters
The name of the NetApp account.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the volume.
The name of the capacity pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az netappfiles volume update
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Update the specified volume within the capacity pool.
az netappfiles volume update [--account-name]
[--add]
[--avs-data-store {Disabled, Enabled}]
[--backup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--backup-policy-id]
[--backup-vault-id]
[--capacity-pool-resource-id]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--creation-token]
[--default-group-quota]
[--default-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--default-user-quota]
[--delete-base-snapshot {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-subvolumes {Disabled, Enabled}]
[--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
[--endpoint-type {dst, src}]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--is-large-volume {0, 1, f, false, n, no, t, true, y, yes}]
[--is-restoring {0, 1, f, false, n, no, t, true, y, yes}]
[--key-vault-private-endpoint-resource-id]
[--ldap-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--name]
[--network-features {Basic, Standard}]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--placement-rules]
[--policy-enforced {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--ppg]
[--protocol-types]
[--relocation-requested {0, 1, f, false, n, no, t, true, y, yes}]
[--remote-volume-id]
[--remote-volume-region]
[--remove]
[--replication-id]
[--replication-schedule {_10minutely, daily, hourly}]
[--resource-group]
[--rules]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--set]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-ca {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-encryption {0, 1, f, false, n, no, t, true, y, yes}]
[--smb-non-browsable {Disabled, Enabled}]
[--snapshot-dir-visible {0, 1, f, false, n, no, t, true, y, yes}]
[--snapshot-policy-id]
[--subnet]
[--subscription]
[--tags]
[--throughput-mibps]
[--unix-permissions]
[--usage-threshold]
[--vnet]
[--volume-spec-name]
[--volume-type]Optional Parameters
The name of the NetApp account.
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.
Backup Enabled.
Backup Policy Resource ID.
Backup Vault Resource ID.
Pool Resource Id used in case of creating a volume through volume group.
Specifies whether Cool Access(tiering) is enabled for the volume.
Specifies the number of days after which data that is not accessed by clients will be tiered.
A unique file path for the volume. Used when creating mount targets.
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
Specifies if default quota is enabled for the volume.
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.
Flag indicating whether subvolume operations are enabled on the volume.
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'.
Indicates whether the local volume is the source or destination for the Volume Replication.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Specifies whether volume is a Large Volume or Regular Volume.
Restoring.
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
Specifies whether LDAP is enabled or not for a given NFS volume.
The name of the volume.
Basic network, or Standard features available to the volume.
Do not wait for the long-running operation to finish.
Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Policy Enforced.
The name of the capacity pool.
Proximity placement group associated with the volume.
Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Has relocation been requested for this volume.
The resource ID of the remote volume.
The remote region for the other end of the Volume Replication.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Id.
Schedule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.
ServiceLevel.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.
Enables continuously available share property for smb volume. Only applicable for SMB volume.
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.
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).
Snapshot Policy ResourceId.
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume.
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.
Maximum storage quota allowed for a file system in bytes.
Name or Resource ID of the vnet. If you want to use a vnet in other resource group or subscription, please provide the Resource ID instead of the name of the vnet.
Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.
What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az netappfiles volume wait
Command group 'az netappfiles' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition is met.
az netappfiles volume wait [--account-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--pool-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Optional Parameters
The name of the NetApp account.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
The name of the volume.
The name of the capacity pool.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for