az keyvault key

  • Ссылка

Управление ключами.

Команды

az keyvault key backup

Запрос на скачивание резервной копии указанного ключа на клиент.
az keyvault key create

Создайте новый ключ, сохраните его, а затем возвращает ключевые параметры и атрибуты клиенту.
az keyvault key decrypt

Расшифровка одного блока зашифрованных данных.
az keyvault key delete

Удалите ключ любого типа из хранилища в Хранилище или HSM.
az keyvault key download

Скачайте общедоступную часть сохраненного ключа.
az keyvault key encrypt

Шифрование произвольной последовательности байтов с помощью ключа шифрования, хранящегося в хранилище или HSM.
az keyvault key get-policy-template

Возвращает шаблон политики в виде определения политики в кодировке JSON.
az keyvault key import

Импорт закрытого ключа.
az keyvault key list

Вывод списка ключей в указанном хранилище или HSM.
az keyvault key list-deleted

Вывод списка удаленных ключей в указанном хранилище или HSM.
az keyvault key list-versions

Извлекает список отдельных версий ключей с тем же именем ключа.
az keyvault key purge

Окончательно удалите указанный ключ.
az keyvault key random

Получение запрошенного числа случайных байтов из управляемого модуля HSM.
az keyvault key recover

Восстановите удаленный ключ до последней версии.
az keyvault key restore

Восстановите резервную копию ключа в хранилище или HSM.
az keyvault key rotate

Смените ключ на основе политики ключей, создав новую версию ключа.
az keyvault key rotation-policy

Управление политикой смены ключа.
az keyvault key rotation-policy show

Получение политики смены ключа Key Vault.
az keyvault key rotation-policy update

Обновите политику смены ключа Key Vault.
az keyvault key set-attributes

Операция обновления ключа изменяет указанные атрибуты сохраненного ключа и может применяться к любому типу ключа и версии ключа, хранящейся в хранилище или HSM.
az keyvault key show

Получите атрибуты ключа и, если это асимметричный ключ, его открытый материал.
az keyvault key show-deleted

Получение открытой части удаленного ключа.

az keyvault key backup

Изменить

Запрос на скачивание резервной копии указанного ключа на клиент.

Операция резервного копирования ключей экспортирует ключ из хранилища или HSM в защищенной форме. Обратите внимание, что эта операция не возвращает материал ключа в форме, которая может использоваться за пределами системы хранилища или HSM, возвращенный материал ключа защищен с помощью HSM или самого хранилища. Цель этой операции — разрешить клиенту создать ключ в одном хранилище или экземпляре HSM, резервном копировании ключа, а затем восстановить его в другом хранилище или экземпляре HSM. Операция BACKUP может использоваться для экспорта в защищенной форме любого типа ключа из хранилища или HSM. Резервные копии не могут быть созданы для отдельных версий ключа. Операции резервного копирования BACKUP и восстановления RESTORE могут быть выполнены только в рамках географических областей. Это означает, что резервная копия одной географической области не может быть восстановлена в другой географической области. Например, резервная копия из географической области США не может быть восстановлена в географической области ЕС. Для этой операции требуется разрешение ключа или резервного копирования.

