az netappfiles pool

  • Reference

Manage Azure NetApp Files (ANF) Capacity Pool Resources.

Commands

Name Description Type Status
az netappfiles pool create

Create a capacity pool.

 Core GA
az netappfiles pool delete

Delete the specified capacity pool.

 Core GA
az netappfiles pool list

List all capacity pools in the NetApp Account.

 Core GA
az netappfiles pool show

Get details of the specified capacity pool.

 Core GA
az netappfiles pool update

Update a capacity pool.

 Core GA
az netappfiles pool wait

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

 Core GA

az netappfiles pool create

Edit

Create a capacity pool.

Create a new Azure NetApp Files (ANF) capacity pool.

az netappfiles pool create --account-name
                           --name
                           --resource-group
                           [--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
                           [--encryption-type {Double, Single}]
                           [--location]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--qos-type {Auto, Manual}]
                           [--service-level {Premium, Standard, StandardZRS, Ultra}]
                           [--size]
                           [--tags]

Examples

Create an ANF pool

az netappfiles pool create -g mygroup --account-name myaccountname --name mypoolname -l westus2 --size 8 --service-level premium

Required Parameters

--account-name -a

The name of the NetApp account.

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

Optional Parameters

--cool-access

If enabled (true) the pool can contain cool Access enabled volumes.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
default value: False
--encryption-type

Encryption type of the capacity pool, set encryption type for data at rest for this pool and all volumes in it. This value can only be set when creating new pool.

accepted values: Double, Single
default value: Single
--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--qos-type

The qos type of the pool.

accepted values: Auto, Manual
default value: Auto
--service-level

ServiceLevel.

accepted values: Premium, Standard, StandardZRS, Ultra
default value: Premium
--size

Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104).

default value: 4398046511104
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Edit

Delete the specified capacity pool.

Delete the specified ANF capacity pool.

az netappfiles pool delete [--account-name]
                           [--ids]
                           [--name]
                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                           [--resource-group]
                           [--subscription]

Examples

Delete an ANF pool

az netappfiles pool delete -g mygroup --account-name myaccname --name mypoolname

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

The name of the capacity pool.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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.

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

Edit

List all capacity pools in the NetApp Account.

List the ANF capacity pools for the specified account.

az netappfiles pool list --account-name
                         --resource-group
                         [--max-items]
                         [--next-token]

Examples

List the pools for the ANF account

az netappfiles pool list -g mygroup --account-name myname

Required Parameters

--account-name -a

The name of the NetApp account.

--resource-group -g

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

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

Edit

Get details of the specified capacity pool.

Get the specified ANF capacity pool.

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

Examples

Get an ANF pool

az netappfiles pool show -g mygroup --account-name myaccname --name mypoolname

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

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

Edit

Update a capacity pool.

Update the specified ANF capacity pool.

az netappfiles pool update [--account-name]
                           [--add]
                           [--cool-access {0, 1, f, false, n, no, t, true, y, yes}]
                           [--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}]
                           [--qos-type {Auto, Manual}]
                           [--remove]
                           [--resource-group]
                           [--service-level {Premium, Standard, StandardZRS, Ultra}]
                           [--set]
                           [--size]
                           [--subscription]
                           [--tags]

Examples

Update specific values for an ANF pool

az netappfiles pool update -g mygroup --account-name myaccname --name mypoolname --tags mytag1=abcd mytag2=efgh

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

--cool-access

If enabled (true) the pool can contain cool Access enabled volumes.

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 --pool-name -n -p

The name of the capacity pool.

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--qos-type

The qos type of the pool.

accepted values: Auto, Manual
--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

ServiceLevel.

accepted values: Premium, Standard, StandardZRS, Ultra
--set

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

--size

Provisioned size of the pool (in bytes). Allowed values are in 1TiB chunks (value must be multiply of 4398046511104).

--subscription

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

Edit

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

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

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