Update-AzKeyVaultKey
Обновляет атрибуты ключа в хранилище ключей.
Синтаксис
Update-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultKey
-HsmName <String>
[-Name] <String>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Immutable]
[-ReleasePolicyPath <String>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[[-Version] <String>]
[-Enable <Boolean>]
[-Expires <DateTime>]
[-NotBefore <DateTime>]
[-KeyOps <String[]>]
[-Tag <Hashtable>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет Update-AzKeyVaultKey обновляет редактируемые атрибуты ключа в хранилище ключей.
Примеры
Пример 1. Изменение ключа для его включения и установка даты окончания срока действия и тегов
$Expires = (Get-Date).AddYears(2).ToUniversalTime()
$Tags = @{'Severity' = 'high'; 'Accounting' = 'true'}
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Expires $Expires -Enable $True -Tag $Tags -PassThru
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 7:59:02 PM
Purge Disabled : False
Tags : Name Value
Severity high
Accounting true
Первая команда создает объект DateTime с помощью командлета Get-Date . Этот объект указывает время два года в будущем. Команда сохраняет эту дату в переменной $Expires.
Для получения дополнительных сведений введите Get-Help Get-Date
.
Вторая команда создает переменную для хранения значений тегов высокой серьезности и учета.
Последняя команда изменяет ключ с именем ITSoftware. Команда включает ключ, задает время истечения срока действия, хранящееся в $Expires, и задает теги, хранящиеся в $Tags.
Пример 2. Изменение ключа для удаления всех тегов
Update-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Version '394f9379a47a4e2086585468de6c7ae5' -Tag @{}
Vault Name : Contoso
Name : ITSoftware
Version : 394f9379a47a4e2086585468de6c7ae5
Id : https://Contoso.vault.azure.net:443/keys/ITSoftware/394f9379a47a4e2086585468de6c7ae5
Enabled : True
Expires : 5/25/2020 7:58:07 PM
Not Before :
Created : 4/6/2018 11:31:36 PM
Updated : 5/25/2018 8:00:08 PM
Purge Disabled : False
Tags :
Эта команда удаляет все теги для определенной версии ключа с именем ITSoftware.
Параметры
-Confirm
Запрос подтверждения перед выполнением командлета.
Тип: | SwitchParameter |
Aliases: | cf |
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 отключает ключ. Если не указано, существующее состояние включено или отключено остается неизменным.
Тип: | Nullable<T>[Boolean] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Expires
Время истечения срока действия ключа в формате UTC. Если не указано, существующее время истечения срока действия ключа остается неизменным. Обратите внимание, что срок действия не учитывается для ключа обмена ключами, используемыми в процессе BYOK.
Тип: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-HsmName
Имя HSM. Командлет создает полное доменное имя управляемого модуля HSM на основе имени и выбранной среды.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Immutable
Задает политику выпуска как неизменяемое состояние. Помечая неизменяемый, этот флаг нельзя сбросить, и политика не может быть изменена в любых обстоятельствах.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-InputObject
Ключевой объект
Тип: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-KeyOps
Операции, которые можно выполнить с помощью ключа. Если не указано, существующие ключевые операции ключа остаются неизменными.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Name
Имя ключа. Командлет создает полное доменное имя ключа из имени хранилища, в настоящее время выбранная среда и имя ключа.
Тип: | String |
Aliases: | KeyName |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-NotBefore
Время в формате UTC, до которого нельзя использовать ключ. Если он не указан, существующий атрибут NotBefore ключа остается неизменным.
Тип: | Nullable<T>[DateTime] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PassThru
Командлет по умолчанию не возвращает объект. Если этот параметр указан, возвращает обновленный объект пакета ключей.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ReleasePolicyPath
Путь к файлу с определением политики JSON. Правила политики, в которых можно экспортировать ключ.
Тип: | String |
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: | KeyVersion |
Position: | 2 |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-WhatIf
Показывает, что произойдет при запуске командлета. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
Входные данные
Выходные данные
Azure PowerShell