az netappfiles subvolume

Manage Azure NetApp Files (ANF) Subvolume Resources.

Commands

az netappfiles subvolume create	Create a subvolume in the specified path or clones the subvolume specified in the parentPath.
az netappfiles subvolume delete	Delete a specified ANF subvolume.
az netappfiles subvolume list	List all ANF subvolumes in the specified NetApp volume.
az netappfiles subvolume metadata	Manage Azure NetApp Files (ANF) Subvolume Metadata Resources.
az netappfiles subvolume metadata show	Get the specified ANF metadata of a subvolume.
az netappfiles subvolume show	Get the path associated with a subvolumeName.
az netappfiles subvolume update	Update a specified ANF subvolume.
az netappfiles subvolume wait	Wait for a subvolume operation.

az netappfiles subvolume create

Create a subvolume in the specified path or clones the subvolume specified in the parentPath.

az netappfiles subvolume create --account-name
                                --pool-name
                                --resource-group
                                --subvolume-name
                                --volume-name
                                [--no-wait]
                                [--parent-path]
                                [--path]
                                [--size]

Examples

Create a ANF subvolume

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

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

--subvolume-name

The name of the ANF subvolume.

--volume-name -v

The name of the ANF volume.

Optional Parameters

--no-wait

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

--parent-path

Path to the parent subvolume.

--path

Path to the subvolume.

--size

Size of the subvolume.

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

Delete a specified ANF subvolume.

az netappfiles subvolume delete [--account-name]
                                [--ids]
                                [--no-wait]
                                [--pool-name]
                                [--resource-group]
                                [--subvolume-name]
                                [--volume-name]
                                [--yes]

Examples

Delete a subvolume of the ANF volume

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

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.

--no-wait

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

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

--subvolume-name

The name of the ANF subvolume.

--volume-name -v

The name of the ANF volume.

--yes -y

Do not prompt for confirmation.

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

List all ANF subvolumes in the specified NetApp volume.

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

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

The name of the ANF 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 subvolume show

Get the path associated with a subvolumeName.

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

Examples

Get a subvolume of the ANF volume

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

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.

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

--subvolume-name

The name of the ANF subvolume.

--volume-name -v

The name of the ANF 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 subvolume update

Update a specified ANF subvolume.

az netappfiles subvolume update [--account-name]
                                [--add]
                                [--force-string]
                                [--ids]
                                [--no-wait]
                                [--path]
                                [--pool-name]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--size]
                                [--subvolume-name]
                                [--volume-name]

Examples

Update a subvolume

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

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. You should provide either --ids or other 'Resource Id' arguments.

--no-wait

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

--path

Path to the subvolume.

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

--set

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

--size

Size of the subvolume.

--subvolume-name

The name of the ANF subvolume.

--volume-name -v

The name of the ANF 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 subvolume wait

Wait for a subvolume operation.

az netappfiles subvolume wait [--account-name]
                              [--created]
                              [--custom]
                              [--deleted]
                              [--exists]
                              [--ids]
                              [--interval]
                              [--pool-name]
                              [--resource-group]
                              [--subvolume-name]
                              [--timeout]
                              [--updated]
                              [--volume-name]

Optional Parameters

--account-name -a

Name of the ANF account.

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

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

--interval

Polling interval in seconds.

default value: 30

--pool-name -p

Name of the ANF pool.

--resource-group -g

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

--subvolume-name

The name of the subvolume.

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

--volume-name -v

Name of the ANF 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.