az netappfiles volume

Reference

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 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 delete (netappfiles-preview extension)	Delete the specified volume.	Extension	Preview
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	GA
az netappfiles volume latest-backup-status current	Get the latest backup status of the current volume.	Core and Extension	GA
az netappfiles volume latest-backup-status current show	Get the latest status of the backup for a volume.	Core	GA
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 latest-restore-status	Get the latest backup status of a volume.	Core	GA
az netappfiles volume latest-restore-status current	Get the latest restore status of a volume.	Core	GA
az netappfiles volume latest-restore-status current show	Get the latest status of the restore for a volume.	Core	GA
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 list-quota-report	Returns report of quotas for the volume.	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 splitclonefromparent	Split operation to convert clone volume to an independent 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	GA

az netappfiles volume break-file-locks

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--client-ip

To clear file locks on a volume for a particular client.

--confirm --confirm-running-disruptive-operation

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.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: True

--ids

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.

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume create

Edit

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-id]
                             [--backup-policy-id]
                             [--backup-vault-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-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}]
                             [--export-policy-rules]
                             [--has-root-access {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, 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-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 100 --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 zone1

Create 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 myPrivateEndpointId

Required Parameters

--account-name -a

The name of the NetApp account.

--creation-token --file-path

A unique file path for the volume. Used when creating mount targets.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--allowed-clients

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.

--avs-data-store

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Accepted values: Disabled, Enabled

Default value: Disabled

--backup-id

Resource identifier used to identify the Backup.

--backup-policy-id

Backup Policy Resource ID.

--backup-vault-id

Backup Vault Resource ID.

--ca-retrieval-policy --cool-access-retrieval-policy

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.

Accepted values: Default, Never, OnRead

--capacity-pool-resource-id --pool-resource-id

Pool Resource Id used in case of creating a volume through volume group.

--chown-mode

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.

Accepted values: Restricted, Unrestricted

--cifs

Allows CIFS protocol. Enable only for CIFS type volumes. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--cool-access

Specifies whether Cool Access(tiering) is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--coolness-period

Specifies the number of days after which data that is not accessed by clients will be tiered.

--default-group-quota --default-group-quota-in-ki-bs

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Default value: 0

--default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled

Specifies if default quota is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--default-user-quota --default-user-quota-in-ki-bs

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

Default value: 0

--delete-base-snapshot

If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enable-subvolumes

Flag indicating whether subvolume operations are enabled on the volume.

Accepted values: Disabled, Enabled

Default value: Disabled

--encryption-key-source

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'.

Accepted values: Microsoft.KeyVault, Microsoft.NetApp

Default value: Microsoft.NetApp

--endpoint-type

Indicates whether the local volume is the source or destination for the Volume Replication.

Accepted values: dst, src

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--has-root-access

Has root access to volume. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--is-large-volume

Specifies whether volume is a Large Volume or Regular Volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--is-restoring

Restoring.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos-enabled

Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--kerberos5-r

Kerberos5 Read only access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5-rw

Kerberos5 Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-r

Kerberos5i Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-rw

Kerberos5i Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-r

Kerberos5p Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-rw

Kerberos5p Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

--ldap-enabled

Specifies whether LDAP is enabled or not for a given NFS volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--network-features

Basic network, or Standard features available to the volume.

Accepted values: Basic, Standard

Default value: Basic

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--placement-rules

Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-enforced

Policy Enforced.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ppg --proximity-placement-group

Proximity placement group associated with the volume.

--protocol-types

Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--relocation-requested

Has relocation been requested for this volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remote-volume-id --remote-volume-resource-id

The resource ID of the remote volume.

--remote-volume-region

The remote region for the other end of the Volume Replication.

--replication-schedule

Schedule.

Accepted values: _10minutely, daily, hourly

--rule-index

Order index. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

--security-style

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Accepted values: ntfs, unix

Default value: unix

--service-level

ServiceLevel.

Accepted values: Premium, Standard, StandardZRS, Ultra

Default value: Premium

--smb-access-based-enumeration --smb-access-enumeration

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--smb-continuously-available --smb-continuously-avl

Enables continuously available share property for smb volume. Only applicable for SMB volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--smb-non-browsable

Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--snapshot-dir-visible --snapshot-directory-visible

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).

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: True

--snapshot-id

Resource identifier used to identify the Snapshot.

--snapshot-policy-id

Snapshot Policy ResourceId.

--subnet --subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

Default value: default

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throughput-mibps

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

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.

--unix-read-only

Read only access. Exists for backwards compatibility, please use --export-policy-rules (--rules) instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--unix-read-write

Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--usage-threshold

Maximum storage quota allowed for a file system in GiB.

Default value: 100

--vnet

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

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

--volume-type

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.

--zones

Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume create (netappfiles-preview extension)

Preview

This command 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
                             --vnet
                             [--accept-grow-capacity-pool-for-short-term-clone-split {Accepted, Declined}]
                             [--allowed-clients]
                             [--avs-data-store {Disabled, Enabled}]
                             [--backup-id]
                             [--backup-policy-id]
                             [--backup-vault-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-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}]
                             [--export-policy-rules]
                             [--has-root-access {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]
                             [--language {ar, ar.utf-8, c, c.utf-8, cs, cs.utf-8, da, da.utf-8, de, de.utf-8, en, en-us, en-us.utf-8, en.utf-8, es, es.utf-8, fi, fi.utf-8, fr, fr.utf-8, he, he.utf-8, hr, hr.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ja-jp.pck.utf-8, ja-v1, ja-v1.utf-8, ja.utf-8, ko, ko.utf-8, nl, nl.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, ro, ro.utf-8, ru, ru.utf-8, sk, sk.utf-8, sl, sl.utf-8, sv, sv.utf-8, tr, tr.utf-8, utf8mb4, zh, zh-tw, zh-tw.big5, zh-tw.big5.utf-8, zh-tw.utf-8, zh.gbk, zh.gbk.utf-8, zh.utf-8}]
                             [--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-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-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]
                             [--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]
                             [--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 100 --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 zone1

Create 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 myPrivateEndpointId

Required Parameters

--account-name -a

The name of the NetApp account.

--creation-token --file-path

A unique file path for the volume. Used when creating mount targets.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--vnet

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

--accept-grow-capacity-pool-for-short-term-clone-split --grow-pool-clone-split

While auto splitting the short term clone volume, if the parent pool does not have enough space to accommodate the volume after split, it will be automatically resized, which will lead to increased billing. To accept capacity pool size auto grow and create a short term clone volume, set the property as accepted.

Accepted values: Accepted, Declined

--allowed-clients

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.

--avs-data-store

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Accepted values: Disabled, Enabled

Default value: Disabled

--backup-id

Resource identifier used to identify the Backup.

--backup-policy-id

Backup Policy Resource ID.

--backup-vault-id

Backup Vault Resource ID.

--ca-retrieval-policy --cool-access-retrieval-policy

Accepted values: Default, Never, OnRead

--capacity-pool-resource-id --pool-resource-id

Pool Resource Id used in case of creating a volume through volume group.

--chown-mode

Accepted values: Restricted, Unrestricted

--cifs

Allows CIFS protocol. Enable only for CIFS type volumes. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--cool-access

Specifies whether Cool Access(tiering) is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--coolness-period

Specifies the number of days after which data that is not accessed by clients will be tiered.

--default-group-quota --default-group-quota-in-ki-bs

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Default value: 0

--default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled

Specifies if default quota is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--default-user-quota --default-user-quota-in-ki-bs

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

Default value: 0

--delete-base-snapshot

If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enable-subvolumes

Flag indicating whether subvolume operations are enabled on the volume.

Accepted values: Disabled, Enabled

Default value: Disabled

--encryption-key-source

Accepted values: Microsoft.KeyVault, Microsoft.NetApp

Default value: Microsoft.NetApp

--endpoint-type

Indicates whether the local volume is the source or destination for the Volume Replication.

Accepted values: dst, src

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--has-root-access

Has root access to volume. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--is-large-volume

Specifies whether volume is a Large Volume or Regular Volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--is-restoring

Restoring.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos-enabled

Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--kerberos5-r

Kerberos5 Read only access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5-rw

Kerberos5 Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-r

Kerberos5i Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5i-rw

Kerberos5i Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-r

Kerberos5p Readonly access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--kerberos5p-rw

Kerberos5p Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

--language

Language.

Accepted values: ar, ar.utf-8, c, c.utf-8, cs, cs.utf-8, da, da.utf-8, de, de.utf-8, en, en-us, en-us.utf-8, en.utf-8, es, es.utf-8, fi, fi.utf-8, fr, fr.utf-8, he, he.utf-8, hr, hr.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ja-jp.pck.utf-8, ja-v1, ja-v1.utf-8, ja.utf-8, ko, ko.utf-8, nl, nl.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, ro, ro.utf-8, ru, ru.utf-8, sk, sk.utf-8, sl, sl.utf-8, sv, sv.utf-8, tr, tr.utf-8, utf8mb4, zh, zh-tw, zh-tw.big5, zh-tw.big5.utf-8, zh-tw.utf-8, zh.gbk, zh.gbk.utf-8, zh.utf-8

--ldap-enabled

Specifies whether LDAP is enabled or not for a given NFS volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--network-features

Basic network, or Standard features available to the volume.

Accepted values: Basic, Standard

Default value: Basic

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--placement-rules

Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-enforced

Policy Enforced.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ppg --proximity-placement-group

Proximity placement group associated with the volume.

--protocol-types

Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--relocation-requested

Has relocation been requested for this volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remote-path

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.

--remote-volume-id --remote-volume-resource-id

The resource ID of the remote volume.

--remote-volume-region

The remote region for the other end of the Volume Replication.

--replication-schedule

Schedule.

Accepted values: _10minutely, daily, hourly

--rule-index

Order index. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

--security-style

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Accepted values: ntfs, unix

Default value: unix

--service-level

ServiceLevel.

Accepted values: Premium, Standard, StandardZRS, Ultra

Default value: Premium

--smb-access-based-enumeration --smb-access-enumeration

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--smb-ca --smb-continuously-available --smb-continuously-avl

Enables continuously available share property for smb volume. Only applicable for SMB volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--smb-non-browsable

Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--snapshot-dir-visible --snapshot-directory-visible

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).

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

Default value: True

--snapshot-id

Resource identifier used to identify the Snapshot.

--snapshot-policy-id

Snapshot Policy ResourceId.

--subnet --subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

Default value: default

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throughput-mibps

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

--unix-read-only

Read only access. Exists for backwards compatibility, please use --export-policy-rules (--rules) instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--unix-read-write

Read and write access. Exists for backwards compatibility, please use --export-policy-rules --rules instead.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--usage-threshold

Maximum storage quota allowed for a file system in GiB.

Default value: 100

--volume-spec-name

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

--volume-type

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection. For creating clone volume, set type to ShortTermClone.

--zones

Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume delete

Edit

Delete the specified volume.

az netappfiles volume delete [--account-name]
                             [--force {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

Delete an ANF volume

az netappfiles volume delete -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--force --force-delete

An option to force delete the volume. Will cleanup resources connected to the particular volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume delete (netappfiles-preview extension)

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the specified volume.

az netappfiles volume delete [--account-name]
                             [--force {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

Delete an ANF volume

az netappfiles volume delete -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--force --force-delete

An option to force delete the volume. Will cleanup resources connected to the particular volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume finalize-relocation

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume get-groupid-list-for-ldapuser

Edit

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 myuser

Required Parameters

--username

Username is required to fetch the group to which user is part of.

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume list

Edit

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 myvolumename

Required Parameters

--account-name -a

The name of the NetApp account.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume list (netappfiles-preview extension)

Preview

This command 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]

Examples

List all subvolumes of a ANF volume

az netappfiles subvolume list -g mygroup --account-name myaccountname  --pool-name mypoolname --volume-name myvolumename

Required Parameters

--account-name -a

The name of the NetApp account.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--max-items

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume list-quota-report

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Returns report of quotas for the volume.

az netappfiles volume list-quota-report [--account-name]
                                        [--ids]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--pool-name]
                                        [--resource-group]
                                        [--subscription]
                                        [--volume-name]

Examples

ListQuotaReport

az netappfiles volume list-quota-report --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume migrate-backup

Edit

Preview

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

--backup-vault-id

The ResourceId of the Backup Vault.

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume migrate-backup (netappfiles-preview extension)

Preview

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

--backup-vault-id

The ResourceId of the Backup Vault.

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume pool-change

Edit

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 mynewresourceid

Required Parameters

--new-pool-resource-id -d

Resource id of the pool to move volume to.

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume populate-availability-zone

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume relocate

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--creation-token

New creation token for the volume that controls the mount point name.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume reset-cifs-pw

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume revert

Edit

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-020073ca3333

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--snapshot-id -s

Resource id of the snapshot.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume revert-relocation

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume show

Edit

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 myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume show (netappfiles-preview extension)

Preview

This command 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]

Examples

Returns the properties of the given ANF volume

az netappfiles volume show -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume splitclonefromparent

Preview

This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Split operation to convert clone volume to an independent volume.

az netappfiles volume splitclonefromparent [--account-name]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--pool-name]
                                           [--resource-group]
                                           [--subscription]
                                           [--volume-name]

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume update

Edit

Update the specified volume within the capacity pool.

az netappfiles volume update [--account-name]
                             [--add]
                             [--avs-data-store {Disabled, Enabled}]
                             [--backup-policy-id]
                             [--backup-vault-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-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}]
                             [--export-policy-rules]
                             [--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, 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=specialvol

Optional Parameters

--account-name -a

The name of the NetApp account.

--add

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>.

--avs-data-store

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Accepted values: Disabled, Enabled

--backup-policy-id

Backup Policy Resource ID.

--backup-vault-id

Backup Vault Resource ID.

--ca-retrieval-policy --cool-access-retrieval-policy

Accepted values: Default, Never, OnRead

--capacity-pool-resource-id --pool-resource-id

Pool Resource Id used in case of creating a volume through volume group.

--cool-access

Specifies whether Cool Access(tiering) is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--coolness-period

Specifies the number of days after which data that is not accessed by clients will be tiered.

--creation-token

A unique file path for the volume. Used when creating mount targets.

--default-group-quota --default-group-quota-in-ki-bs

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

--default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled

Specifies if default quota is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--default-user-quota --default-user-quota-in-ki-bs

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

--delete-base-snapshot

If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enable-subvolumes

Flag indicating whether subvolume operations are enabled on the volume.

Accepted values: Disabled, Enabled

--encryption-key-source

Accepted values: Microsoft.KeyVault, Microsoft.NetApp

--endpoint-type

Indicates whether the local volume is the source or destination for the Volume Replication.

Accepted values: dst, src

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--is-large-volume

Specifies whether volume is a Large Volume or Regular Volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--is-restoring

Restoring.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

--ldap-enabled

Specifies whether LDAP is enabled or not for a given NFS volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--name --volume-name -n -v

The name of the volume.

--network-features

Basic network, or Standard features available to the volume. hide me.

Accepted values: Basic, Basic_Standard, Standard, Standard_Basic

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--placement-rules

Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-enforced

Policy Enforced.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--ppg --proximity-placement-group

Proximity placement group associated with the volume.

--protocol-types

Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--relocation-requested

Has relocation been requested for this volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remote-volume-id --remote-volume-resource-id

The resource ID of the remote volume.

--remote-volume-region

The remote region for the other end of the Volume Replication.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--replication-schedule

Schedule.

Accepted values: _10minutely, daily, hourly

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--security-style

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Accepted values: ntfs, unix

--service-level

ServiceLevel.

Accepted values: Premium, Standard, StandardZRS, Ultra

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--smb-access-based-enumeration --smb-access-enumeration

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--smb-continuously-available --smb-continuously-avl

Enables continuously available share property for smb volume. Only applicable for SMB volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--smb-non-browsable

Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--snapshot-dir-visible --snapshot-directory-visible

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).

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--snapshot-policy-id

