Get-Secret

模組:

Microsoft.PowerShell.SecretManagement

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

語法

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

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

參數

-AsPlainText

指定類型為 String 或 SecureString 的秘密，應該以 String （純文字格式）傳回，而不是 SecureString。 如果所擷取的秘密不是 String 或 SecureString，此參數就沒有作用。

謹慎

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

類型:	SwitchParameter
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

-InputObject

指定代表保存庫秘密的 SecretInformation 物件，而不是指定 Name 和 Vault 參數。 您可以使用 Get-SecretInfo Cmdlet 取得 SecretInformation 物件。

類型:	SecretInformation
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Name

指定要擷取的秘密名稱。 不允許通配符。

類型:	String
Position:	0
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-Vault

指定要從中擷取秘密的已註冊保存庫名稱。 如果未指定保存庫名稱，則會搜尋所有已註冊的保存庫。 如果保存庫登錄具有預設保存庫，且未指定此參數，則會在其他已註冊的保存庫之前搜尋預設保存庫。

類型:	String
Position:	1
預設值:	None
必要:	False
接受管線輸入:	False
接受萬用字元:	False

輸入

String

Microsoft.PowerShell.SecretManagement.SecretInformation

輸出

Object