Set-SecretInfo

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

コンテナーに現在格納されているシークレットに追加のシークレット メタデータを追加または置換します。

構文

Set-SecretInfo
   [-Name] <String>
   -SecureStringSecret <SecureString>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SecretInfo
   [-Name] <String>
   -Secret <Object>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-SecretInfo
   -SecretInfo <SecretInformation>
   [-Vault] <String>
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

このコマンドレットは、格納されているシークレットにメタデータ情報を追加します。 メタデータのサポートは、拡張機能コンテナーのオプション機能です。 コンテナーでシークレット メタデータがサポートされていない場合、コマンドレットはエラーを返します。

メタデータはコンテナーに安全に格納されません。 メタデータには機密情報を含めないようにする必要があります。

例

例 1

Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata

Name         Metadata
----         --------
Secret1 {[Expiration, 5/1/2022 12:00:00 AM]}

次の使用例は、コンテナーに格納されているシークレットに Secret1 メタデータを Vault1 追加します。 Get-SecretInfo は、 のメタデータ Secret1 を取得して、追加されたメタデータを表示します。

例 2

Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }

Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.

次の使用例は、コンテナーに格納されているシークレットに Secret2 メタデータを Vault2 追加します。 ただし、 Vault2 メタデータはサポートされていません。 コマンドは失敗し、エラーを返します。

パラメーター

-Confirm

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

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

-Metadata

コンテナー内のシークレットに関連付けるキーと値のペアを含む Hashtable を指定します。 指定された拡張コンテナーは、シークレット メタデータをサポートしていない場合があります。 コンテナーでメタデータがサポートされていない場合、操作は失敗し、エラーが返されます。 ハッシュテーブル内のメタデータの値は、次のいずれかの型である必要があります。

  • string
  • int
  • DateTime

メタデータはコンテナーに安全に格納されません。 メタデータには機密情報を含めないようにする必要があります。

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

-Name

メタデータを追加するシークレットの名前を指定します。 ワイルドカード文字 (*) は使用できません。

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

-NoClobber

同じ名前のシークレットがコンテナーに既に存在する場合、コマンドでエラーが発生することを示します。 既定では、このコマンドレットは、シークレットが既に存在する場合は、新しい値でシークレットを更新します。

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

-Secret

シークレットの値を指定します。 オブジェクト型は、サポートされている型のいずれかである必要があります。

  • Byte[]
  • String
  • SecureString
  • PSCredential
  • Hashtable
Type:Object
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SecretInfo

によってGet-SecretInfo返される格納されたシークレットを記述する SecretInformation オブジェクトを指定します。 これにより、ある拡張機能コンテナーから別の拡張機能コンテナーにシークレットをコピーできます。

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

-SecureStringSecret

シークレットの値を SecretString オブジェクトとして指定します。

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

-Vault

メタデータを追加または更新するシークレットを含むコンテナーの名前を指定します。 ワイルドカード文字 (*) は使用できません。 既定では、このコマンドレットは現在のユーザーの既定のコンテナー内のシークレットを検索します。

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

入力

Hashtable

出力

None