Share via

az netappfiles account backup-policy

  • Reference

Manage Azure NetApp Files (ANF) Bakup Policy Resources.

Commands

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

Edit

Create a backup policy for Netapp Account.

az netappfiles account backup-policy create --account-name
                                            --backup-policy-name
                                            --resource-group
                                            [--daily-backups]
                                            [--enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--location]
                                            [--monthly-backups]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]
                                            [--weekly-backups]

Examples

Create an ANF backup policy

az netappfiles account backup-policy create -g mygroup --account-name myaccountname --backup-policy-name mybackuppolicyname -l westus2 --daily-backups 1 --enabled true

Required Parameters

--account-name -a

The name of the NetApp account.

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

Backup policy Name which uniquely identify backup policy.

--resource-group -g

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

Optional Parameters

--daily-backups -d

Daily backups count to keep.

--enabled -e

The property to decide policy is enabled or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
Default value: True
--location -l

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

--monthly-backups -m

Monthly backups count to keep.

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

--weekly-backups -w

Weekly backups count to keep.

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

Edit

Delete backup policy.

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

Examples

Delete the specified ANF backup policy.

az netappfiles account backup-policy delete -g mygroup --account-name myaccname --backup-policy-name mybackuppolicyname

Optional Parameters

--account-name -a

The name of the NetApp account.

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

Backup policy Name which uniquely identify backup policy.

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

Edit

List backup policies for Netapp Account.

az netappfiles account backup-policy list --account-name
                                          --resource-group

Examples

List the ANF backup policy for the specified account

az netappfiles account backup-policy list -g mygroup --account-name myname

Required Parameters

--account-name -a

The name of the NetApp account.

--resource-group -g

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

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

Edit

Get a particular backup Policy.

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

Examples

Get an ANF backup policy

az netappfiles account backup-policy show -g mygroup --account-name myaccname --backup-policy-name mybackuppolicyname

Optional Parameters

--account-name -a

The name of the NetApp account.

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

Backup policy Name which uniquely identify backup policy.

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

Edit

Update a backup policy for Netapp Account.

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

Examples

Update specific values for an ANF backup policy

az netappfiles account backup-policy update -g mygroup --account-name myaccountname --backup-policy-name mybackuppolicyname --daily-backups 1 --enabled false

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

Backup policy Name which uniquely identify backup policy.

--daily-backups -d

Daily backups count to keep.

--enabled -e

The property to decide policy is enabled or not.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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

--monthly-backups -m

Monthly backups count to keep.

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

--weekly-backups -w

Weekly backups count to keep.

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

Edit

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

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

Optional Parameters

--account-name -a

The name of the NetApp account.

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

Backup policy Name which uniquely identify backup policy.

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