az dataprotection backup-policy

Note

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

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	GA
az dataprotection backup-policy delete	Deletes a backup policy belonging to a backup vault.	Extension	GA
az dataprotection backup-policy get-default-policy-template	Get default policy template for a given datasource type.	Extension	GA
az dataprotection backup-policy list	List list of backup policies belonging to a backup vault.	Extension	GA
az dataprotection backup-policy retention-rule	Create lifecycles and add or remove retention rules in a backup policy.	Extension	GA
az dataprotection backup-policy retention-rule create-lifecycle	Create lifecycle for Azure Retention rule.	Extension	GA
az dataprotection backup-policy retention-rule remove	Remove existing retention rule in a backup policy.	Extension	GA
az dataprotection backup-policy retention-rule set	Add new retention rule or update existing retention rule.	Extension	GA
az dataprotection backup-policy show	Get a backup policy belonging to a backup vault.	Extension	GA
az dataprotection backup-policy tag	Create criterias and add or remove tag in policy.	Extension	GA
az dataprotection backup-policy tag create-absolute-criteria	Create absolute criteria.	Extension	GA
az dataprotection backup-policy tag create-generic-criteria	Create generic criteria.	Extension	GA
az dataprotection backup-policy tag remove	Remove existing tag from a backup policy.	Extension	GA
az dataprotection backup-policy tag set	Add new tag or update existing tag of a backup policy.	Extension	GA
az dataprotection backup-policy trigger	Manage backup schedule of a backup policy.	Extension	GA
az dataprotection backup-policy trigger create-schedule	Create backup schedule of a policy.	Extension	GA
az dataprotection backup-policy trigger set	Associate backup schedule to a backup policy.	Extension	GA
az dataprotection backup-policy update	Update a backup policy belonging to a backup vault.	Extension	GA

az dataprotection backup-policy create

Create a backup policy belonging to a backup vault.

az dataprotection backup-policy create --backup-policy-name --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 shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

Deletes a backup policy belonging to a backup vault.

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

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

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

Name of the policy.

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

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

--vault-name -v

The name of the backup vault.

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

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.

Property	Value
Accepted values:	AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService

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

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

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

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

Get a backup policy belonging to a backup vault.

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

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

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

Name of the policy.

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

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

--vault-name -v

The name of the backup vault.

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

Update a backup policy belonging to a backup vault.

az dataprotection backup-policy update [--add]
                                       [--backup-policy-name --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

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

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

Name of the policy.

Property	Value
Parameter group:	Resource Id Arguments

--datasource-types

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

Property	Value
Parameter group:	Properties 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

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

--policy

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

Property	Value
Parameter group:	Properties Arguments

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

--vault-name -v

The name of the backup vault.

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