Update-AzDataProtectionBackupVault

模組:: Az.DataProtection Module

更新屬於資源群組的 BackupVault 資源。

語法

UpdateExpanded (預設值)

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

UpdateViaIdentityExpanded

Update-AzDataProtectionBackupVault
    -InputObject <IDataProtectionIdentity>
    [-Token <String>]
    [-XmsDeletedVaultId <String>]
    [-AzureMonitorAlertsForAllJobFailure <String>]
    [-CrossRegionRestoreState <String>]
    [-CrossSubscriptionRestoreState <String>]
    [-ETag <String>]
    [-EnableSystemAssignedIdentity <Boolean>]
    [-EncryptionSetting <IEncryptionSettings>]
    [-ImmutabilityState <String>]
    [-ReplicatedRegion <String[]>]
    [-ResourceGuardOperationRequest <String[]>]
    [-SoftDeleteRetentionDurationInDay <Double>]
    [-SoftDeleteState <String>]
    [-StorageSetting <IStorageSetting[]>]
    [-Tag <Hashtable>]
    [-UserAssignedIdentity <String[]>]
    [-DefaultProfile <PSObject>]
    [-AsJob]
    [-NoWait]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

更新屬於資源群組的 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 是必填參數。

範例 6：更新保存庫以指派使用者指派的受控識別（UAMI）

$UAMI = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userAssignedIdentityName"

$vault = Update-AzDataProtectionBackupVault -EnableSystemAssignedIdentity -UserAssignedIdentity $UAMI -SubscriptionId "00000000-0000-0000-0000-000000000000" -VaultName "vaultName" -ResourceGroupName "resourceGroupName"

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

首先，定義使用者指派管理身份（UAMI）ARM 資源識別碼。接下來，使用 Update-AzDataProtectionBackupVault Cmdlet 將 UAMI 指派給備份保存庫，同時保留系統指派的受控識別。 -EnableSystemAssignedIdentity 交換器啟用系統指派的身份，-UserAssignedIdentity 參數則指定要與保險庫關聯的使用者指派身份。

參數

-AsJob

以作業身分執行命令

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-AzureMonitorAlertsForAllJobFailure

啟用或停用作業失敗內建 Azure 監視器警示的參數。無法停用安全性警示。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CmkEncryptionKeyUri

要用於加密之 CMK 金鑰的金鑰 URI。若要啟用金鑰的自動輪替，請從金鑰 URI 中排除版本元件。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CmkEncryptionState

啟用備份保存庫的 CMK 加密狀態。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CmkIdentityType

要用於 CMK 加密的身分識別類型 - SystemAssigned 或 UserAssigned Identity。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CmkUserAssignedIdentityId

如果身分識別類型為UserAssigned，則需要此參數。新增使用者指派的管理身份識別碼，該 ID 擁有金鑰保存庫的存取權限。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	cf

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CrossRegionRestoreState

跨區域還原保存庫的狀態。允許的值為 Disabled、Enabled。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-CrossSubscriptionRestoreState

保存庫的跨訂閱還原狀態。允許的值為 Disabled、Enabled、PermanentlyDisabled。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-DefaultProfile

DefaultProfile 參數無法運作。如果針對不同的訂用帳戶執行 Cmdlet，請使用 SubscriptionId 參數。

參數屬性

類型:	PSObject
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	AzureRMContext, AzureCredential

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-EnableSystemAssignedIdentity

決定是否要為資源啟用系統指派的身分識別。

參數屬性

類型:	Nullable<T>[Boolean]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-EncryptionSetting

客戶管理的資源金鑰詳細數據。

參數屬性

類型:	IEncryptionSettings
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ETag

選擇性 ETag。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ImmutabilityState

保存庫的不變性狀態。允許的值為 Disabled、Unlocked、Locked。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-InputObject

Identity 參數

參數屬性

類型:	IDataProtectionIdentity
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	True
來自管線的值:	True
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-NoWait

