Restore-AzureKeyVaultKey

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

重要

Az PowerShell モジュール で AzureRM PowerShell モジュールのすべての機能およびその他を利用できるようになったため、2024 年 2 月 29 日に AzureRM PowerShell モジュールは廃止になります。

サービスの中断を回避するために、2024 年 2 月 29 日までに、AzureRM PowerShell モジュールを使用するスクリプトを更新して、Az PowerShell モジュールを使用するようにしてください。 スクリプトを自動的に更新するには、 クイックスタート ガイドに従ってください。

構文

Restore-AzureKeyVaultKey
       [-VaultName] <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzureKeyVaultKey
       [-InputObject] <PSKeyVault>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Restore-AzureKeyVaultKey
       [-ResourceId] <String>
       [-InputFile] <String>
       [-DefaultProfile <IAzureContextContainer>]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

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

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

PS C:\> Restore-AzureKeyVaultKey -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
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-InputFile

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

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

-InputObject

KeyVault オブジェクト

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

-ResourceId

KeyVault リソース ID

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

-VaultName

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

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

-WhatIf

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

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

入力

PSKeyVault

パラメーター: InputObject (ByValue)

String

出力

PSKeyVaultKey