az netappfiles volume
Note
This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.
Manage Azure NetApp Files (ANF) Volume Resources.
Generated Create update delete operations for Azure NetApp Files (ANF) Volumes.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az netappfiles volume backup |
Manage Azure NetApp Files (ANF) Volume Backup Resources. |
Core | GA |
| az netappfiles volume backup create |
Create a backup for the volume. |
Core | GA |
| az netappfiles volume backup delete |
Delete a backup of the volume. |
Core | GA |
| az netappfiles volume backup list |
List all backups for a volume. |
Core | GA |
| az netappfiles volume backup restore-files |
Restore the specified files from the specified backup to the active filesystem. |
Core | GA |
| az netappfiles volume backup restore-status |
Get volume's restore status. |
Core | GA |
| az netappfiles volume backup show |
Get the specified backup of the volume. |
Core | GA |
| az netappfiles volume backup status |
Get the status of the backup for a volume. |
Core | GA |
| az netappfiles volume backup update |
Update a backup for the volume. |
Core | GA |
| az netappfiles volume backup wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az netappfiles volume break-file-locks |
Break all the file locks on a volume. |
Core | GA |
| az netappfiles volume create |
Create or Update a volume. |
Core | GA |
| az netappfiles volume create (netappfiles-preview extension) |
Create or Update a volume. |
Extension | Preview |
| az netappfiles volume delete |
Delete the specified volume. |
Core | GA |
| az netappfiles volume export-policy |
Manage Azure NetApp Files (ANF) Volume export policies. |
Core | GA |
| az netappfiles volume export-policy add |
Add a new rule to the export policy for a volume. |
Core | GA |
| az netappfiles volume export-policy list |
List the export policy rules for a volume. |
Core | GA |
| az netappfiles volume export-policy remove |
Remove a rule from the export policy for a volume by rule index. The current rules can be obtained by performing the subgroup list command. |
Core | GA |
| az netappfiles volume export-policy show |
Show the export policy rule for a volume. |
Core | GA |
| az netappfiles volume export-policy update |
Update the export policy rule for a volume. |
Core | GA |
| az netappfiles volume export-policy wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az netappfiles volume finalize-relocation |
Finalizes the relocation of the volume and cleans up the old volume. |
Core | GA |
| az netappfiles volume get-groupid-list-for-ldapuser |
Returns the list of group Ids for a specific LDAP User. |
Core | GA |
| az netappfiles volume latest-backup-status |
Get the latest backup status of a volume. |
Core and Extension | Preview |
| az netappfiles volume latest-backup-status current |
Get the latest backup status of the current volume. |
Core and Extension | Preview |
| az netappfiles volume latest-backup-status current show |
Get the latest status of the backup for a volume. |
Core | Preview |
| az netappfiles volume latest-backup-status current show (netappfiles-preview extension) |
Get the latest status of the backup for a volume. |
Extension | Preview |
| az netappfiles volume list |
List all volumes within the capacity pool. |
Core | GA |
| az netappfiles volume list (netappfiles-preview extension) |
List all volumes within the capacity pool. |
Extension | Preview |
| az netappfiles volume migrate-backup |
Migrate the backups under volume to backup vault. |
Core | Preview |
| az netappfiles volume migrate-backup (netappfiles-preview extension) |
Migrate the backups under volume to backup vault. |
Extension | Preview |
| az netappfiles volume pool-change |
Moves volume to another pool. |
Core | GA |
| az netappfiles volume populate-availability-zone |
This operation will populate availability zone information for a volume. |
Core | GA |
| az netappfiles volume quota-rule |
Manage Azure NetApp Files (ANF) Volume Quota Rules Resources. |
Core | GA |
| az netappfiles volume quota-rule create |
Create the specified quota rule within the given volume. |
Core | GA |
| az netappfiles volume quota-rule delete |
Delete quota rule. |
Core | GA |
| az netappfiles volume quota-rule list |
List all quota rules associated with the volume. |
Core | GA |
| az netappfiles volume quota-rule show |
Get details of the specified quota rule. |
Core | GA |
| az netappfiles volume quota-rule update |
Update the specified quota rule within the given volume. |
Core | GA |
| az netappfiles volume quota-rule wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
| az netappfiles volume relocate |
Relocates volume to a new stamp. |
Core | GA |
| az netappfiles volume replication |
Manage Azure NetApp Files (ANF) Volume replication. |
Core | GA |
| az netappfiles volume replication approve |
Authorize source volume replication. |
Core | GA |
| az netappfiles volume replication list |
List all replications for a specified volume. |
Core | GA |
| az netappfiles volume replication re-initialize |
Re-Initializes the replication connection on the destination volume. |
Core | GA |
| az netappfiles volume replication reestablish |
Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots. |
Core | GA |
| az netappfiles volume replication remove |
Delete the replication connection on the destination volume, and send release to the source replication. |
Core | GA |
| az netappfiles volume replication resume |
Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source. |
Core | GA |
| az netappfiles volume replication status |
Get the status of the replication. |
Core | GA |
| az netappfiles volume replication suspend |
Suspend/Break the replication connection on the destination volume. |
Core | GA |
| az netappfiles volume reset-cifs-pw |
Reset cifs password from volume. |
Core | GA |
| az netappfiles volume revert |
Revert a volume to the snapshot specified in the body. |
Core | GA |
| az netappfiles volume revert-relocation |
Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume. |
Core | GA |
| az netappfiles volume show |
Get the details of the specified volume. |
Core | GA |
| az netappfiles volume show (netappfiles-preview extension) |
Get the details of the specified volume. |
Extension | Preview |
| az netappfiles volume update |
Update the specified volume within the capacity pool. |
Core | GA |
| az netappfiles volume update (netappfiles-preview extension) |
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. |
Core | GA |
| az netappfiles volume wait (netappfiles-preview extension) |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az netappfiles volume break-file-locks
Break all the file locks on a volume.
az netappfiles volume break-file-locks [--account-name]
[--client-ip]
[--confirm {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--yes]Examples
Break all the file locks on the volume
az netappfiles volume break-file-locks -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional Parameters
The name of the NetApp account.
To clear file locks on a volume for a particular client.
Break-file-locks could be a disruptive operation for application as locks on the volume will be broken, if want to process, set to true.
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.
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.
Do not prompt for confirmation.
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 create
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
[--allowed-clients]
[--avs-data-store {Disabled, Enabled}]
[--backup-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--backup-id]
[--backup-policy-id]
[--ca-retrieval-policy {Default, Never, OnRead}]
[--capacity-pool-resource-id]
[--chown-mode {Restricted, Unrestricted}]
[--cifs {0, 1, f, false, n, no, t, true, y, yes}]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--default-group-quota]
[--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}]
[--export-policy-rules]
[--has-root-access {0, 1, f, false, n, no, t, true, y, yes}]
[--is-def-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--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}]
[--kerberos5-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5i-rw {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-r {0, 1, f, false, n, no, t, true, y, yes}]
[--kerberos5p-rw {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, Basic_Standard, Standard, Standard_Basic}]
[--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-path]
[--remote-volume-id]
[--remote-volume-region]
[--replication-schedule {_10minutely, daily, hourly}]
[--rule-index]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-continuously-available {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]
[--subnet]
[--tags]
[--throughput-mibps]
[--unix-permissions]
[--unix-read-only {0, 1, f, false, n, no, t, true, y, yes}]
[--unix-read-write {0, 1, f, false, n, no, t, true, y, yes}]
[--usage-threshold]
[--vnet]
[--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"}]'Create an ANF volume with zones (Availability Zone) specified
az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --zones zone1Create an ANF volume with CMK Encryption
az netappfiles volume create -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname -l westus2 --service-level premium --usage-threshold 100 --file-path "unique-file-path" --vnet myvnet --subnet mysubnet --protocol-types NFSv3 --network-features Standard --protocol-types NFSv4.1 --rule-index 1 --allowed-clients '10.7.0.0/24' --kerberos-enabled false --encryption-key-source Microsoft.KeyVault --kv-private-endpoint-id myPrivateEndpointIdRequired 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>.
Optional Parameters
Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
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.
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.
Pool Resource Id used in case of creating a volume through volume group.
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. Possible values include- Restricted, Unrestricted. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Allows CIFS protocol. Enable only for CIFS type volumes. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
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.
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.
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Has root access to volume. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Specifies if default quota is enabled for the volume.
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.
Kerberos5 Read only access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Kerberos5 Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Kerberos5i Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Kerberos5i Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Kerberos5p Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
Kerberos5p Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
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 full path to a volume that is to be migrated into ANF. Required for Migration volumes Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource ID of the remote volume.
The remote region for the other end of the Volume Replication.
Schedule.
Order index. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
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.
The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.
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.
Read only access. Exists for backwards compatibility, please use --export-policy-rules (--rules) instead.
Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.
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, 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.
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 create (netappfiles-preview extension)
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 delete
Delete the specified volume.
az netappfiles volume delete [--account-name]
[--force-delete {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
Delete an ANF volume
az netappfiles volume delete -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional Parameters
The name of the NetApp account.
An option to force delete the volume. Will cleanup resources connected to the particular volume.
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.
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.
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 finalize-relocation
Finalizes the relocation of the volume and cleans up the old volume.
az netappfiles volume finalize-relocation [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
Finalizes the relocation of the volume and cleans up the old volume
az netappfiles volume finalize-relocation -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional 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.
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.
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 get-groupid-list-for-ldapuser
Returns the list of group Ids for a specific LDAP User.
az netappfiles volume get-groupid-list-for-ldapuser --username
[--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
Get Group Id List for LDAP User myuser
az netappfiles volume get-groupid-list-for-ldapuser -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --username myuserRequired Parameters
Username is required to fetch the group to which user is part of.
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.
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.
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
List all volumes within the capacity pool.
az netappfiles volume list --account-name
--pool-name
--resource-group
[--max-items]
[--next-token]Examples
List all subvolumes of a ANF volume
az netappfiles subvolume list -g mygroup --account-name myaccountname --pool-name mypoolname --volume-name myvolumenameRequired 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 list (netappfiles-preview extension)
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
This command 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 migrate-backup (netappfiles-preview extension)
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 pool-change
Moves volume to another pool.
az netappfiles volume pool-change --new-pool-resource-id
[--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
This changes (moves) the pool for the volume myvolname from mypoolname to pool with the Id mynewresourceid
az netappfiles volume pool-change -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --new-pool-resource-id mynewresourceidRequired Parameters
Resource id of the pool to move volume to.
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.
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.
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 populate-availability-zone
This operation will populate availability zone information for a volume.
az netappfiles volume populate-availability-zone [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
This operation will populate availability zone information for volume myvolname
az netappfiles volume populate-availability-zone -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional 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.
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.
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 relocate
Relocates volume to a new stamp.
az netappfiles volume relocate [--account-name]
[--creation-token]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
Relocates volume to a new stamp
az netappfiles volume relocate -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional Parameters
The name of the NetApp account.
New creation token for the volume that controls the mount point name.
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.
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.
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 reset-cifs-pw
Reset cifs password from volume.
az netappfiles volume reset-cifs-pw [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]Examples
Reset the CIFS password for volume
az netappfiles volume reset-cifs-pw -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional 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.
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.
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 revert
Revert a volume to the snapshot specified in the body.
az netappfiles volume revert [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--snapshot-id]
[--subscription]Examples
Revert a volume to one of its snapshots
az netappfiles volume revert -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --snapshot-id 9760acf5-4638-11e7-9bdb-020073ca3333Optional 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.
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>.
Resource id of the snapshot.
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 revert-relocation
Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.
az netappfiles volume revert-relocation [--account-name]
[--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--pool-name]
[--resource-group]
[--subscription]
[--yes]Examples
Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume
az netappfiles volume revert-relocation -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional 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.
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.
Do not prompt for confirmation.
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
Get the details of the specified volume.
az netappfiles volume show [--account-name]
[--ids]
[--name]
[--pool-name]
[--resource-group]
[--subscription]Examples
Returns the properties of the given ANF volume
az netappfiles volume show -g mygroup --account-name myaccname --pool-name mypoolname --name myvolnameOptional 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 show (netappfiles-preview extension)
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
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]
[--ca-retrieval-policy {Default, Never, OnRead}]
[--capacity-pool-resource-id]
[--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
[--coolness-period]
[--creation-token]
[--default-group-quota]
[--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}]
[--export-policy-rules]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--is-def-quota-enabled {0, 1, f, false, n, no, t, true, y, yes}]
[--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, Basic_Standard, Standard, Standard_Basic}]
[--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-schedule {_10minutely, daily, hourly}]
[--resource-group]
[--security-style {ntfs, unix}]
[--service-level {Premium, Standard, StandardZRS, Ultra}]
[--set]
[--smb-access-based-enumeration {Disabled, Enabled}]
[--smb-continuously-available {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]Examples
Update an ANF volume
az netappfiles volume update -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --service-level ultra --usage-threshold 100 --tags mytag=specialvolOptional 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.
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.
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.
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.
Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 if default quota is enabled for the volume.
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.
Schedule.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 update (netappfiles-preview extension)
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
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.
az netappfiles volume wait (netappfiles-preview extension)
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