Restore-AzureKeyVaultKey

リファレンス

モジュール:: AzureRM.KeyVault

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

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

Parameters: InputObject (ByValue)

String

出力

PSKeyVaultKey