Get-Secret

模块:

Microsoft.PowerShell.SecretManagement

按名称查找并返回已注册保管库中的机密。

语法

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

Get-Secret
   [-InputObject] <SecretInformation>
   [-AsPlainText]
   [<CommonParameters>]

说明

此 cmdlet 查找并返回与提供的名称匹配的第一个机密。 如果指定了保管库名称，则仅搜索该保管库。 否则，它会搜索所有保管库并返回第一个匹配结果。 如果保管库注册表具有默认保管库，则 cmdlet 会在任何其他已注册的保管库之前搜索该保管库。 默认情况下，String 或 SecureString 类型的机密作为 SecureString 对象返回。

示例

示例 1

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

System.Security.SecureString
PlainTextSecretString

此示例搜索名称为 Secret1的机密，该机密是字符串 类型机密。 第一个命令将机密作为 SecureString 对象返回。 第二个命令使用 AsPlainText 参数将机密作为 字符串 对象返回，以纯文本形式显示在控制台中。

示例 2

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

此示例检索名为 SecretStore的保管库中名为 Secret2 的机密的机密信息。 然后，它会通过管道将结果发送到 Get-Secret，该管道搜索机密并将其作为纯文本返回。

参数

-AsPlainText

指定类型为 string string 或 SecureString 的机密应作为 字符串（以纯文本形式）而不是 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