Restore-AzKeyVault

  • リファレンス
モジュール:
Az.KeyVault

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

構文

Restore-AzKeyVault
       -BackupFolder <String>
       [-KeyName <String>]
       [-PassThru]
       [-HsmName] <String>
       -StorageAccountName <String>
       -StorageContainerName <String>
       [-SasToken <SecureString>]
       [-UseUserManagedIdentity]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVault
       -BackupFolder <String>
       [-KeyName <String>]
       [-PassThru]
       [-HsmName] <String>
       -StorageContainerUri <Uri>
       [-SasToken <SecureString>]
       [-UseUserManagedIdentity]
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVault
       -BackupFolder <String>
       [-KeyName <String>]
       [-PassThru]
       -StorageContainerUri <Uri>
       [-SasToken <SecureString>]
       [-UseUserManagedIdentity]
       -HsmObject <PSManagedHsm>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVault
       -BackupFolder <String>
       [-KeyName <String>]
       [-PassThru]
       -StorageAccountName <String>
       -StorageContainerName <String>
       [-SasToken <SecureString>]
       [-UseUserManagedIdentity]
       -HsmObject <PSManagedHsm>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

ストレージ アカウントに格納されているバックアップからマネージド HSM を完全に復元します。 バックアップに使用 Backup-AzKeyVault します。

例

例 1 キー コンテナーを復元する

$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=******"
Restore-AzKeyVault -HsmName myHsm -StorageContainerUri "https://{accountName}.blob.core.windows.net/{containerName}" -BackupFolder "mhsm-myHsm-2020101308504935" -SasToken $sasToken

この例では、ストレージ コンテナー "https://{accountName}.blob.core.windows.net/{containerName}" の "mhsm-myHsm-2020101308504935" という名前のフォルダーに格納されているバックアップを復元します。

例 2 ユーザー割り当てマネージド ID 認証を使用して Key Vault を復元する

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

この例では、ユーザー割り当てマネージド ID 認証を使用して HSM を復元します。

パラメーター

-BackupFolder

バックアップのフォルダー名 (例: 'mhsm--2020101309020403')。'backups/mhsm--2020101309020403' などの入れ子にすることもできます。

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

-Confirm

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

Type:SwitchParameter
Aliases:cf
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

-HsmName

HSM の名前。

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

-HsmObject

Managed HSM オブジェクト

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

-KeyName

復元するキー名。

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

-PassThru

HSM が復元されたときに true を返します。

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

-SasToken

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

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

-StorageAccountName

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

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

-StorageContainerName

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

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

-StorageContainerUri

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

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

-UseUserManagedIdentity

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

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

-WhatIf

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

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

入力

None

出力

Boolean