Snapshot Policy ResourceId.

--subnet --subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throughput-mibps

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

--usage-threshold

Maximum storage quota allowed for a file system in GiB.

--vnet

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

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

--volume-type

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume update (netappfiles-preview extension)

Preview

This command 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-policy-id]
                             [--backup-vault-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-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}]
                             [--export-policy-rules]
                             [--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]
                             [--language {ar, ar.utf-8, c, c.utf-8, cs, cs.utf-8, da, da.utf-8, de, de.utf-8, en, en-us, en-us.utf-8, en.utf-8, es, es.utf-8, fi, fi.utf-8, fr, fr.utf-8, he, he.utf-8, hr, hr.utf-8, hu, hu.utf-8, it, it.utf-8, ja, ja-jp.932, ja-jp.932.utf-8, ja-jp.pck, ja-jp.pck-v2, ja-jp.pck-v2.utf-8, ja-jp.pck.utf-8, ja-v1, ja-v1.utf-8, ja.utf-8, ko, ko.utf-8, nl, nl.utf-8, no, no.utf-8, pl, pl.utf-8, pt, pt.utf-8, ro, ro.utf-8, ru, ru.utf-8, sk, sk.utf-8, sl, sl.utf-8, sv, sv.utf-8, tr, tr.utf-8, utf8mb4, zh, zh-tw, zh-tw.big5, zh-tw.big5.utf-8, zh-tw.utf-8, zh.gbk, zh.gbk.utf-8, zh.utf-8}]
                             [--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-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-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]

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=specialvol