以異步方式執行命令

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ReplicatedRegion

備份保存庫的複寫區域清單

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceGroupName

資源群組的名稱。名稱不區分大小寫。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-ResourceGuardOperationRequest

資源守護操作請求格式類似 <ResourceGuard-ARMID>/<operation>/default。當作業受 MUA 保護時，請使用此參數。支援的操作包括 dppReduceImmutabilityStateRequests、dppReduceSoftDeleteSecurityRequests 以及 dppModifyEncryptionSettingsRequests。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SecureToken

授權受跨租用戶資源防護保護的作業的參數。使用命令（Get-AzAccessToken -TenantId “xxxxxxxx-xxxx-xxxx-xxxx -AsSecureString”）。擷取不同租用戶授權權杖的權杖。

參數屬性

類型:	SecureString
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SoftDeleteRetentionDurationInDay

虛刪除保留持續時間（以天為單位）。

參數屬性

類型:	Double
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SoftDeleteState

保存庫的虛刪除狀態。允許的值為 Off、On、AlwaysOn。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-StorageSetting

記憶體設定

參數屬性

類型:	IStorageSetting[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-SubscriptionId

目標訂用帳戶的標識碼。此值必須是 UUID。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Tag

資源標籤。

參數屬性

類型:	Hashtable
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Token

參數棄用。請改用 SecureToken。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-UserAssignedIdentity

與資源相關聯的使用者指派身分識別數位。陣列中的元素會是 ARM 資源 ID，格式如下：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft。ManagedIdentity/userAssignedIdentities/{identityName}.'

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-VaultName

備份保存庫的名稱。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateExpanded

Position:	Named
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	None
支援萬用字元:	False
不要顯示:	False
別名:	無線

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-XmsDeletedVaultId

在取消刪除流程期間要還原的已刪除備份保存庫識別碼。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

UpdateViaIdentityExpanded

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援常見參數： -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

Update-AzDataProtectionBackupVault

語法

UpdateExpanded (預設值)

UpdateViaIdentityExpanded

Description

範例

範例 1：將標籤新增至現有的備份保存庫

範例 2：停用 Azure monitor 工作失敗警報

範例 3：更新保存庫 ImmutabilityState、CrossSubscriptionRestoreState、虛刪除設定

範例 4：將保存庫 CmkIdentityType 從 UserAssignedManagedIdentity 更新為 SystemAssignedManagedIdentity 和 CmkEncryptionKeyUri

範例 5：將保存庫 CmkIdentityType 從 SystemAssignedManagedIdentity 更新為 UserAssignedManagedIdentity

範例 6：更新保存庫以指派使用者指派的受控識別 （UAMI）

參數

-AsJob

參數屬性

參數集

-AzureMonitorAlertsForAllJobFailure

參數屬性

參數集

-CmkEncryptionKeyUri

參數屬性

參數集

-CmkEncryptionState

參數屬性

參數集

-CmkIdentityType

參數屬性

參數集

-CmkUserAssignedIdentityId

參數屬性

參數集

-Confirm

參數屬性

參數集

-CrossRegionRestoreState

參數屬性

參數集

-CrossSubscriptionRestoreState

參數屬性

參數集

-DefaultProfile

參數屬性

參數集

-EnableSystemAssignedIdentity

參數屬性

參數集

-EncryptionSetting

參數屬性

參數集

-ETag

參數屬性

參數集

-ImmutabilityState

參數屬性

參數集

-InputObject

參數屬性

參數集

-NoWait

參數屬性

參數集

-ReplicatedRegion

參數屬性

參數集

-ResourceGroupName

參數屬性

參數集

-ResourceGuardOperationRequest

參數屬性

參數集

-SecureToken

參數屬性

參數集

-SoftDeleteRetentionDurationInDay

參數屬性

參數集

-SoftDeleteState

參數屬性

參數集

-StorageSetting

範例 6：更新保存庫以指派使用者指派的受控識別（UAMI）