你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az dataprotection backup-vault

参考

注意

此参考是 Azure CLI（版本 2.57.0 或更高版本）的数据保护扩展的一部分。该扩展将在首次运行 az dataprotection backup-vault 命令时自动安装。详细了解扩展。

使用数据保护管理备份保管库。

命令

名称	说明	类型	状态
az dataprotection backup-vault create	创建属于资源组的 BackupVault 资源。	扩展	GA
az dataprotection backup-vault delete	从资源组中删除 BackupVault 资源。	扩展	GA
az dataprotection backup-vault list	获取订阅或资源组中的备份保管库列表。	扩展	GA
az dataprotection backup-vault list-from-resourcegraph	列出跨订阅、资源组和保管库的备份保管库。	扩展	GA
az dataprotection backup-vault resource-guard-mapping	管理备份保管库的 ResourceGuard 映射。	扩展	GA
az dataprotection backup-vault resource-guard-mapping create	创建 ResourceGuard 映射。	扩展	GA
az dataprotection backup-vault resource-guard-mapping delete	删除 ResourceGuard 映射。	扩展	GA
az dataprotection backup-vault resource-guard-mapping show	获取与保管库关联的 ResourceGuard 映射对象，该对象与请求中的名称匹配。	扩展	GA
az dataprotection backup-vault show	获取属于资源组的资源。	扩展	GA
az dataprotection backup-vault update	汇报属于资源组的 BackupVault 资源。例如，更新资源的标记。	扩展	GA
az dataprotection backup-vault wait	将 CLI 置于等待状态，直到满足条件。	扩展	GA

az dataprotection backup-vault create

创建属于资源组的 BackupVault 资源。

az dataprotection backup-vault create --resource-group
                                      --storage-setting
                                      --vault-name
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-infra-encryption {Disabled, Enabled}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--e-tag]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--location]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--retention-duration-in-days]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--tags]
                                      [--type]
                                      [--uami]

示例

创建 BackupVault

az dataprotection backup-vault create --type "None" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 MSI 创建 BackupVault

az dataprotection backup-vault create --type "systemAssigned" --location "WestUS" --azure-monitor-alerts-for-job-failures "Enabled" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --tags key1="val1" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 CMK 加密创建 BackupVault

az dataprotection backup-vault create -g "resourceGroupName" -v "vaultName" --location "eastasia" --storage-setting "[{type:'LocallyRedundant',datastore-type:'VaultStore'}]" --type "UserAssigned" --user-assigned-identities '{"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami":{}}' --cmk-encryption-key-uri "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1" --cmk-encryption-state "Enabled" --cmk-identity-type "UserAssigned" --cmk-infrastructure-encryption "Enabled" --cmk-user-assigned-identity-id  "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"

必需参数

--resource-group -g

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

--storage-setting --storage-settings

存储设置。用法：--storage-setting “[{type：'LocallyRedundant'，datastore-type：'VaultStore'}]”支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。单一标志： --storage-settings。

--vault-name -v

备份保管库的名称。

可选参数

--azure-monitor-alerts-for-job-failures --job-failure-alerts

指定是否应为所有失败的作业触发内置 Azure Monitor 警报的属性。

接受的值: Disabled, Enabled

--cmk-encryption-key-uri

要用于加密的 CMK 密钥的密钥 URI。若要启用密钥的自动轮换，请从密钥 URI 中排除版本组件。

--cmk-encryption-state

为备份保管库启用 CMK 加密状态。

接受的值: Disabled, Enabled, Inconsistent

--cmk-identity-type

用于 CMK 加密的标识类型 - SystemAssigned 或 UserAssigned Identity。

接受的值: SystemAssigned, UserAssigned

--cmk-infra-encryption --cmk-infrastructure-encryption

在此保管库上使用 CMK 启用/禁用基础结构加密。仅当创建保管库时，才必须配置基础结构加密。

接受的值: Disabled, Enabled

--cmk-uami --cmk-user-assigned-identity-id

如果标识类型为 UserAssigned，则此参数是必需的。添加用户分配的托管标识 ID，用于对密钥库具有访问权限。

--cross-region-restore-state --crr-state

设置 CrossRegionRestore 状态。启用后，无法将其设置为禁用。

接受的值: Disabled, Enabled

--cross-subscription-restore-state --csr-state

CrossSubscriptionRestore 状态。

接受的值: Disabled, Enabled, PermanentlyDisabled

--e-tag

可选 ETag。

--immutability-state

不可变状态。

接受的值: Disabled, Locked, Unlocked

--location -l

位置。 az account list-locations 中的值。可以使用 az configure --defaults location=<location> 配置默认位置。如果未指定，将使用资源组的位置。

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--retention-duration-in-days --soft-delete-retention

软删除保留期。

默认值: 14.0

--soft-delete-state

软删除的状态。

接受的值: AlwaysOn, Off, On

默认值: On

--tags

空格分隔标记：key[=value] [key[=value] ...]。使用“”清除现有标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--type

标识类型，可以是“SystemAssigned”、“UserAssigned”、“SystemAssigned、UserAssigned”或“None”。

--uami --user-assigned-identities

获取或设置用户分配的标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault delete

从资源组中删除 BackupVault 资源。

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

示例

删除 BackupVault

az dataprotection backup-vault delete --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

可选参数

--ids

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

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--subscription

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

--vault-name -v

备份保管库的名称。

--yes -y

不提示确认。

默认值: False

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault list

获取订阅或资源组中的备份保管库列表。

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

示例

列出订阅中的备份保管库

az dataprotection backup-vault list

