Set-SecretInfo

Ссылка

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

Добавляет или заменяет дополнительные метаданные секрета в секрет, хранящийся в хранилище.

Синтаксис

Set-SecretInfo
   [-Name] <String>
   -SecureStringSecret <SecureString>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SecretInfo
   [-Name] <String>
   -Secret <Object>
   [[-Vault] <String>]
   [[-Metadata] <Hashtable>]
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-SecretInfo
   -SecretInfo <SecretInformation>
   [-Vault] <String>
   [-NoClobber]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Описание

Этот командлет добавляет дополнительные сведения о метаданных в сохраненный секрет. Поддержка метаданных — это необязательная функция для хранилища расширений. Если хранилище не поддерживает метаданные секрета, командлет возвращает ошибку.

Метаданные не хранятся безопасно в хранилище. Метаданные не должны содержать конфиденциальную информацию.

Примеры

Пример 1

Set-SecretInfo -Name Secret1 -Vault Vault1 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }
Get-SecretInfo -Name Secret1 -Vault Vault1 | Select-Object Name,Metadata

Name         Metadata
----         --------
Secret1 {[Expiration, 5/1/2022 12:00:00 AM]}

В этом примере метаданные добавляются в секрет, Secret1 хранящийся в Vault1 хранилище. Get-SecretInfo извлекает метаданные для для Secret1 отображения добавленных метаданных.

Пример 2

Set-SecretInfo -Name Secret2 -Vault Vault2 -Metadata @{ Expiration = ([datetime]::new(2022, 5, 1)) }

Set-SecretInfo: Cannot set secret metadata Secret2. Vault Vault2 does not support secret metadata.

В этом примере метаданные добавляются в секрет, Secret2 хранящийся в Vault2 хранилище. Vault2 Однако не поддерживает метаданные. Команда завершается ошибкой и возвращает ошибку.

Параметры

-Confirm

Запрос подтверждения перед выполнением командлета.

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

-Metadata

Указывает хэш-таблице , содержащую пары "ключ-значение", которые необходимо связать с секретом в хранилище. Указанное хранилище расширений может не поддерживать метаданные секретов. Если хранилище не поддерживает метаданные, операция завершается сбоем и возвращает ошибку. Значения всех метаданных в хэш-таблицы должны быть одного из следующих типов:

строка
int
DateTime

Метаданные не хранятся безопасно в хранилище. Метаданные не должны содержать конфиденциальную информацию.

Type:	Hashtable
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Указывает имя секрета, в который добавляются метаданные. Подстановочные знаки (*) не допускаются.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NoClobber

Указывает, что команда должна ошибиться, если секрет с таким именем уже существует в хранилище. По умолчанию этот командлет обновляет секрет новым значением, если он уже существует.

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

-Secret

Задает значение секрета. Тип объекта должен быть одним из поддерживаемых типов:

Byte[]
String
Securestring
PSCredential
Хэш-таблица

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

-SecretInfo

Указывает объект SecretInformation , описывающий сохраненный секрет, возвращаемый Get-SecretInfo. Это позволяет копировать секреты из одного хранилища расширений в другое.

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

-SecureStringSecret

Задает значение секрета в виде объекта SecretString .

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

-Vault

Указывает имя хранилища, содержащего секрет для добавления или обновления метаданных. Подстановочные знаки (*) не допускаются. По умолчанию этот командлет ищет секрет в хранилище текущего пользователя по умолчанию.

Type:	String
Position:	2
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

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

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

Hashtable

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

None

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