Restore-AzKeyVaultKey

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

バックアップされたキーからキー コンテナーにキーを作成します。

構文

Restore-AzKeyVaultKey
       [-VaultName] <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVaultKey
       -HsmName <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVaultKey
       [-InputObject] <PSKeyVault>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVaultKey
       [-HsmObject] <PSManagedHsm>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVaultKey
       [-ResourceId] <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzKeyVaultKey
       -HsmResourceId <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

Restore-AzKeyVaultKey コマンドレットは、指定されたキー コンテナーにキーを作成します。 このキーは、入力ファイル内のバックアップ キーのレプリカであり、元のキーと同じ名前を持ちます。 キー コンテナーに同じ名前のキーが既にある場合、このコマンドレットは元のキーを上書きする代わりに失敗します。 バックアップに複数のバージョンのキーが含まれている場合、すべてのバージョンが復元されます。 キーを復元するキー コンテナーは、キーをバックアップしたキー コンテナーとは異なる場合があります。 ただし、キー コンテナーは同じサブスクリプションを使用し、同じ地域の Azure リージョンに存在する必要があります (たとえば、北米)。 Azure リージョンと地域のマッピングについては、Microsoft Azure セキュリティ センター (https://azure.microsoft.com/support/trust-center/) を参照してください。

例

例 1: バックアップ キーを復元する

Restore-AzKeyVaultKey -VaultName 'MyKeyVault' -InputFile "C:\Backup.blob"

Vault Name     : MyKeyVault
Name           : key1
Version        : 394f9379a47a4e2086585468de6c7ae5
Id             : https://mykeyvault.vault.azure.net:443/keys/key1/394f9379a47a4e2086585468de6c7ae5
Enabled        : True
Expires        :
Not Before     :
Created        : 4/6/2018 11:31:36 PM
Updated        : 4/6/2018 11:35:04 PM
Purge Disabled : False
Tags           :

このコマンドは、Backup.blob という名前のバックアップ ファイルから MyKeyVault という名前のキー コンテナーに、そのすべてのバージョンを含むキーを復元します。

パラメーター

-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 名。 コマンドレットは、名前と現在選択されている環境に基づいて、マネージド HSM の FQDN を構築します。

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

-HsmObject

HSM オブジェクト

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

-HsmResourceId

Hsm リソース ID

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

-InputFile

復元するキーのバックアップを含む入力ファイルを指定します。

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

-InputObject

KeyVault オブジェクト

Type:PSKeyVault
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ResourceId

KeyVault リソース ID

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

-VaultName

キーを復元するキー コンテナーの名前を指定します。

Type:String
Position:0
Default value:None
Required:True
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

入力

PSKeyVault

String

出力

PSKeyVaultKey