az netappfiles volume backup

Manage Azure NetApp Files (ANF) Volume Backup Resources.

Commands

Name	Description	Type	Status
az netappfiles volume backup create	Create a backup for the volume.	Core	GA
az netappfiles volume backup delete	Delete a backup of the volume.	Core	GA
az netappfiles volume backup list	List all backups for a volume.	Core	GA
az netappfiles volume backup restore-files	Restore the specified files from the specified backup to the active filesystem.	Core	GA
az netappfiles volume backup restore-status	Get volume's restore status.	Core	GA
az netappfiles volume backup show	Get the specified backup of the volume.	Core	GA
az netappfiles volume backup status	Get the status of the backup for a volume.	Core	GA
az netappfiles volume backup update	Update a backup for the volume.	Core	GA
az netappfiles volume backup wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az netappfiles volume backup create

Create a backup for the volume.

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

The name of the backup.

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--volume-name -n -v

The name of the volume.

Optional Parameters

--label

Label for backup.

--location -l

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

--use-existing-snapshot

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

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

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

Delete a backup of the volume.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-name --name -b

The name of the backup.

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

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--subscription

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup list

List all backups for a volume.

az netappfiles volume backup list --account-name
                                  --pool-name
                                  --resource-group
                                  --volume-name

Required Parameters

--account-name -a

The name of the NetApp account.

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup restore-files

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

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

Required Parameters

--destination-volume-id

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

--file-list

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-name

The name of the backup.

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

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

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

--subscription

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup restore-status

Get volume's restore status.

Get the status of the backup restore for a volume.

az netappfiles volume backup restore-status [--account-name]
                                            [--ids]
                                            [--name]
                                            [--pool-name]
                                            [--resource-group]
                                            [--subscription]

Examples

Get the status of the restore for a volume

az netappfiles volume backup restore-status  -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname

Optional Parameters

--account-name -a

The name of the NetApp account.

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

--name --volume-name -n -v

The name of the volume.

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--subscription

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

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 volume backup show

Get the specified backup of the volume.

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-name --name -b

The name of the backup.

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

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--subscription

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup status

Get the status of the backup for a volume.

az netappfiles volume backup status [--account-name]
                                    [--ids]
                                    [--pool-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--volume-name]

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.

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--subscription

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup update

Update a backup for the volume.

az netappfiles volume backup update [--account-name]
                                    [--add]
                                    [--backup-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}]
                                    [--pool-name]
                                    [--remove]
                                    [--resource-group]
                                    [--set]
                                    [--subscription]
                                    [--use-existing-snapshot {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--volume-name]

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

The name of the backup.

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

--label

Label for backup.

--no-wait

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

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

--pool-name -p

The name of the capacity pool.

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

--use-existing-snapshot

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

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

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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

az netappfiles volume backup wait

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

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

Optional Parameters

--account-name -a

The name of the NetApp account.

--backup-name --name -b

The name of the backup.

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

--pool-name -p

The name of the capacity pool.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

--volume-name -n -v

The name of the volume.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

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

--subscription

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

--verbose

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