Update-AzRecoveryServicesVault

參考

模組:: Az.RecoveryServices

更新 MSIdentity 至復原服務保存庫。

Syntax

Update-AzRecoveryServicesVault
      [-ResourceGroupName] <String>
      [-Name] <String>
      [-IdentityId <String[]>]
      [-RemoveUserAssigned]
      [-RemoveSystemAssigned]
      [-DisableClassicAlerts <Boolean>]
      [-DisableAzureMonitorAlertsForJobFailure <Boolean>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-ImmutabilityState <ImmutabilityState>]
      [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzRecoveryServicesVault
      [-ResourceGroupName] <String>
      [-Name] <String>
      -IdentityType <MSIdentity>
      [-IdentityId <String[]>]
      [-DisableClassicAlerts <Boolean>]
      [-DisableAzureMonitorAlertsForJobFailure <Boolean>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-ImmutabilityState <ImmutabilityState>]
      [-CrossSubscriptionRestoreState <CrossSubscriptionRestoreState>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

此 Cmdlet 可用來從復原服務保存庫新增或移除 MSI。使用 -IdentityType 參數將 SystemAssigned/UserAssigned 身分識別新增至 RSVault。使用 RemoveSystemAssigned/RemoveUserAssigned 參數，從保存庫移除 MSI。

範例

範例 1：將 SystemAssigned 身分識別新增至復原服務保存庫

Update-AzRecoveryServicesVault -ResourceGroupName "rgName" -Name "vaultName" -IdentityType SystemAssigned

此 Cmdlet 可用來將 SystemAssigned 身分識別新增至復原服務保存庫。

範例 2：將 UserAssigned 身分識別新增至復原服務保存庫

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$identity1 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity1"
$identity2 = Get-AzUserAssignedIdentity -ResourceGroupName "resourceGroupName" -Name "UserIdentity2"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -IdentityType UserAssigned -IdentityId $identity1.Id, $identity2.Id
$updatedVault.Identity | Format-List

PrincipalId            :
TenantId               : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Type                   : UserAssigned
UserAssignedIdentities : {[/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity1,
                         Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity],
                         [/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/UserIdentity2,
                         Microsoft.Azure.Management.RecoveryServices.Models.UserIdentity]}

第一個 Cmdlet 會擷取復原服務保存庫。第二個和第三個 Cmdlet 會擷取使用者建立的 MSIs。第四個 Cmdlet 會將使用者 MSIS 新增至保存庫。第五個 Cmdlet 會顯示新增至保存庫的身分識別。

範例 3：從保存庫移除 SystemAssigned 和 UserAssigned 身分識別

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveSystemAssigned
$AllUserIdentities =  $vault.Identity.UserAssignedIdentities.Keys | ForEach-Object {$_} 
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -RemoveUserAssigned -IdentityId $AllUserIdentities
$updatedVault.Identity | Format-List

PrincipalId            :
TenantId               :
Type                   : None
UserAssignedIdentities :

第一個 Cmdlet 會擷取復原服務保存庫。第二個 Cmdlet 會從保存庫移除 SystemAssigned 身分識別。第三個 Cmdlet 會從保存庫擷取所有使用者 MSIS 作為清單。第四個 Cmdlet 會從保存庫移除所有使用者 MSIS。如果您想要的話，您可以提供選取的使用者身分識別，以逗號分隔的方式移除，如上一個範例所示。第五個 Cmdlet 會顯示保存庫中的身分識別，因為我們移除所有身分識別，Type 會顯示為 None。

範例 4：更新 PublicNetworkAccess、復原服務保存庫的 ImmutabilityState

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -PublicNetworkAccess "Disabled" -ImmutabilityState "Unlocked"
$updatedVault.Properties.PublicNetworkAccess
$updatedVault.Properties.ImmutabilitySettings.ImmutabilityState

Disabled
Unlocked

第一個 Cmdlet 會擷取復原服務保存庫。第二個 Cmdlet 會更新復原服務保存庫的 PublicNetworkAccess、ImmutabilityState 屬性。第三個和第四個命令是用來擷取保存庫的公用網路存取和不變狀態。

範例 5：啟用/停用復原服務保存庫的 CrossSubscriptionRestore

$vault = Get-AzRecoveryServicesVault -Name "vaultName" -ResourceGroupName "resourceGroupName"
$updatedVault = Update-AzRecoveryServicesVault -ResourceGroupName $vault.ResourceGroupName -Name $vault.Name -CrossSubscriptionRestoreState Disabled
$updatedVault.Properties.RestoreSettings.CrossSubscriptionRestoreSettings.CrossSubscriptionRestoreState

Disabled

第一個 Cmdlet 會擷取復原服務保存庫。第二個 Cmdlet 會更新復原服務保存庫的 CrossSubscriptionRestoreState。第三個命令會取得保存庫的跨訂用帳戶還原狀態。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CrossSubscriptionRestoreState

保存庫的跨訂用帳戶還原狀態。允許的值為「Enabled」、“Disabled”、“PermanentlyDisabled”。

Type:	Nullable<T>[CrossSubscriptionRestoreState]
Accepted values:	Enabled, Disabled, PermanentlyDisabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

用於與 Azure 通訊的認證、帳戶、租用戶和訂用帳戶。

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableAzureMonitorAlertsForJobFailure

布爾參數，以指定是否應該針對每個作業失敗接收內建的 Azure 監視器警示。

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisableClassicAlerts

布爾參數指定是否應停用或啟用來自傳統解決方案的備份警示。

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityId

要新增/移除之 UserAssigned Identity 的 ARM 識別符。這是以逗號分隔的識別標識碼清單。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IdentityType

指派給復原服務保存庫的 MSI 類型。

Type:	MSIdentity
Accepted values:	SystemAssigned, None, UserAssigned
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ImmutabilityState

保存庫的不變性狀態。允許的值為「Disabled」、“Unlocked”、“Locked”。已解除鎖定表示已啟用且可變更，鎖定表示已啟用且無法變更。

Type:	Nullable<T>[ImmutabilityState]
Accepted values:	Disabled, Unlocked, Locked
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

指定要更新的復原服務保存庫名稱。

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

啟用/停用保存庫公用網路存取的參數。此設定適用於私人端點。

Type:	Nullable<T>[PublicNetworkAccess]
Accepted values:	Enabled, Disabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveSystemAssigned

提供此參數以從保存庫移除 SystemAssigned Identity。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RemoveUserAssigned

提供此參數以從保存庫移除UserAssigned Identity。此外，請提供IdenityId參數以及這個參數。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

指定復原服務保存庫所在的 Azure 資源群組名稱。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

顯示執行 Cmdlet 後會發生的情況。未執行 Cmdlet。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

輸入

String

輸出

Vault