az netappfiles volume

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage Azure NetApp Files (ANF) Volume Resources.

Commands

az netappfiles volume backup	Manage Azure NetApp Files (ANF) Volume Backup Resources.
az netappfiles volume backup create	Create specified ANF volume backup.
az netappfiles volume backup delete	Delete backup.
az netappfiles volume backup list	List the ANF Backups for the specified volume.
az netappfiles volume backup restore-status	Get backup restore status of the specified ANF Volume.
az netappfiles volume backup show	Get the specified ANF Backup.
az netappfiles volume backup status	Get backup status of the specified ANF Volume.
az netappfiles volume backup update	Update the specified ANF backup with the values provided.
az netappfiles volume create	Create a new Azure NetApp Files (ANF) volume. Export policies are applied with the subgroup commands but note that volumes are always created with a default export policy.
az netappfiles volume delete	Delete the specified ANF volume.
az netappfiles volume export-policy	Manage Azure NetApp Files (ANF) Volume export policies.
az netappfiles volume export-policy add	Add a new rule to the export policy for a volume.
az netappfiles volume export-policy list	List the export policy rules for a volume.
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.
az netappfiles volume list	List the ANF Pools for the specified account.
az netappfiles volume pool-change	Change pool for an Azure NetApp Files (ANF) volume.
az netappfiles volume replication	Manage Azure NetApp Files (ANF) Volume replication operations.
az netappfiles volume replication approve	Authorize a volume as a replication destination for a specified source.
az netappfiles volume replication re-initialize	Re-initialise a volume replication for the specified destination volume. The replication process is resumed from source to destination.
az netappfiles volume replication remove	Delete a volume replication for the specified destination volume. The data replication objects of source and destination volumes will be removed.
az netappfiles volume replication resume	Resync a volume replication for the specified destination volume. The replication process is resumed from source to destination.
az netappfiles volume replication status	Get the replication status for the specified replication volume.
az netappfiles volume replication suspend	Suspend/break a volume replication for the specified destination volume. The replication process is suspended until resumed or deleted.
az netappfiles volume revert	Revert a volume to one of its snapshots.
az netappfiles volume show	Get the specified ANF volume.
az netappfiles volume update	Update the specified ANF volume with the values provided. Unspecified values will remain unchanged. Export policies are amended/created with the subgroup commands.

az netappfiles volume create

Create a new Azure NetApp Files (ANF) volume. Export policies are applied with the subgroup commands but note that volumes are always created with a default export policy.

az netappfiles volume create --account-name
                             --file-path
                             --name
                             --pool-name
                             --resource-group
                             --usage-threshold
                             --vnet
                             [--allowed-clients]
                             [--avs-data-store]
                             [--backup-enabled {false, true}]
                             [--backup-id]
                             [--backup-policy-id]
                             [--chown-mode]
                             [--cifs {false, true}]
                             [--cool-access {false, true}]
                             [--coolness-period]
                             [--default-group-quota]
                             [--default-user-quota]
                             [--enable-subvolumes]
                             [--encryption-key-source]
                             [--endpoint-type]
                             [--has-root-access]
                             [--is-def-quota-enabled {false, true}]
                             [--kerberos-enabled {false, true}]
                             [--kerberos5-r]
                             [--kerberos5-rw]
                             [--kerberos5i-r]
                             [--kerberos5i-rw]
                             [--kerberos5p-r]
                             [--kerberos5p-rw]
                             [--ldap-enabled {false, true}]
                             [--location]
                             [--network-features]
                             [--policy-enforced {false, true}]
                             [--protocol-types]
                             [--remote-volume-resource-id]
                             [--replication-schedule]
                             [--rule-index]
                             [--security-style]
                             [--service-level {Premium, Standard, Ultra}]
                             [--smb-continuously-avl {false, true}]
                             [--smb-encryption {false, true}]
                             [--snapshot-dir-visible]
                             [--snapshot-id]
                             [--snapshot-policy-id]
                             [--subnet]
                             [--tags]
                             [--throughput-mibps]
                             [--unix-permissions]
                             [--unix-read-only {false, true}]
                             [--unix-read-write {false, true}]
                             [--vault-id]
                             [--volume-type]

Examples

Create an ANF volume

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

Required Parameters

--account-name -a

The name of the ANF account.

--file-path

A 1-80 character long alphanumeric string value that identifies a unique file share or mount point in the target delegate subnet.

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

The name of the ANF volume.

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

--usage-threshold

The maximum storage quota allowed for a file system as integer number of GiB. Min 100 GiB, max 100TiB".

--vnet

The ARM Id or name of the vnet for the volume.

Optional Parameters

--allowed-clients

Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names.

--avs-data-store

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose. Possible values are Enabled and Disabled. Default value is Disabled.

--backup-enabled

Backup Enabled.

accepted values: false, true

--backup-id

Backup ID. UUID v4 or resource identifier used to identify the Backup.

--backup-policy-id

Backup Policy Resource ID.

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

--cifs

Allows NFSv3 protocol. Enable only for NFSv3 type volumes.

accepted values: false, true

--cool-access

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

accepted values: false, true

--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 for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

--default-user-quota

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

--enable-subvolumes

Flag indicating whether subvolume operations are enabled on the volume. Possible values are Enabled and Disabled. Default value is Disabled.

--encryption-key-source

Encryption Key Source.

--endpoint-type

Whether the volume is source ("src") or destination ("dst").

--has-root-access

Has root access to volume.

--is-def-quota-enabled

Specifies if default quota is enabled for the volume.

