az netappfiles volume

Manage Azure NetApp Files (ANF) Volume Resources.

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 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 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
--location
--name
--pool-name
--resource-group
--usage-threshold
--vnet
[--protocol-types]
[--service-level {Premium, Standard, Ultra}]
[--subnet]
[--subscription]
[--tags]

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

--location -l

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

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

--protocol-types

Space seperated list of protocols that the volume can use.

--service-level

The service level.

accepted values: Premium, Standard, Ultra
--subnet

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

default value: default
--subscription

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

--tags

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

az netappfiles volume delete

Delete the specified ANF volume.

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

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.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

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

--subscription

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

az netappfiles volume list

List the ANF Pools for the specified account.

az netappfiles volume list --account-name
--pool-name
--resource-group
[--subscription]

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

Optional Parameters

--subscription

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

az netappfiles volume show

Get the specified ANF 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 ANF account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. If provided, no other 'Resource Id' arguments should be specified.

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

--subscription

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

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]
[--force-string]
[--ids]
[--name]
[--pool-name]
[--protocol-types]
[--remove]
[--resource-group]
[--service-level {Premium, Standard, Ultra}]
[--set]
[--subscription]
[--tags]
[--usage-threshold]

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

--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. If provided, no other 'Resource Id' arguments should be specified.

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

The name of the ANF volume.

--pool-name -p

The name of the ANF pool.

--protocol-types

Space-separated tags in 'key[=value]' format. Use "" to clear existing tags.

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

--subscription

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

--tags

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

--usage-threshold

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