az keyvault key backup --file
                       [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Обязательные параметры

--file -f

Локальный путь к файлу, в котором будет храниться резервная копия ключей.

Необязательные параметры

--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key create

Изменить

Создайте новый ключ, сохраните его, а затем возвращает ключевые параметры и атрибуты клиенту.

Операцию создания ключа можно использовать для создания любого типа ключа в Хранилище или HSM. Если именованный ключ уже существует, хранилище или HSM создает новую версию ключа. Для этого требуются ключи или разрешение на создание.

az keyvault key create [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--policy]
                       [--protection {hsm, software}]
                       [--size]
                       [--tags]
                       [--vault-name]

Необязательные параметры

--curve

Имя эллиптической кривой. Допустимые значения см. в разделе : https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeycurvename.

допустимые значения: P-256, P-256K, P-384, P-521
--default-cvm-policy

Используйте политику по умолчанию, в которой ключ можно экспортировать для шифрования дисков CVM.

--disabled

Создайте ключ в отключенном состоянии.

допустимые значения: false, true
--expires

Дата и время окончания срока действия в формате UTC (Y-m-d'T:M:S'Z').

--exportable

Можно ли экспортировать закрытый ключ. Чтобы создать ключ с политикой выпуска, "экспортируемый" должен иметь значение true, а вызывающий объект должен иметь разрешение "export".

допустимые значения: false, true
--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--неизменяемый

Пометьте политику выпуска как неизменяемую. Неизменяемая политика выпуска не может быть изменена или обновлена после пометки неизменяемой. Политики выпуска по умолчанию изменяются.

допустимые значения: false, true
--kty

Тип создаваемого ключа. Допустимые значения см. в разделе : https://docs.microsoft.com/rest/api/keyvault/keys/create-key/create-key#jsonwebkeytype.

допустимые значения: EC, EC-HSM, RSA, RSA-HSM, oct, oct-HSM
--name -n

Имя ключа. Требуется, если --id не указан.

--not-before

Ключ недоступен до предоставленного времени в формате UTC (Y-m-d'T'H:M:S'Z').

--ops

Разделенный пробелами список разрешенных операций веб-ключа JSON.

допустимые значения: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Правила политики, в которых можно экспортировать ключ. Определение политики в формате JSON или путь к файлу с определением политики JSON.

--protection -p

Указывает тип защиты ключа.

допустимые значения: hsm, software
--size

Размер ключа в битах. Например: 2048, 3072 или 4096 для RSA. 128, 192 или 256 за октябрь.

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--vault-name

Имя хранилища.

az keyvault key decrypt

Изменить

Расшифровка одного блока зашифрованных данных.

Операция DECRYPT расшифровывает правильно сформированный блок зашифрованного текста с использованием целевого ключа шифрования и указанного алгоритма. Эта операция обратна операции ENCRYPT; только один блок данных может быть расшифрован, размер блока зависит от используемого целевого ключа и алгоритма. Операция DECRYPT применяется к асимметричным и симметричным ключам, хранящимся в Хранилище или HSM, так как он использует закрытую часть ключа. Для этой операции требуется разрешение на расшифровку ключей и расшифровки.

az keyvault key decrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--tag]
                        [--vault-name]
                        [--version]

Примеры

Расшифровка значения (строка в кодировке Base64, возвращаемая командой encrypt) с ключом valut с помощью RSA-OAEP и получения результата в кодировке Base64.

az keyvault key decrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --data-type base64 --value "CbFcCxHG7WTU+nbpFRrHoqSduwlPy8xpWxf1JxZ2y12BY/qFJirMSYq1i4SO9rvSmvmEMxFV5kw5s9Tc+YoKmv8X6oe+xXx+JytYV8obA5l3OQD9epuuQHWW0kir/mp88lzhcYWxYuF7mKDpPKDV4if+wnAZqQ4woB6t2JEZU5MVK3s+3E/EU4ehb5XrVxAl6xpYy8VYbyF33uJ5s+aUsYIrsVtXgrW99HQ3ic7tJtIOGuWqKhPCdQRezRkOcyxkJcmnDHOLjWA/9strzzx/dyg/t884gT7qrkmIHh8if9SFal/vi1h4XhoDqUleMTnKev2IFHyDNcYVYG3pftJiuA=="

Расшифровка значения (строка в кодировке Base64, возвращаемая командой encrypt) с помощью ключа MHSM с помощью AES-GCM и получения результата в виде открытого текста.

az keyvault key decrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "N5w02jS77xg536Ddzv/xPWQ=" --data-type plaintext
--aad "101112131415161718191a1b1c1d1e1f" --iv "727b26f78e55cf4cd8d34216" --tag "f7207d02cead35a77a1c7e5f8af959e9"

Обязательные параметры

--algorithm -a

Идентификатор алгоритма.

допустимые значения: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Значение для расшифровки, которое должно быть результатом az keyvault encrypt.

Необязательные параметры

--aad

Необязательные данные, прошедшие проверку подлинности, но не зашифрованные. Для использования с расшифровкой AES-GCM.

--data-type

Тип исходных данных.

допустимые значения: base64, plaintext
значение по умолчанию: base64
--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--iv

Вектор инициализации, используемый во время шифрования. Требуется для расшифровки AES.

--name -n

Имя ключа. Требуется, если --id не указан.

--tag

Тег проверки подлинности, созданный во время шифрования. Требуется только для расшифровки AES-GCM.

--vault-name

Имя хранилища.

--version -v

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

az keyvault key delete

Изменить

Удалите ключ любого типа из хранилища в Хранилище или HSM.

Операцию удаления ключа нельзя использовать для удаления отдельных версий ключа. Эта операция удаляет криптографические материалы, связанные с ключом. Это означает, что ключ больше нельзя будет использовать для операций подписывания и проверки, упаковки и распаковки, шифрования и дешифрования. Для этой операции требуются разрешения на ключи или удаление.

az keyvault key delete [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key download

Изменить

Скачайте общедоступную часть сохраненного ключа.

az keyvault key download --file
                         [--encoding {DER, PEM}]
                         [--hsm-name]
                         [--id]
                         [--name]
                         [--vault-name]
                         [--version]

Примеры

Сохраните ключ с кодировкой PEM.

az keyvault key download --vault-name MyKeyVault -n MyKey -e PEM -f mykey.pem

Сохраните ключ с кодировкой DER.

az keyvault key download --vault-name MyKeyVault -n MyKey -e DER -f mykey.der

Обязательные параметры

--file -f

Файл для получения содержимого ключа.

Необязательные параметры

--encoding -e

Кодировка ключа по умолчанию: PEM.

допустимые значения: DER, PEM
значение по умолчанию: PEM
--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

--version -v

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

az keyvault key encrypt

Изменить

Шифрование произвольной последовательности байтов с помощью ключа шифрования, хранящегося в хранилище или HSM.

Операция ENCRYPT шифрует произвольную последовательность байтов с помощью ключа шифрования, хранящегося в хранилище или HSM. Следует отметить, что операция ENCRYPT поддерживает только один блок данных, размер которого зависит от целевого ключа и используемого алгоритма шифрования. Операция ENCRYPT необходима только для симметричных ключей, хранящихся в хранилище pr HSM, так как защита с асимметричным ключом может выполняться с помощью открытой части ключа. Эта операция поддерживается для асимметричных ключей для удобства вызывающих объектов, имеющих ключ-ссылку, но не имеющих доступа к открытому материалу ключа. Для этой операции требуются ключи и разрешение на шифрование.

az keyvault key encrypt --algorithm {A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5}
                        --value
                        [--aad]
                        [--data-type {base64, plaintext}]
                        [--hsm-name]
                        [--id]
                        [--iv]
                        [--name]
                        [--vault-name]
                        [--version]

Примеры

Зашифруйте значение (строка в кодировке Base64) с ключом valut с помощью RSA-OAEP.

az keyvault key encrypt --name mykey --vault-name myvault --algorithm RSA-OAEP --value "YWJjZGVm" --data-type base64

Шифрование значения (открытого текста) с помощью ключа MHSM с помощью AES-GCM.

az keyvault key encrypt --name mykey --hsm-name myhsm --algorithm A256GCM --value "this is plaintext" --data-type plaintext --aad "101112131415161718191a1b1c1d1e1f"

Обязательные параметры

--algorithm -a

Идентификатор алгоритма.

допустимые значения: A128CBC, A128CBCPAD, A128GCM, A192CBC, A192CBCPAD, A192GCM, A256CBC, A256CBCPAD, A256GCM, RSA-OAEP, RSA-OAEP-256, RSA1_5
--value

Зашифрованное значение. Тип данных по умолчанию — строка в кодировке Base64.

Необязательные параметры

--aad

Необязательные данные, прошедшие проверку подлинности, но не зашифрованные. Для использования с шифрованием AES-GCM.

--data-type

Тип исходных данных.

допустимые значения: base64, plaintext
значение по умолчанию: base64
--hsm-name

Имя устройства HSM. (--hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если указаны все остальные аргументы Id, следует опустить.

--iv

Вектор инициализации. Требуется только для шифрования AES-CBC(PAD).

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

--version -v

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

az keyvault key get-policy-template

Изменить

Возвращает шаблон политики в виде определения политики в кодировке JSON.

az keyvault key get-policy-template

az keyvault key import

Изменить

Импорт закрытого ключа.

Поддерживает импорт закрытых ключей в кодировке Base64 из PEM-файлов или строк. Поддерживает импорт ключей BYOK в HSM для хранилищ ключей класса Premium.

az keyvault key import [--byok-file]
                       [--byok-string]
                       [--curve {P-256, P-256K, P-384, P-521}]
                       [--default-cvm-policy]
                       [--disabled {false, true}]
                       [--expires]
                       [--exportable {false, true}]
                       [--hsm-name]
                       [--id]
                       [--immutable {false, true}]
                       [--kty {EC, RSA, oct}]
                       [--name]
                       [--not-before]
                       [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                       [--pem-file]
                       [--pem-password]
                       [--pem-string]
                       [--policy]
                       [--protection {hsm, software}]
                       [--tags]
                       [--vault-name]

Необязательные параметры

--byok-file

BYOK-файл, содержащий импортируемый ключ. Не должен быть защищен паролем.

--byok-string

Строка BYOK, содержащая импортируемый ключ. Не должен быть защищен паролем.

--curve

Имя кривой импортируемого ключа (только для BYOK).

допустимые значения: P-256, P-256K, P-384, P-521
--default-cvm-policy

Используйте политику по умолчанию, в которой ключ можно экспортировать для шифрования дисков CVM.

--disabled

Создайте ключ в отключенном состоянии.

допустимые значения: false, true
--expires

Дата и время окончания срока действия UTC (Y-m-d'T'H:M:S'Z').

--exportable

Можно ли экспортировать закрытый ключ. Чтобы создать ключ с политикой выпуска, "экспортируемый" должен иметь значение true, а вызывающий объект должен иметь разрешение "export".

допустимые значения: false, true
--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если заданы все остальные аргументы Id, следует опустить.

--неизменяемый

Пометьте политику выпуска как неизменяемую. Неизменяемая политика выпуска не может быть изменена или обновлена после пометки неизменяемой. Политики выпуска изменяются по умолчанию.

допустимые значения: false, true
--kty

Тип импорта ключа (только для BYOK).

допустимые значения: EC, RSA, oct
значение по умолчанию: RSA
--name -n

Имя ключа. Требуется, если --id не указан.

--not-before

Ключ недоступен до предоставленного времени в формате UTC (Y-m-d'T'H:M:S'Z').

--ops

Разделенный пробелами список разрешенных операций веб-ключа JSON.

допустимые значения: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--pem-file

PEM-файл, содержащий импортируемый ключ.

--pem-password

Пароль PEM-файла.

--pem-string

Строка PEM, содержащая импортируемый ключ.

--policy

Правила политики, в которых можно экспортировать ключ. Определение политики как JSON или путь к файлу с определением политики JSON.

--protection -p

Указывает тип защиты ключа.

допустимые значения: hsm, software
--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--vault-name

Имя хранилища.

az keyvault key list

Изменить

Вывод списка ключей в указанном хранилище или HSM.

Получение списка ключей в хранилище или HSM в виде структур веб-ключей JSON, содержащих общедоступную часть сохраненного ключа. Операция LIST применима ко всем типам ключей, однако в ответе предоставляются только базовый идентификатор ключа, атрибуты и теги. Отдельные версии ключа не перечисляются в ответе. Для этой операции требуется разрешение на ключи или список.

az keyvault key list [--hsm-name]
                     [--id]
                     [--include-managed {false, true}]
                     [--maxresults]
                     [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Полный универсальный код ресурса (URI) хранилища или HSM. Если заданы все остальные аргументы Id, следует опустить.

--include-managed

Включите управляемые ключи. По умолчанию: false.

допустимые значения: false, true
--maxresults

Максимальное количество результатов, возвращаемых на странице. Если служба не указана, возвращается до 25 результатов.

--vault-name

Имя хранилища.

az keyvault key list-deleted

Изменить

Вывод списка удаленных ключей в указанном хранилище или HSM.

Получите список ключей в хранилище или HSM в виде структур веб-ключей JSON, содержащих общедоступную часть удаленного ключа. Эта операция включает сведения об удалении. Операция получения удаленных ключей применима для хранилищ, включенных для обратимого удаления. Хотя операцию можно вызвать в любом хранилище или HSM, она вернет ошибку при вызове в хранилище с поддержкой обратимого удаления или HSM. Для этой операции требуется разрешение на ключи или список.

az keyvault key list-deleted [--hsm-name]
                             [--id]
                             [--maxresults]
                             [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Полный универсальный код ресурса (URI) хранилища или HSM. Если заданы все остальные аргументы Id, следует опустить.

--maxresults

Максимальное количество результатов, возвращаемых на странице. Если служба не указана, возвращается до 25 результатов.

--vault-name

Имя хранилища.

az keyvault key list-versions

Изменить

Извлекает список отдельных версий ключей с тем же именем ключа.

В ответе предоставляется полный идентификатор ключа, атрибуты и теги. Для этой операции требуется разрешение на ключи или список.

az keyvault key list-versions [--hsm-name]
                              [--id]
                              [--maxresults]
                              [--name]
                              [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если заданы все остальные аргументы Id, следует опустить.

--maxresults

Максимальное количество результатов, возвращаемых на странице. Если служба не указана, возвращается до 25 результатов.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key purge

Изменить

Окончательно удалите указанный ключ.

Операция очистки удаленного ключа применима для хранилищ с поддержкой обратимого удаления или устройств HSM. Хотя операцию можно вызвать в любом хранилище или HSM, она вернет ошибку при вызове в хранилище с поддержкой обратимого удаления или HSM. Для этой операции требуются разрешения на очистку ключей и очистки.

az keyvault key purge [--hsm-name]
                      [--id]
                      [--name]
                      [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор восстановления ключа. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key random

Изменить

Получение запрошенного числа случайных байтов из управляемого модуля HSM.

az keyvault key random --count
                       [--hsm-name]
                       [--id]

Обязательные параметры

--count

Запрашиваемое число случайных байтов.

Необязательные параметры

--hsm-name

Имя устройства HSM.

--id

Полный универсальный код ресурса (URI) модуля HSM.

az keyvault key recover

Изменить

Восстановите удаленный ключ до последней версии.

Операция восстановления удаленного ключа применима для удаленных ключей в хранилищах с поддержкой обратимого удаления или устройствах HSM. Он восстанавливает удаленный ключ обратно в последнюю версию в разделе /keys. Попытка восстановить неудаляемый ключ вернет ошибку. Рассмотрим это обратное действие удаления для хранилищ с поддержкой обратимого удаления или устройств HSM. Для этой операции требуются ключи или разрешение на восстановление.

az keyvault key recover [--hsm-name]
                        [--id]
                        [--name]
                        [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор восстановления ключа. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key restore

Изменить

Восстановите резервную копию ключа в хранилище или HSM.

Импортируйте ранее резервную копию ключа в Хранилище или HSM, восстанавливая ключ, его идентификатор ключа, атрибуты и политики управления доступом. Операция восстановления может использоваться для импорта ранее архивированного ключа. Невозможно восстановить отдельные версии ключа. Ключ восстанавливается целиком с тем же именем ключа, которое он имел при создании резервной копии. Если имя ключа недоступно в целевом хранилище ключей, операция восстановления будет отменена. Хотя имя ключа сохраняется во время восстановления, окончательный идентификатор ключа изменится, если ключ восстановлен в другом хранилище или HSM. Операция восстановления будет восстанавливать все версии и сохранять идентификаторы версий. Операция RESTORE зависит от ограничений безопасности. Целевое хранилище или HSM должно принадлежать той же Microsoft Azure подписке, что и исходное хранилище или HSM. Пользователь должен иметь разрешение RESTORE в целевом хранилище или HSM. Для этой операции требуется разрешение на ключи или восстановление.

az keyvault key restore [--backup-folder]
                        [--blob-container-name]
                        [--file]
                        [--hsm-name]
                        [--id]
                        [--name]
                        [--no-wait]
                        [--storage-account-name]
                        [--storage-container-SAS-token]
                        [--storage-resource-uri]
                        [--vault-name]

Необязательные параметры

--backup-folder

Имя контейнера BLOB-объектов, содержащего резервную копию.

--blob-container-name

Имя контейнера BLOB-объектов.

--file -f

Резервное копирование локального ключа, из которого выполняется восстановление ключа.

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Полный универсальный код ресурса (URI) хранилища или HSM. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. (Только для восстановления из учетной записи хранения).

--no-wait

Не ожидать завершения длительной операции.

--storage-account-name

Имя учетной записи служба хранилища Azure.

--storage-container-SAS-token -t

Маркер SAS, указывающий на контейнер хранилища BLOB-объектов Azure.

--storage-resource-uri -u

Uri контейнера хранилища BLOB-объектов Azure. При указании все остальные аргументы "служба хранилища Id" должны быть опущены.

--vault-name

Имя хранилища.

az keyvault key rotate

Изменить

Смените ключ на основе политики ключей, создав новую версию ключа.

az keyvault key rotate [--hsm-name]
                       [--id]
                       [--name]
                       [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

az keyvault key set-attributes

Изменить

Операция обновления ключа изменяет указанные атрибуты сохраненного ключа и может применяться к любому типу ключа и версии ключа, хранящейся в хранилище или HSM.

Чтобы выполнить эту операцию, ключ должен уже существовать в хранилище или HSM. Нельзя изменить криптографические материалы ключа. Для этой операции требуется разрешение на ключи или обновление.

az keyvault key set-attributes [--enabled {false, true}]
                               [--expires]
                               [--hsm-name]
                               [--id]
                               [--immutable {false, true}]
                               [--name]
                               [--not-before]
                               [--ops {decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey}]
                               [--policy]
                               [--tags]
                               [--vault-name]
                               [--version]

Необязательные параметры

--enabled

Включите ключ.

допустимые значения: false, true
--expires

Дата и время окончания срока действия UTC (Y-m-d'T'H:M:S'Z').

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если заданы все остальные аргументы Id, следует опустить.

--неизменяемый

Пометьте политику выпуска как неизменяемую. Неизменяемая политика выпуска не может быть изменена или обновлена после пометки неизменяемой. Политики выпуска изменяются по умолчанию.

допустимые значения: false, true
--name -n

Имя ключа. Требуется, если --id не указан.

--not-before

Ключ недоступен до предоставленного времени в формате UTC (Y-m-d'T'H:M:S'Z').

--ops

Разделенный пробелами список разрешенных операций веб-ключа JSON.

допустимые значения: decrypt, encrypt, export, import, sign, unwrapKey, verify, wrapKey
--policy

Правила политики, в которых можно экспортировать ключ. Определение политики как JSON или путь к файлу с определением политики JSON.

--tags

Теги, разделенные пробелами: key[=value] [key[=value] ...]. Используйте "" для очистки существующих тегов.

--vault-name

Имя хранилища.

--version -v

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

az keyvault key show

Изменить

Получите атрибуты ключа и, если это асимметричный ключ, его открытый материал.

Требуется разрешение на ключи и получение.

az keyvault key show [--hsm-name]
                     [--id]
                     [--name]
                     [--vault-name]
                     [--version]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор ключа. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.

--version -v

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

az keyvault key show-deleted

Изменить

Получение открытой части удаленного ключа.

Операция получения удаленного ключа применима для хранилищ с поддержкой обратимого удаления или устройств HSM. Хотя операцию можно вызвать в любом хранилище или HSM, она вернет ошибку при вызове в хранилище с поддержкой обратимого удаления или HSM. Для этой операции требуются ключи и разрешения на получение.

az keyvault key show-deleted [--hsm-name]
                             [--id]
                             [--name]
                             [--vault-name]

Необязательные параметры

--hsm-name

Имя устройства HSM. (-hsm-name и --vault-name являются взаимоисключающими, укажите только один из них).

--id

Идентификатор восстановления ключа. Если заданы все остальные аргументы Id, следует опустить.

--name -n

Имя ключа. Требуется, если --id не указан.

--vault-name

Имя хранилища.