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>]
    [-CostManagementGranularity <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>]
    [-CostManagementSettingGranularityLevel <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>]

説明

リソース グループに属する 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監視を無効にする

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"

$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

まず、ユーザー割り当てマネージド ID (UAMI) ARM リソース ID を定義します。 次に、Update-AzDataProtectionBackupVault コマンドレットを使用して、システム割り当てマネージド ID を維持しながら、バックアップ コンテナーに UAMI を割り当てます。 -EnableSystemAssignedIdentity スイッチはシステム割り当て ID を有効にし、-UserAssignedIdentity パラメーターは、コンテナーに関連付けるユーザー割り当て ID を指定します。

パラメーター

-AsJob

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-AzureMonitorAlertsForAllJobFailure

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CmkEncryptionKeyUri

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CmkEncryptionState

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CmkIdentityType

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CmkUserAssignedIdentityId

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Confirm

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	Cf

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CostManagementGranularity

コンテナーのコスト管理の粒度。 使用できる値は、VaultLevel、ProtectedItemLevel、ProtectedItemWithParentTag です。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CostManagementSettingGranularityLevel

粒度レベルの設定

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CrossRegionRestoreState

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-CrossSubscriptionRestoreState

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DefaultProfile

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

パラメーターのプロパティ

型:	PSObject
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	AzureRMContext, AzureCredential

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-EnableSystemAssignedIdentity

リソースに対してシステム割り当て ID を有効にするかどうかを決定します。

パラメーターのプロパティ

型:	Nullable<T>[Boolean]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-EncryptionSetting

リソースのカスタマー マネージド キーの詳細。

パラメーターのプロパティ

型:	IEncryptionSettings
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ETag

省略可能な ETag。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ImmutabilityState

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-InputObject

IDENTITY パラメーター

パラメーターのプロパティ

型:	IDataProtectionIdentity
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	True
パイプラインからの値:	True
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-NoWait

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ReplicatedRegion

Backup Vault のレプリケートされたリージョンの一覧

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ResourceGroupName

リソース グループの名前。 名前は大文字と小文字を区別しません。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ResourceGuardOperationRequest

Resource Guard 操作要求は、 <ResourceGuard-ARMID>/<operation>/default のような形式です。 操作が MUA で保護されている場合は、このパラメーターを使用します。 サポートされる操作には、dppReduceImmutabilityStateRequests、dppReduceSoftDeleteSecurityRequests、dppModifyEncryptionSettingsRequests などがあります。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SecureToken

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

パラメーターのプロパティ

型:	SecureString
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SoftDeleteRetentionDurationInDay

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

パラメーターのプロパティ

型:	Double
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SoftDeleteState

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-StorageSetting

ストレージの設定

パラメーターのプロパティ

型:	IStorageSetting[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SubscriptionId

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

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Tag

リソース タグ。

パラメーターのプロパティ

型:	Hashtable
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Token

パラメーターは非推奨です。 代わりに SecureToken を使用してください。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-UserAssignedIdentity

リソースに関連付けられているユーザー割り当て ID の配列。 配列内の要素は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft の形式の ARM リソース ID になります。ManagedIdentity/userAssignedIdentities/{identityName}.'

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-VaultName

バックアップ ボールトの名前。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateExpanded

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
エイリアス:	wi

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-XmsDeletedVaultId

削除取り消しフロー中に復元する削除されたバックアップ コンテナーの ID。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

UpdateViaIdentityExpanded

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。

入力

IDataProtectionIdentity

出力

IBackupVaultResource