az netappfiles subvolume

Manage Azure NetApp Files (ANF) Subvolume Resources.

Commands

Name	Description	Type	Status
az netappfiles subvolume create	Create a subvolume in the path or clones the subvolume mentioned in the parentPath.	Core	GA
az netappfiles subvolume delete	Delete subvolume.	Core	GA
az netappfiles subvolume list	List a list of the subvolumes in the volume.	Core	GA
az netappfiles subvolume metadata	Manage Azure NetApp Files (ANF) Subvolume Metadata.	Core	GA
az netappfiles subvolume metadata show	Get details of the specified subvolume.	Core	GA
az netappfiles subvolume show	Get the path associated with the subvolumeName provided.	Core	GA
az netappfiles subvolume update	Update a subvolume in the path or clones the subvolume mentioned in the parentPath.	Core	GA
az netappfiles subvolume wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az netappfiles subvolume create

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

az netappfiles subvolume create --account-name
                                --name
                                --pool-name
                                --resource-group
                                --volume-name
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--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 NetApp account.

--name --subvolume-name -n

The name of the subvolume.

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

--volume-name -v

The name of the volume.

Optional Parameters

--no-wait

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

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

--parent-path

Parent path to the subvolume.

--path

Path to the subvolume.

--size

Truncate subvolume to the provided size in bytes.

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

Delete subvolume.

az netappfiles subvolume delete [--account-name]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--pool-name]
                                [--resource-group]
                                [--subscription]
                                [--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 NetApp 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 --subvolume-name -n

The name of the subvolume.

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

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

List a list of the subvolumes in the volume.

az netappfiles subvolume list --account-name
                              --pool-name
                              --resource-group
                              --volume-name
                              [--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>.

--volume-name -v

The name of the volume.

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

Get the path associated with the subvolumeName provided.

az netappfiles subvolume show [--account-name]
                              [--ids]
                              [--name]
                              [--pool-name]
                              [--resource-group]
                              [--subscription]
                              [--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 NetApp 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 --subvolume-name -n

The name of the subvolume.

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

Update a subvolume in the path or clones the subvolume mentioned in the parentPath.

az netappfiles subvolume update [--account-name]
                                [--add]
                                [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                [--ids]
                                [--name]
                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                [--parent-path]
                                [--path]
                                [--pool-name]
                                [--remove]
                                [--resource-group]
                                [--set]
                                [--size]
                                [--subscription]
                                [--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 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>.

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

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 --subvolume-name -n

The name of the subvolume.

--no-wait

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

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

--parent-path

Parent path to the subvolume.

--path

Path to the subvolume.

--pool-name -p

The name of the capacity pool.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> 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=<value>.

--size

Truncate subvolume to the provided size in bytes.

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

Place the CLI in a waiting state until a condition is met.

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

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

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

--name --subvolume-name -n

The name of the subvolume.

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

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