az netappfiles volume

Manage Azure NetApp Files (ANF) Volume Resources.

Commands

az netappfiles volume create

Create a new Azure NetApp Files (ANF) volume.

az netappfiles volume delete

Delete the specified ANF volume.

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.

az netappfiles volume create

Create a new Azure NetApp Files (ANF) volume.

az netappfiles volume create --account-name
                             --creation-token
                             --location
                             --pool-name
                             --resource-group
                             --service-level
                             --subnet-id
                             --usage-threshold
                             --volume-name
                             [--export-policy]
                             [--tags]

Examples

Create an ANF volume

az netappfiles volume create -g group --account-name aname --pool-name pname --volume-name vname -l location --service-level "Premium" --usage-threshold 107374182400 --creation-token "unique-token" --subnet-id "/subscriptions/mysubsid/resourceGroups/myrg/providers/Microsoft.Network/virtualNetworks/myvnet/subnets/default" --export-policy '[{"allowed_clients":"0.0.0.0/0", "rule_index": "1", "unix_read_only": "true", "unix_read_write": "false", "cifs": "false", "nfsv3": "true", "nfsv3": "true", "nfsv4": "false"}]'

Required Parameters

--account-name -a

The name of the ANF account.

--creation-token

A unique file path identifier, from 1 to 80 characters.

--location -l

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

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

--service-level

The service level ["Standard"|"Premium"|"Extreme"].

--subnet-id

The subnet identifier.

--usage-threshold

The maximum storage quota allowed for a file system in bytes. Min 100 GiB, max 100TiB".

--volume-name -n -v

The name of the ANF volume.

Optional Parameters

--export-policy

A json list of the parameters for export policy containing rule_index (Order index), unix_read_only (Read only access), unix_read_write (Read and write access), cifs (Allows CIFS protocol), nfsv3 (Allows NFSv3 protocol), nfsv4 (Allows NFSv4 protocol) and allowedClients (Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names).

--tags

A list of space separated tags to apply to the volume.

az netappfiles volume delete

Delete the specified ANF volume.

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

Examples

Delete an ANF volume

az netappfiles volume delete -g group --account-name aname --pool-name pname --volume-name vname

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

--volume-name -n -v

The name of the ANF volume.

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 group --account-name aname --pool-name pname

Required Parameters

--account-name -a

The name of the ANF account.

--pool-name -n -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>.

az netappfiles volume show

Get the specified ANF volume.

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

Examples

Returns the properties of the given ANF volume

az netappfiles volume show -g group --account-name aname --pool-name pname --volume-name vname

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

--volume-name -n -v

The name of the ANF pool.

az netappfiles volume update

Update the specified ANF volume with the values provided. Unspecified values will remain unchanged.

az netappfiles volume update --account-name
                             --pool-name
                             --resource-group
                             --volume-name
                             [--add]
                             [--export-policy]
                             [--force-string]
                             [--remove]
                             [--service-level]
                             [--set]
                             [--tags]
                             [--usage-threshold]

Examples

Create an ANF volume

az netappfiles volume update -g group --account-name aname --pool-name pname --volume-name vname --service-level level --usage-threshold 107374182400 --tags 'key[=value] key[=value]' --export-policy '[{"allowed_clients":"1.2.3.0/24", "rule_index": "1", "unix_read_only": "true", "unix_read_write": "false", "cifs": "false", "nfsv3": "true", "nfsv3": "true", "nfsv4": "false"}, {"allowed_clients":"1.2.4.0/24", "rule_index": "2", "unix_read_only": "true", "unix_read_write": "false", "cifs": "false", "nfsv3": "true", "nfsv3": "true", "nfsv4": "false"}]'

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

--volume-name -n -v

The name of the ANF volume.

Optional Parameters

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

--export-policy

A json list of the parameters for export policy containing rule_index (Order index), unix_read_only (Read only access), unix_read_write (Read and write access), cifs (Allows CIFS protocol), nfsv3 (Allows NFSv3 protocol), nfsv4 (Allows NFSv4 protocol) and allowedClients (Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names).

--force-string

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

--remove

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

--service-level

The service level ["Standard"|"Premium"|"Extreme"].

--set

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

--tags

A list of space separated tags to apply to the volume.

--usage-threshold

The maximum storage quota allowed for a file system in bytes. Min 100 GiB, max 100TiB".