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

Update-AzDataProtectionBackupVault

模块:

Az.DataProtection

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

语法

Update-AzDataProtectionBackupVault
      [-Token <String>]
      [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
      [-CrossRegionRestoreState <CrossRegionRestoreState>]
      [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
      [-IdentityType <String>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-ImmutabilityState <ImmutabilityState>]
      [-ResourceGuardOperationRequest <String[]>]
      [-SoftDeleteRetentionDurationInDay <Double>]
      [-SoftDeleteState <SoftDeleteState>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      -ResourceGroupName <String>
      -VaultName <String>
      [-SubscriptionId <String>]
      [-CmkEncryptionState <EncryptionState>]
      [-CmkIdentityType <IdentityType>]
      [-CmkUserAssignedIdentityId <String>]
      [-CmkEncryptionKeyUri <String>]
      [-SecureToken <SecureString>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDataProtectionBackupVault
      -InputObject <IDataProtectionIdentity>
      [-Token <String>]
      [-AzureMonitorAlertsForAllJobFailure <AlertsState>]
      [-CrossRegionRestoreState <CrossRegionRestoreState>]
      [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
      [-EncryptionSetting <IEncryptionSettings>]
      [-IdentityType <String>]
      [-IdentityUserAssignedIdentity <Hashtable>]
      [-ImmutabilityState <ImmutabilityState>]
      [-ResourceGuardOperationRequest <String[]>]
      [-SoftDeleteRetentionDurationInDay <Double>]
      [-SoftDeleteState <SoftDeleteState>]
      [-Tag <Hashtable>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

说明

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

示例

示例 1：将标记添加到现有备份保管库

$tag = @{"Owner"="sarath";"Purpose"="AzureBackupTesting"}
Update-AzDataProtectionBackupVault -SubscriptionId "xxx-xxx-xxx" -ResourceGroupName sarath-rg -VaultName sarath-vault -Tag $tag

ETag IdentityPrincipalId                  IdentityTenantId                     IdentityType   Location      Name         Type
---- -------------------                  ----------------                     ------------   --------      ----         ----
     2ca1d5f7-38b3-4b61-aa45-8147d7e0edbc 72f988bf-86f1-41af-91ab-2d7cd011db47 SystemAssigned centraluseuap sarath-vault Microsoft.DataProtection/backupVaults

第一个命令使用标记及其值创建新的标记哈希表。 第二个命令将给定标记添加到备份保管库。

示例 2：针对作业失败禁用 Azure Monitor 警报

Update-AzDataProtectionBackupVault -ResourceGroupName "rgName" -VaultName "vaultName" -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -AzureMonitorAlertsForAllJobFailure 'Disabled'

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

此命令禁用备份保管库的所有作业失败的监视器警报。 允许的值为：已启用、禁用。 请注意，默认情况下，此设置处于启用状态。

示例 3：更新保管库 ImmutabilityState、CrossSubscriptionRestoreState、软删除设置

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CrossSubscriptionRestoreState Disabled -ImmutabilityState Disabled -SoftDeleteRetentionDurationInDay 99 -SoftDeleteState Off

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

此命令用于修改不可变状态、跨订阅还原状态、保管库的软删除设置。 这些参数是可选的，可以独立使用。

示例 4：将保管库 CmkIdentityType 从 UserAssignedManagedIdentity 更新到 SystemAssignedManagedIdentity 和 CmkEncryptionKeyUri

$cmkKeyUri = "https://samplekvazbckp.vault.azure.net/keys/testkey/3cd5235ad6ac4c11b40a6f35444bcbe1"

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType SystemAssigned -CmkEncryptionKeyUri $cmkKeyUri

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults SystemAssigned

此命令用于修改 CmkIdentityType 和 CmkEncryptionKeyUri。 这些参数是可选的，可以独立使用。

示例 5：将保管库 CmkIdentityType 从 SystemAssignedManagedIdentity 更新为 UserAssignedManagedIdentity

$cmkIdentityId = "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/samplerg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/sampleuami"

Update-AzDataProtectionBackupVault -SubscriptionId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -ResourceGroupName "resourceGroupName" -VaultName "vaultName" -CmkIdentityType UserAssigned -CmkUserAssignedIdentityId $cmkIdentityId

Name          Location      Type                                  IdentityType
----          --------      ----                                  ------------
vaultName southeastasia Microsoft.DataProtection/backupVaults UserAssigned

此命令用于将 CmkIdentityType 从 SystemAssigned 更改为 UserAssgined。 CmkIdenityId 是必需参数。

参数

-AsJob

以作业身份运行命令

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-AzureMonitorAlertsForAllJobFailure

用于启用或禁用内置 Azure Monitor 警报的参数，说明作业失败。 无法禁用安全警报。

类型:	AlertsState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CmkEncryptionKeyUri

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

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CmkEncryptionState

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

类型:	EncryptionState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CmkIdentityType

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

类型:	IdentityType
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CmkUserAssignedIdentityId

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

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:	SwitchParameter
别名:	cf
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CrossRegionRestoreState

保管库的跨区域还原状态。 允许的值为 Disabled、Enabled。

类型:	CrossRegionRestoreState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-CrossSubscriptionRestoreState

保管库的跨订阅还原状态。 允许的值为 Disabled、Enabled、PermanentlyDisabled。

类型:	CrossSubscriptionRestoreState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-DefaultProfile

DefaultProfile 参数不起作用。 如果对其他订阅执行 cmdlet，请使用 SubscriptionId 参数。

类型:	PSObject
别名:	AzureRMContext, AzureCredential
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-EncryptionSetting

资源的客户托管密钥详细信息。 若要构造，请参阅 ENCRYPTIONSETTING 属性的 NOTES 部分并创建哈希表。

类型:	IEncryptionSettings
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IdentityType

标识类型，可以是 SystemAssigned、UserAssigned、'SystemAssigned、UserAssigned'或 None

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-IdentityUserAssignedIdentity

获取或设置用户分配的标识。

类型:	Hashtable
别名:	UserAssignedIdentity
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ImmutabilityState

保管库的不可变状态。 允许的值为 Disabled、Unlocked、Locked。

类型:	ImmutabilityState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-InputObject

要构造的标识参数，请参阅 INPUTOBJECT 属性的 NOTES 部分并创建哈希表。

类型:	IDataProtectionIdentity
Position:	Named
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-NoWait

异步运行命令

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-ResourceGroupName

资源组的名称。 此名称不区分大小写。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-ResourceGuardOperationRequest

将对其执行 LAC 检查的 ResourceGuardOperationRequests

类型:	String[]
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SecureToken

用于授权受跨租户资源防护保护的操作的参数。 使用命令 （Get-AzAccessToken -TenantId “xxxxxxxx-xxxx-xxxx-xxxx-xxx -AsSecureString”用于获取不同租户的授权令牌的令牌。

类型:	SecureString
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SoftDeleteRetentionDurationInDay

软删除保留期（以天为单位）。

类型:	Double
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SoftDeleteState

保管库的软删除状态。 允许的值为 Off、On、AlwaysOn。

类型:	SoftDeleteState
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-SubscriptionId

目标订阅的 ID。 该值必须是 UUID。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Tag

资源标记。

类型:	Hashtable
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Token

用于授权受跨租户资源防护保护的操作的参数。 使用命令 （Get-AzAccessToken -TenantId “xxxxxxxx-xxxx-xxxx-xxxx-xxxx-xxxxxx” ）用于获取不同租户的授权令牌的令牌。

类型:	String
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-VaultName

备份保管库的名称。

类型:	String
Position:	Named
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:	SwitchParameter
别名:	wi
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

IDataProtectionIdentity

输出

IBackupVaultResource