az netappfiles account backup-vault backup

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

Commands

Name	Description	Type	Status
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 backup create

Edit

Create a backup under the Backup Vault.

az netappfiles account backup-vault backup create --account-name
                                                  --backup-name --name
                                                  --backup-vault-name
                                                  --resource-group
                                                  --volume-resource-id
                                                  [--label]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--snapshot-name]
                                                  [--use-existing-snapshot {0, 1, f, false, n, no, t, true, y, yes}]

Required Parameters

--account-name -a

The name of the NetApp account.

--backup-name --name -b -n

The name of the backup.

--backup-vault-name -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>.

--volume-resource-id

ResourceId used to identify the Volume.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--label

Label for backup.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

--snapshot-name

The name of the snapshot.

Property	Value
Parameter group:	Properties Arguments

--use-existing-snapshot

Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups.

Property	Value
Parameter group:	Properties Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

Preview

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

Create a backup under the Backup Vault.

az netappfiles account backup-vault backup create --account-name
                                                  --backup-name --name
                                                  --backup-vault-name
                                                  --resource-group
                                                  --volume-resource-id
                                                  [--label]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--snapshot-name]
                                                  [--use-existing-snapshot {0, 1, f, false, n, no, t, true, y, yes}]

Required Parameters

--account-name -a

The name of the NetApp account.

--backup-name --name -b -n

The name of the backup.

--backup-vault-name -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>.

--volume-resource-id

ResourceId used to identify the Volume.

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--label

Label for backup.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

--snapshot-name

The name of the snapshot.

Property	Value
Parameter group:	Properties Arguments

--use-existing-snapshot

Manual backup an already existing snapshot. This will always be false for scheduled backups and true/false for manual backups.

Property	Value
Parameter group:	Properties Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az netappfiles account backup-vault backup delete

Edit

Delete a Backup under the Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

Preview

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

Delete a Backup under the Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles account backup-vault backup list

Edit

List all backups Under a Backup Vault.

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

Required Parameters

--account-name -a

The name of the NetApp account.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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

Preview

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

List all backups Under a Backup Vault.

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

Required Parameters

--account-name -a

The name of the NetApp account.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

An option to specify the VolumeResourceId. If present, then only returns the backups under the specified volume.

--max-items

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az netappfiles account backup-vault backup restore-file

Edit

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

az netappfiles account backup-vault backup restore-file --destination-volume-id
                                                        --file-list
                                                        [--account-name]
                                                        [--backup-name]
                                                        [--backup-vault-name]
                                                        [--ids]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--restore-file-path]
                                                        [--subscription]

Required Parameters

--destination-volume-id

Resource Id of the destination volume on which the files need to be restored.

Property	Value
Parameter group:	Body Arguments

--file-list

List of files to be restored Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name -b

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--restore-file-path

Destination folder where the files will be restored. The path name should start with a forward slash. If it is omitted from request then restore is done at the root folder of the destination volume by default.

Property	Value
Parameter group:	Body Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles account backup-vault backup restore-file (netappfiles-preview extension)

Preview

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

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

az netappfiles account backup-vault backup restore-file --destination-volume-id
                                                        --file-list
                                                        [--account-name]
                                                        [--backup-name]
                                                        [--backup-vault-name]
                                                        [--ids]
                                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                        [--resource-group]
                                                        [--restore-file-path]
                                                        [--subscription]

Required Parameters

--destination-volume-id

Resource Id of the destination volume on which the files need to be restored.

Property	Value
Parameter group:	Body Arguments

--file-list

List of files to be restored Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name -b

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--restore-file-path

Property	Value
Parameter group:	Body Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles account backup-vault backup show

Edit

Get the specified Backup under Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

Preview

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

Get the specified Backup under Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles account backup-vault backup update

Edit

Update a backup under the Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--label

Label for backup.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

Preview

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

Update a backup under the Backup Vault.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--label

Label for backup.

Property	Value
Parameter group:	Properties Arguments

--no-wait

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

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles account backup-vault backup wait

Edit

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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

Preview

Command group 'az netappfiles account backup-vault backup' 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 backup wait [--account-name]
                                                [--backup-name --name]
                                                [--backup-vault-name]
                                                [--created]
                                                [--custom]
                                                [--deleted]
                                                [--exists]
                                                [--ids]
                                                [--interval]
                                                [--resource-group]
                                                [--subscription]
                                                [--timeout]
                                                [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--backup-name --name -b -n

The name of the backup.

Property	Value
Parameter group:	Resource Id Arguments

--backup-vault-name -v

The name of the Backup Vault.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az netappfiles account backup-vault backup

Commands

az netappfiles account backup-vault backup create

Required Parameters

Optional Parameters

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

Required Parameters

Optional Parameters

az netappfiles account backup-vault backup delete

Optional Parameters

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

Optional Parameters

az netappfiles account backup-vault backup list

Required Parameters

Optional Parameters

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

Required Parameters

Optional Parameters

az netappfiles account backup-vault backup restore-file

Required Parameters

Optional Parameters

az netappfiles account backup-vault backup restore-file (netappfiles-preview extension)

Required Parameters

Optional Parameters

az netappfiles account backup-vault backup show

Optional Parameters

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

Optional Parameters

az netappfiles account backup-vault backup update

Optional Parameters

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

Optional Parameters

az netappfiles account backup-vault backup wait

Optional Parameters

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

Optional Parameters

Feedback