az netappfiles account backup-vault

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) BackupVault Resources.

Commands

Name	Description	Type	Status
az netappfiles account backup-vault backup	Manage Azure NetApp Files (ANF) Backup Resources.	Core and Extension	GA
az netappfiles account backup-vault backup create	Create a backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup create (netappfiles-preview extension)	Create a backup under the Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup delete	Delete a Backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup delete (netappfiles-preview extension)	Delete a Backup under the Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup list	List all backups Under a Backup Vault.	Core	GA
az netappfiles account backup-vault backup list (netappfiles-preview extension)	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.	Core	GA
az netappfiles account backup-vault backup restore-file (netappfiles-preview extension)	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.	Core	GA
az netappfiles account backup-vault backup show (netappfiles-preview extension)	Get the specified Backup under Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup update	Update a backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup update (netappfiles-preview extension)	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.	Core	GA
az netappfiles account backup-vault backup wait (netappfiles-preview extension)	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.	Core	GA
az netappfiles account backup-vault create (netappfiles-preview extension)	Create the specified Backup Vault in the NetApp account.	Extension	Preview
az netappfiles account backup-vault delete	Delete the specified Backup Vault.	Core	GA
az netappfiles account backup-vault delete (netappfiles-preview extension)	Delete the specified Backup Vault.	Extension	Preview
az netappfiles account backup-vault list	List and describe all Backup Vaults in the NetApp account.	Core	GA
az netappfiles account backup-vault list (netappfiles-preview extension)	List and describe all Backup Vaults in the NetApp account.	Extension	Preview
az netappfiles account backup-vault show	Get the Backup Vault.	Core	GA
az netappfiles account backup-vault show (netappfiles-preview extension)	Get the Backup Vault.	Extension	Preview
az netappfiles account backup-vault update	Update the specified Backup Vault in the NetApp account.	Core	GA
az netappfiles account backup-vault update (netappfiles-preview extension)	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.	Core	GA
az netappfiles account backup-vault wait (netappfiles-preview extension)	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.

az netappfiles account backup-vault create --account-name
                                           --backup-vault-name
                                           --resource-group
                                           [--location]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--tags]

Required Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

--resource-group -g

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

Optional Parameters

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

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 backup-vault create (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create the specified Backup Vault in the NetApp account.

az netappfiles account backup-vault create --account-name
                                           --backup-vault-name
                                           --resource-group
                                           [--location]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--tags]

Required Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

--resource-group -g

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

Optional Parameters

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

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 backup-vault delete

Delete the specified Backup Vault.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

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

--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 account backup-vault delete (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the specified Backup Vault.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

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

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

List and describe all Backup Vaults in the NetApp account.

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

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 account backup-vault list (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List and describe all Backup Vaults in the NetApp account.

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

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

Get the Backup Vault.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

--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 backup-vault show (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the Backup Vault.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

--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 backup-vault update

Update the specified Backup Vault in the NetApp account.

az netappfiles account backup-vault update [--account-name]
                                           [--add]
                                           [--backup-vault-name]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]
                                           [--tags]

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

--backup-vault-name --name -n -v

The name of the Backup Vault.

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

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

--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 account backup-vault update (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update the specified Backup Vault in the NetApp account.

az netappfiles account backup-vault update [--account-name]
                                           [--add]
                                           [--backup-vault-name]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]
                                           [--tags]

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

--backup-vault-name --name -n -v

The name of the Backup Vault.

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

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

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

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

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

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

az netappfiles account backup-vault wait (netappfiles-preview extension)

Preview

Command group 'az netappfiles account backup-vault' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-vault-name --name -n -v

The name of the Backup Vault.

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