Get-Secret
依名稱從已註冊的保存庫尋找並傳回秘密。
語法
NameParameterSet (預設值)
Get-Secret
[-Name] <String>
[[-Vault] <String>]
[-AsPlainText]
[<CommonParameters>]
InfoParameterSet
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
此範例會擷取名為 Secret2保存庫中名為 SecretStore 之秘密的秘密資訊。 然後，它會透過管線將結果傳送至 Get-Secret，它會搜尋秘密，並以純文本形式傳回它。
參數
-AsPlainText
指定類型為 String 或 SecureString 的秘密，應該以 String （純文字格式）傳回，而不是 SecureString。 如果要檢索的密鑰不是 String 或 SecureString，則此參數無效。
謹慎
為了確保安全性，您應該盡可能避免使用純文字字串。
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-InputObject
指定代表保存庫秘密的 SecretInformation 物件，而不是指定 Name 和 Vault 參數。 您可以使用 Cmdlet 取得 Get-SecretInfo 物件。
參數屬性
| 類型: | Microsoft.PowerShell.SecretManagement.SecretInformation |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
InfoParameterSet
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Name
指定要擷取的秘密名稱。 不允許使用通配符字元。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
NameParameterSet
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Vault
指定要從中擷取秘密的已註冊保存庫名稱。 如果未指定保存庫名稱，則會搜尋所有已註冊的保存庫。 如果 Vault 註冊表具有 default vault 且未指定此參數，則在其他已註冊的 vault 之前搜索 default vault。
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
NameParameterSet
| Position: | 1 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
