Get-Secret

Ссылка

Модуль:: Microsoft.PowerShell.SecretManagement

Находит и возвращает секрет по имени из зарегистрированных хранилищ.

Синтаксис

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

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

Описание

Этот командлет находит и возвращает первый секрет, соответствующий указанному имени. Если указано имя хранилища, выполняется поиск только в этом хранилище. В противном случае выполняется поиск по всем хранилищам и возвращается первый соответствующий результат. Если в реестре хранилища есть хранилище по умолчанию, командлет выполняет поиск в этом хранилище перед любым другим зарегистрированным хранилищем. Секреты типа 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 должен возвращаться в виде строки (в виде обычного текста), а не SecureString. Если извлекаемый секрет не является Строкой или SecureString, этот параметр не действует.

Внимание!

Чтобы обеспечить безопасность, по возможности не следует использовать строки в виде открытого текста.

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

-InputObject

Задает объект SecretInformation , представляющий секрет хранилища, а не параметры Name и Vault . Объект 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