Backup-AzKeyVault

モジュール:

Az.KeyVault

マネージド HSM を完全にバックアップします。

構文

Backup-AzKeyVault
      [-HsmName] <String>
      -StorageAccountName <String>
      -StorageContainerName <String>
      [-SasToken <SecureString>]
      [-UseUserManagedIdentity]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-AzKeyVault
      [-HsmName] <String>
      -StorageContainerUri <Uri>
      [-SasToken <SecureString>]
      [-UseUserManagedIdentity]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-AzKeyVault
      -StorageContainerUri <Uri>
      [-SasToken <SecureString>]
      [-UseUserManagedIdentity]
      -HsmObject <PSManagedHsm>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Backup-AzKeyVault
      -StorageAccountName <String>
      -StorageContainerName <String>
      [-SasToken <SecureString>]
      [-UseUserManagedIdentity]
      -HsmObject <PSManagedHsm>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

マネージド HSM をストレージ アカウントに完全にバックアップします。 Restore-AzKeyVaultを使用してバックアップを復元します。

例

例 1 SAS トークンを使用して HSM をストレージ コンテナーにバックアップする

$sasToken = ConvertTo-SecureString -AsPlainText -Force "?sv=2019-12-12&ss=bfqt&srt=sco&sp=rwdlacupx&se=2020-10-12T14:42:19Z&st=2020-10-12T06:42:19Z&spr=https&sig=******"

Backup-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -SasToken $sasToken

https://{accountName}.blob.core.windows.net/{containerName}/{backupFolder}

このコマンドレットは、ストレージ コンテナーにフォルダー (通常は mhsm-{name}-{timestamp} という名前) を作成し、そのフォルダーにバックアップを格納し、フォルダー URI を出力します。

例 2 ユーザー割り当てマネージド ID 認証を使用して HSM をストレージ コンテナーにバックアップする

# Make sure an identity is assigend to the Hsm
Update-AzKeyVaultManagedHsm -UserAssignedIdentity "/subscriptions/{sub-id}/resourceGroups/{rg-name}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identity-name}"
Backup-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -UseUserManagedIdentity

https://{accountName}.blob.core.windows.net/{containerName}/{backupFolder}

コマンドレットは、特定のストレージ コンテナー内の hsm をバックアップし、ユーザー割り当てマネージド ID 認証を使用してフォルダー URI を出力します。 マネージド ID には、ストレージ コンテナーへのアクセス許可を割り当てる必要があります。

例 3 ストレージ アカウント名とストレージ コンテナーを使用して HSM をストレージ コンテナーにバックアップする

Backup-AzKeyVault -HsmName myHsm -StorageAccountName "{accountName}" -StorageContainerName "{containerName}" -UseUserManagedIdentity

https://{accountName}.blob.core.windows.net/{containerName}/{backupFolder}

このコマンドレットは、ストレージ コンテナーにフォルダー (通常は mhsm-{name}-{timestamp} という名前) を作成し、そのフォルダーにバックアップを格納し、フォルダー URI を出力します。

パラメーター

-Confirm

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

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

-DefaultProfile

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

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

-HsmName

HSM の名前。

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

-HsmObject

Managed HSM オブジェクト

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

-SasToken

ストレージ アカウントを認証するための Shared Access Signature (SAS) トークン。

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

-StorageAccountName

バックアップが格納されるストレージ アカウントの名前。

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

-StorageContainerName

バックアップが格納される BLOB コンテナーの名前。

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

-StorageContainerUri

バックアップが格納されるストレージ コンテナーの URI。

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

-UseUserManagedIdentity

ユーザー マネージド ID を使用してストレージ アカウントを認証するように指定します。 SasToken が設定されていない場合にのみ有効です。

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

-WhatIf

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

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

入力

None

出力

String