az dataprotection backup-policy

Note

This reference is part of the dataprotection extension for the Azure CLI (version 2.67.0 or higher). 该扩展会在首次运行 az dataprotection backup-policy 命令时自动安装。 Learn more about extensions.

使用数据保护管理备份策略。

命令

名称	说明	类型	Status
az dataprotection backup-policy create	创建属于备份保管库的备份策略。	Extension	GA
az dataprotection backup-policy delete	删除属于备份保管库的备份策略。	Extension	GA
az dataprotection backup-policy get-default-policy-template	获取给定数据源类型的默认策略模板。	Extension	GA
az dataprotection backup-policy list	列出属于备份保管库的备份策略列表。	Extension	GA
az dataprotection backup-policy retention-rule	在备份策略中创建生命周期并添加或删除保留规则。	Extension	GA
az dataprotection backup-policy retention-rule create-lifecycle	为 Azure 保留规则创建生命周期。	Extension	GA
az dataprotection backup-policy retention-rule remove	删除备份策略中的现有保留规则。	Extension	GA
az dataprotection backup-policy retention-rule set	添加新的保留规则或更新现有保留规则。	Extension	GA
az dataprotection backup-policy show	获取属于备份保管库的备份策略。	Extension	GA
az dataprotection backup-policy tag	在策略中创建条件并添加或删除标记。	Extension	GA
az dataprotection backup-policy tag create-absolute-criteria	创建绝对条件。	Extension	GA
az dataprotection backup-policy tag create-generic-criteria	创建通用条件。	Extension	GA
az dataprotection backup-policy tag remove	从备份策略中删除现有标记。	Extension	GA
az dataprotection backup-policy tag set	添加新标记或更新备份策略的现有标记。	Extension	GA
az dataprotection backup-policy trigger	管理备份策略的备份计划。	Extension	GA
az dataprotection backup-policy trigger create-schedule	创建策略的备份计划。	Extension	GA
az dataprotection backup-policy trigger set	将备份计划关联到备份策略。	Extension	GA
az dataprotection backup-policy update	更新属于备份保管库的备份策略。	Extension	GA

az dataprotection backup-policy create

创建属于备份保管库的备份策略。

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

示例

创建备份策略

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

必需参数

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

策略的名称。

--policy

作的请求正文预期值：json-string/@json-file。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--vault-name

备份保管库的名称。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dataprotection backup-policy delete

删除属于备份保管库的备份策略。

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

示例

删除备份策略

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

可选参数

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

策略的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--vault-name -v

备份保管库的名称。

属性	值
Parameter group:	Resource Id Arguments

--yes -y

不要提示确认。

属性	值
默认值:	False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

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

获取给定数据源类型的默认策略模板。

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

示例

获取 Azure 磁盘的默认策略模板

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

必需参数

--datasource-type

指定要备份的资源的数据源类型。

属性	值
接受的值:	AzureBlob, AzureDatabaseForMySQL, AzureDatabaseForPostgreSQL, AzureDatabaseForPostgreSQLFlexibleServer, AzureDisk, AzureKubernetesService

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dataprotection backup-policy list

列出属于备份保管库的备份策略列表。

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

示例

列出备份策略

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

必需参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

--vault-name -v

备份保管库的名称。

可选参数

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

--max-items

命令输出中要返回的项总数。 如果可用的项总数大于指定的值，则会在命令的输出中提供令牌。 若要恢复分页，请在后续命令的 --next-token 参数中提供令牌值。

属性	值
Parameter group:	Pagination Arguments

--next-token

用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。

属性	值
Parameter group:	Pagination Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dataprotection backup-policy show

获取属于备份保管库的备份策略。

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

示例

获取备份策略

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

可选参数

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

策略的名称。

属性	值
Parameter group:	Resource Id Arguments

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--vault-name -v

备份保管库的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False

az dataprotection backup-policy update

更新属于备份保管库的备份策略。

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]

可选参数

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

--add

通过指定路径和键值对将对象添加到对象列表。 示例：--add property.listProperty <key=value, string or JSON string>。

属性	值
Parameter group:	Generic Update Arguments

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

策略的名称。

属性	值
Parameter group:	Resource Id Arguments

--datasource-types

备份管理支持的速记语法、json-file 和 yaml-file 的数据源类型。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--force-string

使用“set”或“add”时，保留字符串文本，而不是尝试转换为 JSON。

属性	值
Parameter group:	Generic Update Arguments
接受的值:	0, 1, f, false, n, no, t, true, y, yes

--ids

一个或多个资源 ID（以空格分隔）。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。

属性	值
Parameter group:	Resource Id Arguments

--policy

作的请求正文预期值：json- string/@json-file。 支持速记语法、json-file 和 yaml-file。 请尝试“？？” 以显示更多内容。

属性	值
Parameter group:	Properties Arguments

--remove

从列表中删除属性或元素。 示例： --remove property.list <indexToRemove> OR --remove propertyToRemove.

属性	值
Parameter group:	Generic Update Arguments

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name>配置默认组。

属性	值
Parameter group:	Resource Id Arguments

--set

通过指定要设置的属性路径和值来更新对象。 示例：--set property1.property2=<value>。

属性	值
Parameter group:	Generic Update Arguments

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

属性	值
Parameter group:	Resource Id Arguments

--vault-name -v

备份保管库的名称。

属性	值
Parameter group:	Resource Id Arguments

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

属性	值
默认值:	False

--help -h

显示此帮助消息并退出。

--only-show-errors

仅显示错误，禁止显示警告。

属性	值
默认值:	False

--output -o

Output format.

属性	值
默认值:	json
接受的值:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--verbose

增加日志记录详细程度。 使用 --debug 获取完整的调试日志。

属性	值
默认值:	False