Update-AzKeyVaultSecret

Модуль:

Az.KeyVault

Обновляет атрибуты секрета в хранилище ключей.

Синтаксис

Update-AzKeyVaultSecret
      [-VaultName] <String>
      [-Name] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzKeyVaultSecret
      [-Id] <String>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzKeyVaultSecret
      [-InputObject] <PSKeyVaultSecretIdentityItem>
      [[-Version] <String>]
      [-Enable <Boolean>]
      [-Expires <DateTime>]
      [-NotBefore <DateTime>]
      [-ContentType <String>]
      [-Tag <Hashtable>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Описание

Командлет Update-AzKeyVaultSecret обновляет редактируемые атрибуты секрета в хранилище ключей.

Примеры

Пример 1. Изменение атрибутов секрета

$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Nbf = (Get-Date).ToUniversalTime()
$Tags = @{ 'Severity' = 'medium'; 'HR' = 'true'}
$ContentType= 'xml'
Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Expires $Expires -NotBefore $Nbf -ContentType $ContentType -Enable $True -Tag $Tags -PassThru

Vault Name   : ContosoVault
Name         : HR
Version      : d476edfcd3544017a03bc49c1f3abec0
Id           : https://ContosoVault.vault.azure.net:443/secrets/HR/d476edfcd3544017a03bc49c1f3abec0
Enabled      : True
Expires      : 5/25/2020 8:01:58 PM
Not Before   : 5/25/2018 8:02:02 PM
Created      : 4/11/2018 11:45:06 PM
Updated      : 5/25/2018 8:02:45 PM
Content Type : xml
Tags         : Name      Value
               Severity  medium
               HR        true

Первые четыре команды определяют атрибуты для даты окончания срока действия, даты NotBefore, тегов и типа контекста и хранения атрибутов в переменных. Последняя команда изменяет атрибуты секрета с именем HR в хранилище ключей ContosoVault с помощью хранимых переменных.

Пример 2. Удаление тегов и типа контента для секрета

Update-AzKeyVaultSecret -VaultName 'ContosoVault' -Name 'HR' -Version '9EEA45C6EE50490B9C3176A80AC1A0DF' -ContentType '' -Tag @{}

Эта команда удаляет теги и тип контента для указанной версии секрета с именем HR в хранилище ключей с именем Contoso.

Пример 3. Отключение текущей версии секретов, имя которого начинается с ИТ-специалистов

$Vault = 'ContosoVault'
$Prefix = 'IT'
Get-AzKeyVaultSecret $Vault | Where-Object {$_.Name -like $Prefix + '*'} | Update-AzKeyVaultSecret -Enable $False

Первая команда сохраняет строковое значение Contoso в переменной $Vault. Вторая команда сохраняет строковое значение в переменной $Prefix. Третья команда использует командлет Get-AzKeyVaultSecret для получения секретов в указанном хранилище ключей, а затем передает эти секреты командлету Where-Object. Командлет Where-Object фильтрует секреты по именам, начинающимся с ИТ-символов. Команда передает секреты, соответствующие фильтру, командлету Update-AzKeyVaultSecret, который отключает их.

Пример 4. Задание ContentType для всех версий секрета

$VaultName = 'ContosoVault'
$Name = 'HR'
$ContentType = 'xml'
Get-AzKeyVaultKey -VaultName $VaultName -Name $Name -IncludeVersions | Update-AzKeyVaultSecret -ContentType $ContentType

Первые три команды определяют строковые переменные, используемые для параметров VaultName, Nameи ContentType. Четвертая команда использует командлет Get-AzKeyVaultKey для получения указанных ключей и передает ключи командлету Update-AzKeyVaultSecret, чтобы задать тип контента xml.

Пример 5. Удаление тегов и типа контента для секрета (с помощью URI)

Update-AzKeyVaultSecret -Id 'https://ContosoVault.vault.azure.net:443/secrets/HR/9EEA45C6EE50490B9C3176A80AC1A0DF'  -ContentType '' -Tag @{}

Эта команда удаляет теги и тип контента для указанной версии секрета с именем HR в хранилище ключей с именем Contoso.

Параметры

-Confirm

Запрашивает подтверждение перед запуском командлета.

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

-ContentType

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

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

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

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

-Enable

Если он присутствует, включите секрет, если значение имеет значение true. Отключите секрет, если значение равно false. Если значение не указано, существующее значение включенного или отключенного состояния секрета остается неизменным.

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

-Expires

Время истечения срока действия секрета в формате UTC. Если это не указано, существующее значение срока действия секрета остается неизменным.

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

-Id

Универсальный код ресурса (URI) секрета KeyVault. Убедитесь, что он соответствует формату: https://<vault-name>.vault.azure.net/secrets/<secret-name>/<version>

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

-InputObject

Секретный объект

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

-Name

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

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

-NotBefore

Время в формате UTC, до которого нельзя использовать секрет. Если это не указано, существующее значение атрибута NotBefore секрета остается неизменным.

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

-PassThru

Командлет по умолчанию не возвращает объект. Если этот параметр указан, верните объект Secret.

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

-Tag

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

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

-VaultName

Имя хранилища. Командлет создает полное доменное имя хранилища на основе имени и выбранной среды.

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

-Version

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

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

-WhatIf

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

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

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

PSKeyVaultSecretIdentityItem

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

PSKeyVaultSecret