az netappfiles account

  • Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure NetApp Files (ANF) Account Resources.

Commands

Name Description Type Status
az netappfiles account ad

Manage Azure NetApp Files (ANF) Account active directories.

 Core GA
az netappfiles account ad add

Add an active directory to the account.

 Core GA
az netappfiles account ad list

List the active directories of an account.

 Core GA
az netappfiles account ad remove

Remove an active directory from the account.

 Core GA
az netappfiles account ad show

Get the specified ANF active directory.

 Core GA
az netappfiles account ad update

Updates an active directory to the account.

 Core GA
az netappfiles account ad wait

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

 Core GA
az netappfiles account backup

Manage Azure NetApp Files (ANF) Account Backup Resources.

 Core GA
az netappfiles account backup-policy

Manage Azure NetApp Files (ANF) Bakup Policy Resources.

 Core GA
az netappfiles account backup-policy create

Create a backup policy for Netapp Account.

 Core GA
az netappfiles account backup-policy delete

Delete backup policy.

 Core GA
az netappfiles account backup-policy list

List backup policies for Netapp Account.

 Core GA
az netappfiles account backup-policy show

Get a particular backup Policy.

 Core GA
az netappfiles account backup-policy update

Update a backup policy for Netapp Account.

 Core GA
az netappfiles account backup-policy wait

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

 Core GA
az netappfiles account backup-vault

Manage Azure NetApp Files (ANF) BackupVault Resources.

 Extension Preview
az netappfiles account backup-vault backup

Manage Azure NetApp Files (ANF) Backup Resources.

 Extension Preview
az netappfiles account backup-vault backup create

Create a backup under the Backup Vault.

 Extension Preview
az netappfiles account backup-vault backup delete

Delete a Backup under the Backup Vault.

 Extension Preview
az netappfiles account backup-vault backup list

List all backups Under a Backup Vault.

 Extension Preview
az netappfiles account backup-vault backup restore-file

Restore the specified files from the specified backup to the active filesystem.

 Extension Preview
az netappfiles account backup-vault backup show

Get the specified Backup under Backup Vault.

 Extension Preview
az netappfiles account backup-vault backup update

Update a backup under the Backup Vault.

 Extension Preview
az netappfiles account backup-vault backup wait

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

 Extension Preview
az netappfiles account backup-vault create

Create the specified Backup Vault in the NetApp account.

 Extension Preview
az netappfiles account backup-vault delete

Delete the specified Backup Vault.

 Extension Preview
az netappfiles account backup-vault list

List and describe all Backup Vaults in the NetApp account.

 Extension Preview
az netappfiles account backup-vault show

Get the Backup Vault.

 Extension Preview
az netappfiles account backup-vault update

Update the specified Backup Vault in the NetApp account.

 Extension Preview
az netappfiles account backup-vault wait

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

 Extension Preview
az netappfiles account backup delete

Delete the specified Backup for a Netapp Account.

 Core GA
az netappfiles account backup list

List all Backups for a Netapp Account.

 Core GA
az netappfiles account backup show

Get the specified backup for a Netapp Account.

 Core GA
az netappfiles account backup wait

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

 Core GA
az netappfiles account create

Create the specified NetApp account within the resource group.

 Core GA
az netappfiles account delete

Delete the specified NetApp account.

 Core GA
az netappfiles account list

List and describe all NetApp accounts in the subscription.

 Core GA
az netappfiles account renew-credentials

Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.

 Core GA
az netappfiles account show

Get the NetApp account.

 Core GA
az netappfiles account update

Update the specified NetApp account within the resource group.

 Core GA
az netappfiles account wait

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

 Core GA

az netappfiles account create

Edit

Create the specified NetApp account within the resource group.

az netappfiles account create --account-name
                              --resource-group
                              [--active-directories]
                              [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                              [--key-name]
                              [--key-source {Microsoft.KeyVault, Microsoft.NetApp}]
                              [--key-vault-resource-id]
                              [--key-vault-uri]
                              [--location]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--tags]
                              [--user-assigned-identity]

Examples

Create an ANF account

az netappfiles account create -g mygroup --name myname -l location --tags testtag1=mytag1 testtag3=mytagg

Create an ANF account enabling CMK encryption

az netappfiles account create -g mygroup --name myname -l location --key-source Microsoft.KeyVault --key-name cmkKey --key-vault-uri https://mykvuri.vault.azure.net/ --keyvault-resource-id myKeyVaultResourceId --identity-type UserAssigned --user-assigned-identity '/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/anf-mi'

Required Parameters

--account-name --name -a -n

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

--active-directories

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

--identity-type --type

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--key-name

The name of KeyVault key.

--key-source

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault.

accepted values: Microsoft.KeyVault, Microsoft.NetApp
default value: Microsoft.NetApp
--key-vault-resource-id --keyvault-resource-id

The resource ID of KeyVault.

--key-vault-uri -v

The Uri of KeyVault.

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

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

--user-assigned-identity -u

The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has UserAssigned. It should match key of identity.userAssignedIdentities.

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

Edit

Delete the specified NetApp account.

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

Examples

Delete an ANF account

az netappfiles account delete -g mygroup --name myname

Optional Parameters

--account-name --name -a -n

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.

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

Edit

List and describe all NetApp accounts in the subscription.

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

Examples

List ANF accounts within a resource group

az netappfiles account list -g mygroup

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.

--resource-group -g

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

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 account renew-credentials

Edit

Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.

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

Examples

Renew identity credentials

az netappfiles account renew-credentials -g mygroup --a myname

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.

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

Edit

Get the NetApp account.

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

Examples

Get an ANF account

az netappfiles account show -g mygroup --name myname

Optional Parameters

--account-name --name -a -n

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.

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

Edit

Update the specified NetApp account within the resource group.

az netappfiles account update [--account-name]
                              [--active-directories]
                              [--add]
                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                              [--identity-type {None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned}]
                              [--ids]
                              [--key-name]
                              [--key-source {Microsoft.KeyVault, Microsoft.NetApp}]
                              [--key-vault-resource-id]
                              [--key-vault-uri]
                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                              [--remove]
                              [--resource-group]
                              [--set]
                              [--subscription]
                              [--tags]
                              [--user-assigned-identity]

Examples

Update the tags of an ANF account

az netappfiles account update -g mygroup --name myname --tags testtag2=mytagb

Update an ANF account enabling CMK encryption

az netappfiles account update -g mygroup -a myname --key-source Microsoft.KeyVault --key-name cmkKey --key-vault-uri https://mykvuri.vault.azure.net/ --keyvault-resource-id myKeyVaultResourceId --identity-type UserAssigned --user-assigned-identity '/subscriptions/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myrg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/anf-mi'

Optional Parameters

--account-name --name -a -n

The name of the NetApp account.

--active-directories

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

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

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

accepted values: None, SystemAssigned, SystemAssigned,UserAssigned, UserAssigned
--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.

--key-name

The name of KeyVault key.

--key-source

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault.

accepted values: Microsoft.KeyVault, Microsoft.NetApp
--key-vault-resource-id --keyvault-resource-id

The resource ID of KeyVault.

--key-vault-uri -v

The Uri of KeyVault.

--no-wait

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

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

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

--user-assigned-identity -u

The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has UserAssigned. It should match key of identity.userAssignedIdentities.

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

Edit

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

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

Optional Parameters

--account-name --name -a -n

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