Update-AzRecoveryServicesVault

リファレンス

モジュール:: Az.RecoveryServices

MSIdentity を Recovery Services コンテナーに更新します。

構文

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

説明

このコマンドレットは、Recovery Services コンテナーに MSI を追加または削除するために使用されます。 -IdentityType パラメーターを使用して、SystemAssigned/UserAssigned ID を RSVault に追加します。コンテナーから MSI を削除するには、RemoveSystemAssigned/RemoveUserAssigned スイッチを使用します。

例

例 1: SystemAssigned ID を Recovery Services コンテナーに追加する

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

このコマンドレットは、SystemAssigned ID を Recovery Services コンテナーに追加するために使用されます。

例 2: Recovery Services コンテナーに UserAssigned ID を追加する

$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]}

最初のコマンドレットは、Recovery Services コンテナーをフェッチします。 2 番目と 3 番目のコマンドレットは、ユーザーが作成した MIS をフェッチします。 4 番目のコマンドレットは、ユーザーの MSI をコンテナーに追加します。 5 番目のコマンドレットは、コンテナーに追加された ID を示しています。

例 3: コンテナーから SystemAssigned ID と UserAssigned ID を削除する

$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 :

最初のコマンドレットは、Recovery Services コンテナーをフェッチします。 2 番目のコマンドレットは、コンテナーから SystemAssigned ID を削除します。 3 番目のコマンドレットは、すべてのユーザーの MSI をコンテナーからリストとしてフェッチします。 4 番目のコマンドレットは、コンテナーからすべてのユーザー MSI を削除します。必要に応じて、前の例のように、選択したユーザー ID をコンマ区切りで削除するように指定できます。 5 番目のコマンドレットは、コンテナー内の ID を示しています。すべての ID を削除すると、Type は None として表示されます。

例 4: Recovery Services コンテナーの 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

最初のコマンドレットは、Recovery Services コンテナーをフェッチします。 2 番目のコマンドレットは、Recovery Services コンテナーの PublicNetworkAccess の ImmutabilityState プロパティを更新します。 3 番目と 4 番目のコマンドは、コンテナーのパブリックネットワークアクセスと不変状態をフェッチするために使用されます。

例 5: Recovery Services コンテナーの 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

最初のコマンドレットは、Recovery Services コンテナーをフェッチします。 2 番目のコマンドレットは、Recovery Services コンテナーの CrossSubscriptionRestoreState を更新します。 3 番目のコマンドは、コンテナーのクロスサブスクリプション復元状態を取得します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-CrossSubscriptionRestoreState

コンテナーのサブスクリプション間の復元状態。使用できる値は、"Enabled"、"Disabled"、"PermanentlyDisabled" です。

型:	Nullable<T>[CrossSubscriptionRestoreState]
指定可能な値:	Enabled, Disabled, PermanentlyDisabled
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableAzureMonitorAlertsForJobFailure

ジョブの失敗ごとに組み込みの Azure Monitor アラートを受信するかどうかを指定するブールパラメーター。

型:	Nullable<T>[Boolean]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DisableClassicAlerts

クラシックソリューションからのバックアップアラートを無効にするか有効にするかを指定するブールパラメーター。

型:	Nullable<T>[Boolean]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IdentityId

追加または削除する UserAssigned ID の ARM ID。これは、ID のコンマ区切りの一覧です。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-IdentityType

Recovery Services コンテナーに割り当てられた MSI の種類。

型:	MSIdentity
指定可能な値:	SystemAssigned, None, UserAssigned
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ImmutabilityState

コンテナーの不変状態。使用できる値は、"Disabled"、"Unlocked"、"Locked" です。 [ロック解除] は [有効] を意味し、変更できます。[ロック済み] は [有効] を意味し、変更することはできません。

型:	Nullable<T>[ImmutabilityState]
指定可能な値:	Disabled, Unlocked, Locked
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Name

更新する Recovery Services コンテナーの名前を指定します。

型:	String
配置:	2
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PublicNetworkAccess

コンテナーのパブリックネットワークアクセスを有効または無効にするパラメーター。この設定は、プライベートエンドポイントで役立ちます。

型:	Nullable<T>[PublicNetworkAccess]
指定可能な値:	Enabled, Disabled
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RemoveSystemAssigned

コンテナーから SystemAssigned ID を削除するには、このスイッチを指定します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-RemoveUserAssigned

このスイッチを指定して、コンテナーから UserAssigned ID を削除します。また、このスイッチと共に IdenityId パラメーターを指定します。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

Recovery Services コンテナーが存在する Azure リソースグループの名前を指定します。

型:	String
配置:	1
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Token

テナント間リソースガードによって保護される操作を承認するためのパラメーター。コマンドを使用します (Get-AzAccessToken -TenantId "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")。異なるテナントの承認トークンをフェッチするトークン

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

String

出力

Vault

次の方法で共有