az dataprotection backup-policy

  • Experimental
  • Reference

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.51.0 or higher). The extension will automatically install the first time you run an az dataprotection backup-policy command. Learn more about extensions.

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage backup policy with dataprotection.

Commands

Name Description Type Status
az dataprotection backup-policy create

Create a backup policy belonging to a backup vault.

 Extension Experimental
az dataprotection backup-policy delete

Deletes a backup policy belonging to a backup vault.

 Extension Experimental
az dataprotection backup-policy get-default-policy-template

Get default policy template for a given datasource type.

 Extension Experimental
az dataprotection backup-policy list

List list of backup policies belonging to a backup vault.

 Extension Experimental
az dataprotection backup-policy retention-rule

Create lifecycles and add or remove retention rules in a backup policy.

 Extension Experimental
az dataprotection backup-policy retention-rule create-lifecycle

Create lifecycle for Azure Retention rule.

 Extension Experimental
az dataprotection backup-policy retention-rule remove

Remove existing retention rule in a backup policy.

 Extension Experimental
az dataprotection backup-policy retention-rule set

Add new retention rule or update existing retention rule.

 Extension Experimental
az dataprotection backup-policy show

Get a backup policy belonging to a backup vault.

 Extension Experimental
az dataprotection backup-policy tag

Create criterias and add or remove tag in policy.

 Extension Experimental
az dataprotection backup-policy tag create-absolute-criteria

Create absolute criteria.

 Extension Experimental
az dataprotection backup-policy tag create-generic-criteria

Create generic criteria.

 Extension Experimental
az dataprotection backup-policy tag remove

Remove existing tag from a backup policy.

 Extension Experimental
az dataprotection backup-policy tag set

Add new tag or update existing tag of a backup policy.

 Extension Experimental
az dataprotection backup-policy trigger

Manage backup schedule of a backup policy.

 Extension Experimental
az dataprotection backup-policy trigger create-schedule

Create backup schedule of a policy.

 Extension Experimental
az dataprotection backup-policy trigger set

Associate backup schedule to a backup policy.

 Extension Experimental
az dataprotection backup-policy update

Update a backup policy belonging to a backup vault.

 Extension Experimental

az dataprotection backup-policy create

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a backup policy belonging to a backup vault.

az dataprotection backup-policy create --backup-policy-name
                                       --policy
                                       --resource-group
                                       --vault-name

Examples

Create Backup Policy

az dataprotection backup-policy create -g sarath-rg --vault-name sarath-vault -n mypolicy --policy policy.json

Required Parameters

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

Name of the policy.

--policy

Request body for operation Expected value: json-string/@json-file. Support json-file and yaml-file.

--resource-group -g

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

--vault-name

The name of the backup vault.

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

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes a backup policy belonging to a backup vault.

az dataprotection backup-policy delete [--backup-policy-name]
                                       [--ids]
                                       [--resource-group]
                                       [--subscription]
                                       [--vault-name]
                                       [--yes]

Examples

Delete Backup Policy

az dataprotection backup-policy delete --name "OSSDBPolicy" --resource-group "000pikumar" --vault-name "PrivatePreviewVault"

Optional Parameters

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

Name of the 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.

--vault-name -v

The name of the backup vault.

--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 dataprotection backup-policy get-default-policy-template

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get default policy template for a given datasource type.

az dataprotection backup-policy get-default-policy-template --datasource-type {AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService}

Examples

Get default policy template for Azure Disk

az dataprotection backup-policy get-default-policy-template --datasource-type AzureDisk

Required Parameters

--datasource-type

Specify the datasource type of the resource to be backed up.

accepted values: AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService
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 dataprotection backup-policy list

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List list of backup policies belonging to a backup vault.

az dataprotection backup-policy list --resource-group
                                     --vault-name
                                     [--max-items]
                                     [--next-token]

Examples

List Backup Policies

az dataprotection backup-policy list --resource-group "000pikumar" --vault-name "PrivatePreviewVault"

Required Parameters

--resource-group -g

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

--vault-name -v

The name of the backup vault.

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

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get a backup policy belonging to a backup vault.

az dataprotection backup-policy show [--backup-policy-name]
                                     [--ids]
                                     [--resource-group]
                                     [--subscription]
                                     [--vault-name]

Examples

Get Backup Policy

az dataprotection backup-policy show --name "OSSDBPolicy" --resource-group "000pikumar" --vault-name "PrivatePreviewVault"

Optional Parameters

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

Name of the 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.

--vault-name -v

The name of the backup vault.

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

Experimental

Command group 'az dataprotection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update a backup policy belonging to a backup vault.

az dataprotection backup-policy update [--add]
                                       [--backup-policy-name]
                                       [--datasource-types]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--ids]
                                       [--policy]
                                       [--remove]
                                       [--resource-group]
                                       [--set]
                                       [--subscription]
                                       [--vault-name]

Optional Parameters

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

Name of the policy.

--datasource-types

Type of datasource for the backup management Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--policy

Request body for operation Expected value: json- string/@json-file. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--vault-name -v

The name of the backup vault.

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.