Optional Parameters

--account-name -a

The name of the NetApp account.

--add

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>.

--avs-data-store

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose.

Accepted values: Disabled, Enabled

--backup-policy-id

Backup Policy Resource ID.

--backup-vault-id

Backup Vault Resource ID.

--ca-retrieval-policy --cool-access-retrieval-policy

Accepted values: Default, Never, OnRead

--capacity-pool-resource-id --pool-resource-id

Pool Resource Id used in case of creating a volume through volume group.

--cool-access

Specifies whether Cool Access(tiering) is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--coolness-period

Specifies the number of days after which data that is not accessed by clients will be tiered.

--creation-token

A unique file path for the volume. Used when creating mount targets.

--default-group-quota --default-group-quota-in-ki-bs

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

--default-quota-enabled --is-def-quota-enabled --is-default-quota-enabled

Specifies if default quota is enabled for the volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--default-user-quota --default-user-quota-in-ki-bs

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

--delete-base-snapshot

If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--enable-subvolumes

Flag indicating whether subvolume operations are enabled on the volume.

Accepted values: Disabled, Enabled

--encryption-key-source

Accepted values: Microsoft.KeyVault, Microsoft.NetApp

--endpoint-type

Indicates whether the local volume is the source or destination for the Volume Replication.

Accepted values: dst, src

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--is-large-volume

