Get-Secret

Ссылка

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

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

Синтаксис

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

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

Описание

Этот командлет находит и возвращает первый секрет, соответствующий указанному имени. Если указано имя хранилища, выполняется поиск только в этом хранилище. В противном случае выполняется поиск всех хранилищ и возвращается первый соответствующий результат. Если в реестре хранилища есть хранилище по умолчанию, командлет выполняет поиск в этом хранилище до любого другого зарегистрированного хранилища. Секреты, строковые или типы SecureString возвращаются как объекты SecureString по умолчанию.

Примеры

Пример 1

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

System.Security.SecureString
PlainTextSecretString

В этом примере выполняется поиск секрета с именем Secret1, который является секретом типа String. Первая команда возвращает секрет в виде объекта SecureString. Вторая команда использует параметр AsPlainText для возврата секрета в виде объекта строки, отображаемого в консоли в виде обычного текста.

Пример 2

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

В этом примере извлекается секретная информация для секрета с именем Secret2 в хранилище с именем SecretStore. Затем он отправляет результат через конвейер в Get-Secret, который ищет секрет и возвращает его в виде обычного текста.

Параметры

-AsPlainText

Указывает, что секрет, тип которого string или SecureString, должен быть возвращен как string (в виде обычного текста) вместо SecureString. Если извлекаемый секрет не является строковым или SecureString, этот параметр не действует.

Осторожность

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

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-InputObject

Задает объект SecretInformation, представляющий секрет хранилища вместо указания параметров имени и Vault. Вы можете получить объект SecretInformation с помощью командлета Get-SecretInfo.

Тип:	SecretInformation
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Name

Указывает имя полученного секрета. Подстановочные знаки не разрешены.

Тип:	String
Position:	0
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Vault

Указывает имя зарегистрированного хранилища, из которого извлекается секрет. Если имя хранилища не указано, выполняется поиск всех зарегистрированных хранилищ. Если реестр хранилищ имеет хранилище по умолчанию и этот параметр не указан, то хранилище по умолчанию выполняется поиск перед другими зарегистрированными хранилищами.

Тип:	String
Position:	1
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

Входные данные

String

Microsoft.PowerShell.SecretManagement.SecretInformation

Выходные данные

Object

Поделиться через