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 番目のコマンドは、指定されたタグをバックアップコンテナーに追加します。

例 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

このコマンドは、バックアップコンテナーのすべてのジョブエラーの監視アラートを無効にします。使用可能な値は、Enabled、Disabled です。既定では、この設定は有効になっています。

例 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: UserAssignedManagedIdentity から SystemAssignedManagedIdentity および CmkEncryptionKeyUri にコンテナー CmkIdentityType を更新する

$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: SystemAssignedManagedIdentity から UserAssignedManagedIdentity にコンテナー CmkIdentityType を更新する

$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: ユーザー割り当てマネージド ID (UAMI) を割り当てるためにコンテナーを更新する

$UAMI = @{"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.ManagedIdentity/userAssignedIdentities/userAssignedIdentityName"=[Microsoft.Azure.PowerShell.Cmdlets.DataProtection.Models.Api40.UserAssignedIdentity]::new()}

$vault = Update-AzDataProtectionBackupVault -AssignUserIdentity $UAMI -SubscriptionId "00000000-0000-0000-0000-000000000000" -VaultName "vaultName" -ResourceGroupName "resourceGroupName" -IdentityType 'SystemAssigned,UserAssigned'

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

まず、ユーザー割り当てマネージド ID (UAMI) オブジェクトのハッシュテーブルを作成します。このオブジェクトは、UAMI リソース ID を UserAssignedIdentity の新しいインスタンスにマップします。次に、Update-AzDataProtectionBackupVault コマンドレットを使用して、システム割り当てマネージド ID を維持しながら、バックアップコンテナーに UAMI を割り当てます。 -IdentityType パラメーターは、SystemAssigned ID と UserAssigned ID の両方を使用することを指定します。

パラメーター

-AsJob

コマンドをジョブとして実行する

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

-AzureMonitorAlertsForAllJobFailure

ジョブの失敗に関する組み込みの Azure Monitor アラートを有効または無効にするパラメーター。セキュリティアラートを無効にすることはできません。

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

-CmkEncryptionKeyUri

暗号化に使用する CMK キーのキー URI。キーの自動ローテーションを有効にするには、キー URI からバージョンコンポーネントを除外します。

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

-CmkEncryptionState

Backup Vault の CMK 暗号化状態を有効にします。

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

-CmkIdentityType

CMK 暗号化に使用する ID の種類 ( SystemAssigned または UserAssigned ID)。

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

-CmkUserAssignedIdentityId

ID の種類が UserAssigned の場合は、このパラメーターが必要です。 Key Vault へのアクセス許可を持つ、使用するユーザー割り当てマネージド ID を追加します。

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

-Confirm

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

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

-CrossRegionRestoreState

コンテナーのリージョン間の復元状態。使用できる値は無効、有効です。

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

-CrossSubscriptionRestoreState

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

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

-DefaultProfile

DefaultProfile パラメーターは機能しません。別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

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

-EncryptionSetting

リソースのカスタマーマネージドキーの詳細。構築するには、ENCRYPTIONSETTING プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

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

-IdentityType

SystemAssigned、UserAssigned、'SystemAssigned、UserAssigned' または None のいずれかを指定できる identityType。

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

-IdentityUserAssignedIdentity

ユーザー割り当て ID を取得または設定します。

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

-ImmutabilityState

コンテナーの不変状態。使用できる値は Disabled、Unlocked、Locked です。

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

-InputObject

ID パラメーターを構築するには、INPUTOBJECT プロパティの NOTES セクションを参照し、ハッシュテーブルを作成します。

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

-NoWait

コマンドを非同期的に実行する

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

-ResourceGroupName

リソースグループの名前。名前では大文字と小文字が区別されません。

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

-ResourceGuardOperationRequest

LAC チェックが実行される ResourceGuardOperationRequests

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

-SecureToken

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

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

-SoftDeleteRetentionDurationInDay

論理的な削除の保持期間 (日数)。

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

-SoftDeleteState

コンテナーの論理的な削除状態。使用できる値は Off、On、AlwaysOn です。

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

-SubscriptionId

ターゲットサブスクリプションの ID。値は UUID である必要があります。

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

-Tag

リソースタグ。

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

-Token

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

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

-VaultName

バックアップコンテナーの名前。

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

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

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

入力

IDataProtectionIdentity

出力

IBackupVaultResource

次の方法で共有