Get-Secret

  • リファレンス
モジュール:
Microsoft.PowerShell.SecretManagement

登録済みのコンテナーから名前でシークレットを検索して返します。

構文

Get-Secret
   [-Name] <String>
   [[-Vault] <String>]
   [-AsPlainText]
   [<CommonParameters>]
Get-Secret
   [-InputObject] <SecretInformation>
   [-AsPlainText]
   [<CommonParameters>]

説明

このコマンドレットは、指定された名前と一致する最初のシークレットを検索して返します。 コンテナー名を指定すると、そのコンテナーのみが検索されます。 それ以外の場合は、すべてのコンテナーを検索し、最初に一致する結果を返します。 コンテナー レジストリに既定のコンテナーがある場合、コマンドレットは、そのコンテナーを他の登録済みコンテナーの前に検索します。 String 型または SecureString 型のシークレットは、既定で SecureString オブジェクトとして返されます。

例

例 1

Get-Secret -Name Secret1 -Vault CredMan
Get-Secret -Name Secret1 -Vault CredMan -AsPlainText

System.Security.SecureString
PlainTextSecretString

次の使用例は、String 型のシークレットである という名前Secret1のシークレットを検索します。 最初のコマンドは、 シークレットを SecureString オブジェクトとして返します。 2 番目のコマンドでは、 AsPlainText パラメーターを使用してシークレットを代わりに String オブジェクトとして返し、コンソールにプレーン テキストとして表示します。

例 2

Get-SecretInfo -Name Secret2 -Vault SecretStore | Get-Secret -AsPlainText

この例では、 という名前SecretStoreのコンテナー内の という名前Secret2のシークレットのシークレット情報を取得します。 次に、パイプラインを介して結果を に Get-Secret送信します。これにより、シークレットが検索され、プレーン テキストとして返されます。

パラメーター

-AsPlainText

型が String または SecureString のシークレットを、SecureString ではなく文字列 (プレーン テキスト) として返すように指定します。 取得するシークレットが String または SecureString でない場合、このパラメーターは無効です。

注意事項

セキュリティを確保するには、可能な限りプレーンテキスト文字列を使用しないようにする必要があります。

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

-InputObject

Nameパラメーターと Vault パラメーターを指定する代わりに、コンテナー シークレットを表す SecretInformation オブジェクトを指定します。 コマンドレットを使用して SecretInformation オブジェクトを Get-SecretInfo 取得できます。

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

-Name

取得するシークレットの名前を指定します。 ワイルドカード文字は使用できません。

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

-Vault

シークレットを取得する登録済みコンテナーの名前を指定します。 コンテナー名が指定されていない場合は、登録されているすべてのコンテナーが検索されます。 コンテナー レジストリに既定のコンテナーがあり、このパラメーターが指定されていない場合、既定のコンテナーは、他の登録済みコンテナーの前に検索されます。

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

入力

String

Microsoft.PowerShell.SecretManagement.SecretInformation

出力

Object