Specifies whether volume is a Large Volume or Regular Volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--is-restoring

Restoring.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

--language

Language.

--ldap-enabled

Specifies whether LDAP is enabled or not for a given NFS volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--name --volume-name -n -v

The name of the volume.

--network-features

Basic network, or Standard features available to the volume. hide me.

Accepted values: Basic, Basic_Standard, Standard, Standard_Basic

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--placement-rules

Application specific placement rules for the particular volume Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-enforced

Policy Enforced.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

--ppg --proximity-placement-group

Proximity placement group associated with the volume.

--protocol-types

Set of protocol types, default NFSv3, CIFS for SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--relocation-requested

Has relocation been requested for this volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--remote-volume-region

The remote region for the other end of the Volume Replication.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--replication-schedule

Schedule.

Accepted values: _10minutely, daily, hourly

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--security-style

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol.

Accepted values: ntfs, unix

--service-level

ServiceLevel.

Accepted values: Premium, Standard, StandardZRS, Ultra

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--smb-access-based-enumeration --smb-access-enumeration

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--smb-ca --smb-continuously-available --smb-continuously-avl

Enables continuously available share property for smb volume. Only applicable for SMB volume.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--smb-non-browsable

Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Accepted values: Disabled, Enabled

--snapshot-dir-visible --snapshot-directory-visible

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).

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--snapshot-policy-id

