Restore-AzKeyVaultSecret

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

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

構文

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

説明

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

例

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

Restore-AzKeyVaultSecret -VaultName 'contoso' -InputFile "C:\Backup.blob"

Vault Name   : contoso
Name         : secret1
Version      : 7128133570f84a71b48d7d0550deb74c
Id           : https://contoso.vault.azure.net:443/secrets/secret1/7128133570f84a71b48d7d0550deb74c
Enabled      : True
Expires      : 4/6/2018 3:59:43 PM
Not Before   :
Created      : 4/5/2018 11:46:28 PM
Updated      : 4/6/2018 11:30:17 PM
Content Type :
Tags         :

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

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
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

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

入力

PSKeyVault

String

出力

PSKeyVaultSecret