accepted values: false, true

--kerberos-enabled

Describe if a volume is KerberosEnabled.

accepted values: false, true

--kerberos5-r

Kerberos5 Read only access.

--kerberos5-rw

Kerberos5 Read and write access.

--kerberos5i-r

Kerberos5i Read only access.

--kerberos5i-rw

Kerberos5i Read and write access.

--kerberos5p-r

Kerberos5p Read only access.

--kerberos5p-rw

Kerberos5p Read and write access.

--ldap-enabled

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

accepted values: false, true

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--network-features

Basic network, or Standard features available to the volume. Possible values are Basic and Standard. Default value is Basic.

--policy-enforced

Policy Enforced.

accepted values: false, true

--protocol-types

Space separated list of protocols that the volume can use, available protocols are "NFSv4.1", "NFSv3", "CIFS".

--remote-volume-resource-id

The volume id of the remote volume of the replication (the destination for "src" volume endpoints and the source for "dst" endpoints).

--replication-schedule

The replication schedule, e.g. "_10minutely, hourly, daily, weekly, monthly".

--rule-index

Order index.

--security-style

The security style of volume.

--service-level

The service level.

accepted values: Premium, Standard, Ultra

--smb-continuously-avl

Enables continuously available share property for smb volume. Only applicable for SMB volume. Default value is False.

accepted values: false, true

--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. Default value is False.

accepted values: false, true

--snapshot-dir-visible

If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true).

--snapshot-id

Create a volume created from this snapshot. UUID v4 or resource identifier used to identify the Snapshot. example snapshot-id "9760acf5-4638-11e7-9bdb-020073ca3333".

--snapshot-policy-id

Snapshot Policy ResourceId.

--subnet

The ARM Id or name of the delegated subnet for the vnet. If omitted 'default' will be used.

default value: default

--tags

Space-separated tags in key[=value] format.

--throughput-mibps

Maximum throughput in Mibps that can be achieved by this 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.

accepted values: false, true

--unix-read-write

Read and write access.

accepted values: false, true

--vault-id

Vault Resource ID.

--volume-type

Whether the volume should be a data protection volume ("DataProtection"), empty if this is not a data protection 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.

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

Delete the specified ANF volume.

az netappfiles volume delete [--account-name]
                             [--force-delete {false, true}]
                             [--ids]
                             [--name]
                             [--pool-name]
                             [--resource-group]

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

--force-delete

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

accepted values: false, 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 ANF volume.

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

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.

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

List the ANF Pools for the specified account.

az netappfiles volume list --account-name
                           --pool-name
                           --resource-group

Examples

List the ANF volumes of the pool

az netappfiles volume list -g mygroup --account-name myaccname --pool-name mypoolname

Required Parameters

--account-name -a

The name of the ANF account.

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

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.

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

Change pool for an Azure NetApp Files (ANF) volume.

az netappfiles volume pool-change --new-pool-resource-id
                                  [--account-name]
                                  [--ids]
                                  [--name]
                                  [--pool-name]
                                  [--resource-group]

Examples

This changes 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

The resource id of the new ANF pool.

Optional Parameters

--account-name -a

The name of the ANF account.

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

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

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.

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

Revert a volume to one of its snapshots.

Revert a volume to the snapshot specified in the body.

az netappfiles volume revert --account-name
                             --name
                             --pool-name
                             --resource-group
                             --snapshot-id

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

Required Parameters

--account-name -a

The name of the ANF account.

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

The name of the ANF volume.

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

--snapshot-id -s

SnapshotId of the snapshot. UUID v4 used to identify the Snapshot, example "9760acf5-4638-11e7-9bdb-020073ca3333".

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.

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

Get the specified ANF volume.

az netappfiles volume show [--account-name]
                           [--ids]
                           [--name]
                           [--pool-name]
                           [--resource-group]

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

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

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

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.

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

Update the specified ANF volume with the values provided. Unspecified values will remain unchanged. Export policies are amended/created with the subgroup commands.

az netappfiles volume update [--account-name]
                             [--add]
                             [--backup-enabled {false, true}]
                             [--backup-policy-id]
                             [--default-group-quota]
                             [--default-user-quota]
                             [--force-string]
                             [--ids]
                             [--is-def-quota-enabled {false, true}]
                             [--name]
                             [--policy-enforced {false, true}]
                             [--pool-name]
                             [--remove]
                             [--resource-group]
                             [--service-level {Premium, Standard, Ultra}]
                             [--set]
                             [--snapshot-policy-id]
                             [--tags]
                             [--throughput-mibps]
                             [--unix-permissions]
                             [--usage-threshold]
                             [--vault-id]

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

--backup-enabled

Backup Enabled.

accepted values: false, true

--backup-policy-id

Backup Policy Resource ID.

--default-group-quota

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

--default-user-quota

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

--force-string

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

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

--is-def-quota-enabled

Specifies if default quota is enabled for the volume.

accepted values: false, true

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

The name of the ANF volume.

--policy-enforced

Backup Policy Enforced.

accepted values: false, true

--pool-name -p

The name of the ANF pool.

--remove

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

--resource-group -g

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

--service-level

The service level.

accepted values: Premium, Standard, Ultra

--set

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

--snapshot-policy-id

Snapshot Policy ResourceId.

--tags

Space-separated tags in key[=value] format.

--throughput-mibps

Maximum throughput in Mibps 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.

--usage-threshold

The maximum storage quota allowed for a file system as integer number of GiB. Min 100 GiB, max 100TiB.

--vault-id

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

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