Snapshot Policy ResourceId.

--subnet --subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throughput-mibps

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

--usage-threshold

Maximum storage quota allowed for a file system in GiB.

--vnet

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

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

--volume-type

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume wait

Edit

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

--account-name -a

The name of the NetApp account.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az netappfiles volume wait (netappfiles-preview extension)

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

--account-name -a

The name of the NetApp account.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Share via

az netappfiles volume

Commands

az netappfiles volume break-file-locks

Examples

Optional Parameters

az netappfiles volume create

Examples

Required Parameters

Optional Parameters

az netappfiles volume create (netappfiles-preview extension)

Examples

Required Parameters

Optional Parameters

az netappfiles volume delete

Examples

Optional Parameters

az netappfiles volume delete (netappfiles-preview extension)

Examples

Optional Parameters

az netappfiles volume finalize-relocation

Examples

Optional Parameters

az netappfiles volume get-groupid-list-for-ldapuser

Examples

Required Parameters

Optional Parameters

az netappfiles volume list

Examples

Required Parameters

Optional Parameters

az netappfiles volume list (netappfiles-preview extension)

Examples

Required Parameters

Optional Parameters

az netappfiles volume list-quota-report

Examples

Optional Parameters

az netappfiles volume migrate-backup

Required Parameters

Optional Parameters

az netappfiles volume migrate-backup (netappfiles-preview extension)

Required Parameters

Optional Parameters

az netappfiles volume pool-change

Examples

Required Parameters

Optional Parameters

az netappfiles volume populate-availability-zone

Examples

Optional Parameters

az netappfiles volume relocate

Examples

Optional Parameters

az netappfiles volume reset-cifs-pw

Examples

Optional Parameters

az netappfiles volume revert

Examples

Optional Parameters

az netappfiles volume revert-relocation

Examples

Optional Parameters

az netappfiles volume show

Examples

Optional Parameters

az netappfiles volume show (netappfiles-preview extension)

Examples

Optional Parameters

az netappfiles volume splitclonefromparent

Optional Parameters

az netappfiles volume update

Examples

Optional Parameters

az netappfiles volume update (netappfiles-preview extension)

Examples

Optional Parameters

az netappfiles volume wait

Optional Parameters

az netappfiles volume wait (netappfiles-preview extension)