共用方式為

Get-Secret

  • 參考
模組:
Microsoft.PowerShell.SecretManagement

依名稱從已註冊的保存庫尋找並傳回秘密。

Syntax

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

Description

此 Cmdlet 會尋找並傳回符合所提供名稱的第一個秘密。 如果指定保存庫名稱，則只會搜尋該保存庫。 否則，它會搜尋所有保存庫，並傳回第一個相符的結果。 如果保存庫登錄有預設保存庫，Cmdlet 會在任何其他已註冊的保存庫之前搜尋該保存庫。 String或SecureString類型的秘密預設會以SecureString物件的形式傳回。

範例

範例 1

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

System.Security.SecureString
PlainTextSecretString

此範例會搜尋名稱 Secret1 為 的秘密，也就是 String 類型秘密。 第一個命令會以 SecureString 物件的形式傳回秘密。 第二個命令會使用 AsPlainText 參數，改為以 String 物件形式傳回秘密，並在主控台中顯示為純文字。

範例 2

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

此範例會擷取保存庫中名為 Secret2SecretStore 之秘密的秘密資訊。 然後，它會透過管線將結果傳送至 Get-Secret ，以純文字形式搜尋秘密並將它傳回。

參數

-AsPlainText

指定類型為 String 或 SecureString 的秘密應該以純文字 (形式傳回 string) 而不是 SecureString。 如果擷取的秘密不是 String 或 SecureString，則此參數沒有任何作用。

警告

為了確保安全性，您應該盡可能避免使用純文字字串。

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

-InputObject

指定代表保存庫 秘密的 SecretInformation 物件，而不是指定 Name 和 Vault 參數。 您可以使用 Cmdlet 取得 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