列出资源组中的备份保管库

az dataprotection backup-vault list -g sarath-rg

可选参数

--max-items

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

--next-token

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

--resource-group -g

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

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault list-from-resourcegraph

列出跨订阅、资源组和保管库的备份保管库。

az dataprotection backup-vault list-from-resourcegraph [--resource-groups]
                                                       [--subscriptions]
                                                       [--vault-id]
                                                       [--vaults]

示例

提取特定的备份保管库

az dataprotection backup-vault list-from-resourcegraph --subscriptions 00000000-0000-0000-0000-000000000000 --resource-groups sample_rg --vaults sample_vault

可选参数

--resource-groups

资源组列表。

--subscriptions

订阅 ID 列表。

--vault-id

指定要应用的保管库 ID 筛选器。

--vaults

保管库名称列表。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault show

获取属于资源组的资源。

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

示例

获取 BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

使用 MSI 获取 BackupVault

az dataprotection backup-vault show --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

可选参数

--ids

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

--resource-group -g

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

--subscription

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

--vault-name -v

备份保管库的名称。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault update

汇报属于资源组的 BackupVault 资源。例如，更新资源的标记。

az dataprotection backup-vault update [--add]
                                      [--azure-monitor-alerts-for-job-failures {Disabled, Enabled}]
                                      [--cmk-encryption-key-uri]
                                      [--cmk-encryption-state {Disabled, Enabled, Inconsistent}]
                                      [--cmk-identity-type {SystemAssigned, UserAssigned}]
                                      [--cmk-uami]
                                      [--cross-region-restore-state {Disabled, Enabled}]
                                      [--cross-subscription-restore-state {Disabled, Enabled, PermanentlyDisabled}]
                                      [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--ids]
                                      [--immutability-state {Disabled, Locked, Unlocked}]
                                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--operation-requests]
                                      [--remove]
                                      [--resource-group]
                                      [--retention-duration-in-days]
                                      [--set]
                                      [--soft-delete-state {AlwaysOn, Off, On}]
                                      [--subscription]
                                      [--tags]
                                      [--tenant-id]
                                      [--type]
                                      [--uami]
                                      [--vault-name]

示例

Patch BackupVault

az dataprotection backup-vault update --azure-monitor-alerts-for-job-failures "Enabled" --tags newKey="newVal" --resource-group "SampleResourceGroup" --vault-name "swaggerExample"

可选参数

--add

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

--azure-monitor-alerts-for-job-failures --job-failure-alerts

指定是否应为所有失败的作业触发内置 Azure Monitor 警报的属性。

接受的值: Disabled, Enabled

--cmk-encryption-key-uri

客户管理的密钥的密钥 URI。

--cmk-encryption-state

为备份保管库启用 CMK 加密状态。

接受的值: Disabled, Enabled, Inconsistent

--cmk-identity-type

用于 CMK 加密的标识类型 - SystemAssigned 或 UserAssigned Identity。

接受的值: SystemAssigned, UserAssigned

--cmk-uami --cmk-user-assigned-identity-id

如果标识类型为 UserAssigned，则此参数是必需的。添加用户分配的托管标识 ID，用于对密钥库具有访问权限。

--cross-region-restore-state --crr-state

设置 CrossRegionRestore 状态。启用后，无法将其设置为禁用。

接受的值: Disabled, Enabled

--cross-subscription-restore-state --csr-state

CrossSubscriptionRestore 状态。

接受的值: Disabled, Enabled, PermanentlyDisabled

--force-string

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

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--ids

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

--immutability-state

不可变状态。

接受的值: Disabled, Locked, Unlocked

--no-wait

不等待长时间运行的操作完成。

接受的值: 0, 1, f, false, n, no, t, true, y, yes

--operation-requests --resource-guard-operation-requests

将对其执行 LAC 检查的 ResourceGuardOperationRequests 支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。单一标志： --operation-requests。

--remove

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

--resource-group -g

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

--retention-duration-in-days --soft-delete-retention

软删除保留期。

--set

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

--soft-delete-state

软删除的状态。

接受的值: AlwaysOn, Off, On

--subscription

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

--tags

资源标记。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--tenant-id

跨租户调用的租户 ID。

--type

标识类型，可以是“SystemAssigned”、“UserAssigned”、“SystemAssigned、UserAssigned”或“None”。

--uami --user-assigned-identities

获取或设置用户分配的标识。支持速记语法、json-file 和 yaml-file。请尝试“？？” 以显示更多内容。

--vault-name -v

备份保管库的名称。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

az dataprotection backup-vault wait

将 CLI 置于等待状态，直到满足条件。

az dataprotection backup-vault wait [--created]
                                    [--custom]
                                    [--deleted]
                                    [--exists]
                                    [--ids]
                                    [--interval]
                                    [--resource-group]
                                    [--subscription]
                                    [--timeout]
                                    [--updated]
                                    [--vault-name]

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--ids

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

--interval

轮询间隔（以秒为单位）。

默认值: 30

--resource-group -g

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

--subscription

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

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

--vault-name -v

备份保管库的名称。

全局参数

--debug

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

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

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

--subscription

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

--verbose

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

通过

az dataprotection backup-vault

命令

az dataprotection backup-vault create

示例

必需参数

可选参数

az dataprotection backup-vault delete

示例

可选参数

az dataprotection backup-vault list

示例

可选参数

az dataprotection backup-vault list-from-resourcegraph

示例

可选参数

az dataprotection backup-vault show

示例

可选参数

az dataprotection backup-vault update

示例

可选参数

az dataprotection backup-vault wait

可选参数

其他资源