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
      [-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.

Параметры

-Confirm

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

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

-ContentType

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

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

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Enable

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

Type:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Expires

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

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

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

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

-Name

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

Type:	String
Aliases:	SecretName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NotBefore

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

Type:	Nullable<T>[DateTime]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

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

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

-Tag

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

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VaultName

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

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

-Version

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

Type:	String
Aliases:	SecretVersion
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

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

PSKeyVaultSecretIdentityItem

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

PSKeyVaultSecret