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


az keyvault

Управление ключами KeyVault, секретами и сертификатами.

Команды

Имя Описание Тип Состояние
az keyvault backup

Управление полным резервным копированием HSM.

Ядро ГА
az keyvault backup start

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

Ядро ГА
az keyvault certificate

Управление сертификатами.

Ядро ГА
az keyvault certificate backup

Резервное копирование указанного сертификата.

Ядро ГА
az keyvault certificate contact

Управление контактами для управления сертификатами.

Ядро ГА
az keyvault certificate contact add

Добавьте контакт в указанное хранилище для получения уведомлений об операциях с сертификатами.

Ядро ГА
az keyvault certificate contact delete

Удалите контакт сертификата из указанного хранилища.

Ядро ГА
az keyvault certificate contact list

Выводит список контактов сертификатов для указанного хранилища ключей.

Ядро ГА
az keyvault certificate create

Создайте сертификат Key Vault.

Ядро ГА
az keyvault certificate delete

Удаляет сертификат из указанного хранилища ключей.

Ядро Устаревшие
az keyvault certificate download

Скачайте общедоступную часть сертификата Key Vault.

Ядро ГА
az keyvault certificate get-default-policy

Получите политику по умолчанию для самозаверяемых сертификатов.

Ядро ГА
az keyvault certificate import

Импортируйте сертификат в KeyVault.

Ядро ГА
az keyvault certificate issuer

Управление сведениями издателя сертификатов.

Ядро ГА
az keyvault certificate issuer admin

Управление сведениями администратора для издателей сертификатов.

Ядро ГА
az keyvault certificate issuer admin add

Добавьте сведения администратора для указанного издателя сертификата.

Ядро ГА
az keyvault certificate issuer admin delete

Удалите сведения администратора для указанного издателя сертификата.

Ядро ГА
az keyvault certificate issuer admin list

Перечислите администраторов для указанного издателя сертификата.

Ядро ГА
az keyvault certificate issuer create

Создайте запись издателя сертификатов.

Ядро ГА
az keyvault certificate issuer delete

Удаляет указанный издатель сертификата.

Ядро ГА
az keyvault certificate issuer list

Выводит список свойств издателей сертификатов для хранилища ключей.

Ядро ГА
az keyvault certificate issuer show

Возвращает указанный издатель сертификата.

Ядро ГА
az keyvault certificate issuer update

Обновите запись издателя сертификата.

Ядро ГА
az keyvault certificate list

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

Ядро ГА
az keyvault certificate list-deleted

Выводит список удаленных сертификатов, доступных для восстановления.

Ядро ГА
az keyvault certificate list-versions

Вывод списка версий сертификата.

Ядро ГА
az keyvault certificate pending

Управление операциями создания ожидающих сертификатов.

Ядро ГА
az keyvault certificate pending delete

Удаляет операцию создания для определенного сертификата.

Ядро ГА
az keyvault certificate pending merge

Объединяет сертификат или цепочку сертификатов с парой ключей, существующей на сервере.

Ядро ГА
az keyvault certificate pending show

Возвращает операцию создания сертификата.

Ядро ГА
az keyvault certificate purge

Окончательно удаляет указанный удаленный сертификат.

Ядро ГА
az keyvault certificate recover

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

Ядро ГА
az keyvault certificate restore

Восстанавливает резервные копии сертификата в хранилище.

Ядро ГА
az keyvault certificate set-attributes

Обновляет указанные атрибуты, связанные с заданным сертификатом.

Ядро ГА
az keyvault certificate show

Возвращает сведения о сертификате.

Ядро ГА
az keyvault certificate show-deleted

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

Ядро ГА
az keyvault check-name

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

Ядро ГА
az keyvault create

Создайте хранилище или HSM.

Ядро ГА
az keyvault delete

Удаление хранилища или HSM.

Ядро ГА
az keyvault delete-policy

Удаление параметров политики безопасности для Key Vault.

Ядро ГА
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 sign

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

Ядро ГА
az keyvault key verify

Проверьте подпись с помощью ключа, хранящегося в хранилище или HSM.

Ядро ГА
az keyvault list

Перечисление хранилищ и /или HSM.

Ядро ГА
az keyvault list-deleted

Получение сведений об удаленных хранилищах или HSM в подписке.

Ядро ГА
az keyvault network-rule

Управление сетевыми списками ACL хранилища.

Ядро ГА
az keyvault network-rule add

Добавьте сетевое правило в сетевые списки ACL для Key Vault.

Ядро ГА
az keyvault network-rule list

Список сетевых правил из сетевых списков ACL для Key Vault.

Ядро ГА
az keyvault network-rule remove

Удалите правило сети из сетевых списков ACL для Key Vault.

Ядро ГА
az keyvault network-rule wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие хранилища.

Ядро ГА
az keyvault private-endpoint-connection

Управление подключениями к частной конечной точке хранилища или HSM.

Ядро ГА
az keyvault private-endpoint-connection approve

Утверждение запроса подключения к частной конечной точке для Key Vault или HSM.

Ядро ГА
az keyvault private-endpoint-connection delete

Удалите указанное подключение к частной конечной точке, связанное с Key Vault или HSM.

Ядро ГА
az keyvault private-endpoint-connection list

Список всех подключений частной конечной точки, связанных с HSM.

Ядро ГА
az keyvault private-endpoint-connection reject

Отклоните запрос подключения к частной конечной точке для Key Vault или HSM.

Ядро ГА
az keyvault private-endpoint-connection show

Отображение сведений о подключении частной конечной точки, связанном с Key Vault/HSM.

Ядро ГА
az keyvault private-endpoint-connection wait

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

Ядро ГА
az keyvault private-link-resource

Управление ресурсами приватного канала хранилища или HSM.

Ядро ГА
az keyvault private-link-resource list

Список ресурсов приватного канала, поддерживаемых для Key Vault или HSM.

Ядро ГА
az keyvault purge

Окончательно удалите указанное хранилище или HSM. Ака очищает удаленное хранилище или HSM.

Ядро ГА
az keyvault recover

Восстановление хранилища или HSM.

Ядро ГА
az keyvault region

Управление несколькими регионами MHSM.

Ядро ГА
az keyvault region add

Добавьте регионы для управляемого пула HSM.

Ядро ГА
az keyvault region list

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

Ядро ГА
az keyvault region remove

Удалите регионы для управляемого пула HSM.

Ядро ГА
az keyvault region wait

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие HSM.

Ядро ГА
az keyvault restore

Управление полным восстановлением HSM.

Ядро ГА
az keyvault restore start

Восстановление полной резервной копии HSM.

Ядро ГА
az keyvault role

Управление ролями пользователей для управления доступом.

Ядро ГА
az keyvault role assignment

Управление назначениями ролей.

Ядро ГА
az keyvault role assignment create

Создайте новое назначение ролей для пользователя, группы или субъекта-службы.

Ядро ГА
az keyvault role assignment delete

Удаление назначения роли.

Ядро ГА
az keyvault role assignment list

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

Ядро ГА
az keyvault role definition

Управление определениями ролей.

Ядро ГА
az keyvault role definition create

Создайте определение настраиваемой роли.

Ядро ГА
az keyvault role definition delete

Удаление определения роли.

Ядро ГА
az keyvault role definition list

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

Ядро ГА
az keyvault role definition show

Отображение сведений о определении роли.

Ядро ГА
az keyvault role definition update

Обновление определения роли.

Ядро ГА
az keyvault secret

Управление секретами.

Ядро ГА
az keyvault secret backup

Резервное копирование указанного секрета.

Ядро ГА
az keyvault secret delete

Удалите все версии секрета.

Ядро Устаревшие
az keyvault secret download

Скачайте секрет из KeyVault.

Ядро ГА
az keyvault secret list

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

Ядро ГА
az keyvault secret list-deleted

Выводит список удаленных секретов для указанного хранилища.

Ядро ГА
az keyvault secret list-versions

Список всех версий указанного секрета.

Ядро ГА
az keyvault secret purge

Окончательно удаляет указанный секрет.

Ядро ГА
az keyvault secret recover

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

Ядро ГА
az keyvault secret restore

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

Ядро ГА
az keyvault secret set

Создайте секрет (если он не существует) или обновите секрет в KeyVault.

Ядро ГА
az keyvault secret set-attributes

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

Ядро ГА
az keyvault secret show

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

Ядро ГА
az keyvault secret show-deleted

Возвращает указанный удаленный секрет.

Ядро ГА
az keyvault security-domain

Управление операциями домена безопасности.

Ядро ГА
az keyvault security-domain download

Скачайте файл домена безопасности из HSM.

Ядро ГА
az keyvault security-domain init-recovery

Получите ключ обмена HSM.

Ядро ГА
az keyvault security-domain restore-blob

Включите расшифровку и шифрование файла домена безопасности в виде большого двоичного объекта. Можно запускать в автономной среде перед отправкой файла в HSM с помощью отправки домена безопасности.

Ядро ГА
az keyvault security-domain upload

Запустите восстановление HSM.

Ядро ГА
az keyvault security-domain wait

Поместите интерфейс командной строки в состояние ожидания до завершения операции домена безопасности HSM.

Ядро ГА
az keyvault set-policy

Обновите параметры политики безопасности для Key Vault.

Ядро ГА
az keyvault setting

Управление параметрами MHSM.

Ядро ГА
az keyvault setting list

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

Ядро ГА
az keyvault setting show

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

Ядро ГА
az keyvault setting update

Обновите конкретный параметр, связанный с управляемым HSM.

Ядро ГА
az keyvault show

Отображение сведений о хранилище или HSM.

Ядро ГА
az keyvault show-deleted

Отображение сведений о удаленном хранилище или HSM.

Ядро ГА
az keyvault update

Обновите свойства хранилища.

Ядро ГА
az keyvault update-hsm

Обновите свойства HSM.

Ядро ГА
az keyvault wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие хранилища.

Ядро ГА
az keyvault wait-hsm

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие HSM.

Ядро ГА

az keyvault check-name

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

az keyvault check-name --name
                       [--resource-type {hsm}]

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

--name -n

Имя HSM в указанной группе ресурсов.

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

--resource-type

Тип ресурса.

Допустимые значения: hsm
Default value: hsm
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault create

Создайте хранилище или HSM.

Авторизация RBAC включена по умолчанию. Если --enable-rbac-authorization вручную указано для false и флага --no-self-perms не указано, для текущего пользователя или субъекта-службы создаются разрешения по умолчанию.

Если вы хотите назначить разрешение по умолчанию, необходимо сначала изменить подписку по умолчанию с az account set вместо использования --subscription.

az keyvault create --resource-group
                   [--administrators]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--hsm-name]
                   [--location]
                   [--mi-user-assigned]
                   [--name]
                   [--network-acls]
                   [--network-acls-ips]
                   [--network-acls-vnets]
                   [--no-self-perms {false, true}]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--retention-days]
                   [--sku]
                   [--tags]

Примеры

Создайте хранилище ключей с указанными сетевыми списками управления доступом (используйте acls --network-acls для указания правил IP-адресов и виртуальной сети с помощью строки JSON).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\", \"/subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/MyVNet/subnets/MySubnet\"]}"

Создайте хранилище ключей с указанными сетевыми списками управления доступом (используйте acls --network-acls для указания правил IP-адресов и виртуальной сети с помощью JSON-файла).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls network-acls-example.json

Создайте хранилище ключей с указанными сетевыми списками управления доступом (используйте --network-acls-ips для указания правил IP-адресов).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-ips 3.4.5.0/24 4.5.6.0/24

Создайте хранилище ключей с указанными сетевыми списками ACL (используйте --network-acls-vnets для указания правил виртуальной сети).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Создайте хранилище ключей с указанными сетевыми списками управления доступом (используйте --network-acls, --network-acls-ips и --network-acls-vnets-vnets, избыточные правила будут удалены, и, наконец, будут 4 ПРАВИЛА IP-адресов и 3 правила виртуальной сети).

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup --network-acls "{\"ip\": [\"1.2.3.4\", \"2.3.4.0/24\"], \"vnet\": [\"vnet_name_1/subnet_name1\", \"vnet_name_2/subnet_name2\"]}" --network-acls-ips 3.4.5.0/24 4.5.6.0/24 --network-acls-vnets vnet_name_2/subnet_name_2 vnet_name_3/subnet_name_3 /subscriptions/000000-0000-0000/resourceGroups/MyResourceGroup/providers/Microsoft.Network/virtualNetworks/vnet_name_4/subnets/subnet_name_4

Создайте хранилище ключей. (автоматическое создание)

az keyvault create --location westus2 --name MyKeyVault --resource-group MyResourceGroup

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

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

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

--administrators

[Только HSM] Роль администратора для операций плоскости данных для управляемого устройства HSM. Он принимает разделенный пробел списка идентификаторов, которые будут назначены.

--bypass

Обходить трафик для использования с разделением пробелами.

Допустимые значения: AzureServices, None
--default-action

Действие по умолчанию для применения при отсутствии совпадений правил.

Допустимые значения: Allow, Deny
--enable-purge-protection

Свойство, указывающее, включена ли защита от очистки для этого хранилища или управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого пула HSM или управляемого пула HSM и его содержимого. Только служба Key Vault или Managed HSM может инициировать жесткое, безвозвратное удаление. Параметр действует только в том случае, если обратимое удаление также включено. Включение этой функции необратимо.

Допустимые значения: false, true
--enable-rbac-authorization

Свойство, определяющее, как разрешены действия с данными. Если значение true, хранилище ключей будет использовать управление доступом на основе ролей (RBAC) для авторизации действий с данными, а политики доступа, указанные в свойствах хранилища, будут игнорироваться. Если значение false, хранилище ключей будет использовать политики доступа, указанные в свойствах хранилища, и любые политики, хранящиеся в Azure Resource Manager, будут игнорироваться. Если значение NULL или не указано, хранилище создается со значением true по умолчанию. Обратите внимание, что действия управления всегда авторизованы с помощью RBAC.

Допустимые значения: false, true
Default value: True
--enabled-for-deployment

[Только хранилище] Свойство, указываемое, разрешены ли виртуальные машины Azure получать сертификаты, хранящиеся в виде секретов из хранилища ключей.

Допустимые значения: false, true
--enabled-for-disk-encryption

[Только хранилище] Свойство, указываемое, разрешено ли шифрование дисков Azure извлекать секреты из хранилища и распаковывать ключи.

Допустимые значения: false, true
--enabled-for-template-deployment

[Только хранилище] Свойство, указываемое, разрешено ли Azure Resource Manager получать секреты из хранилища ключей.

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

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

--location -l

Местоположение. Значения из: az account list-locations. Расположение по умолчанию можно настроить с помощью az configure --defaults location=<location>.

--mi-user-assigned

[Только HSM] Включите управляемые удостоверения, назначаемые пользователем, для управляемого устройства HSM. Примите идентификаторы ресурсов удостоверений, разделенные пробелами.

--name -n

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

--network-acls

Сетевые списки управления доступом. Он принимает имя ФАЙЛА JSON или строку JSON. Формат JSON: {\"ip\":[<ip1>, <ip2>...],\"vnet\":[<vnet_name_1>/<subnet_name_1>,<subnet_id2>...]}.

--network-acls-ips

Правила IP-адресов сетевых списков управления доступом. Разделенный пробелами список IP-адресов.

--network-acls-vnets

Правила виртуальной сети ACLS. Разделенный пробелами список пар виртуальных сетей и подсетей или идентификаторов ресурсов подсети.

--no-self-perms

[Только хранилище] Не добавляйте разрешения для текущего пользователя или субъекта-службы в новом хранилище.

Допустимые значения: false, true
--no-wait

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

Default value: False
--public-network-access

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

Допустимые значения: Disabled, Enabled
--retention-days

Обратимое удаление дней хранения данных. Он принимает >=7 и <=90. По умолчанию используется значение 90 для создания keyvault. Требуется для создания MHSM.

--sku

Обязательно. Сведения о номере SKU. Допустимые значения для Vault: premium, standard. По умолчанию: стандартный. Допустимые значения для HSM: Standard_B1, Custom_B32. По умолчанию: Standard_B1.

--tags

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

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault delete

Удаление хранилища или HSM.

az keyvault delete [--hsm-name]
                   [--name]
                   [--no-wait]
                   [--resource-group]

Примеры

Удаление хранилища ключей. (автоматическое создание)

az keyvault delete --name MyKeyVault --resource-group MyResourceGroup

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

--hsm-name

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

--name -n

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

--no-wait

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

Default value: False
--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault delete-policy

Удаление параметров политики безопасности для Key Vault.

az keyvault delete-policy --name
                          [--application-id]
                          [--no-wait]
                          [--object-id]
                          [--resource-group]
                          [--spn]
                          [--upn]

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

--name -n

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

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

--application-id

Идентификатор приложения клиента, выполняющего запрос от имени субъекта. Предоставляется для составного удостоверения с помощью потока проверки подлинности от имени.

--no-wait

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

Default value: False
--object-id

ИДЕНТИФИКАТОР GUID, определяющий субъект, который получит разрешения.

--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

--spn

Имя субъекта-службы, который получит разрешения.

--upn

Имя участника-пользователя, который получит разрешения.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault list

Перечисление хранилищ и /или HSM.

az keyvault list [--resource-group]
                 [--resource-type]

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

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--resource-type

Если параметр --resource-type не присутствует, команда выводит список всех хранилищ и HSM. Возможные значения для типа --resource- — хранилище и hsm.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault list-deleted

Получение сведений об удаленных хранилищах или HSM в подписке.

az keyvault list-deleted [--resource-type]

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

--resource-type

Если параметр --resource-type не присутствует, команда выводит список всех удаленных хранилищ и HSM. Возможные значения для типа --resource- — хранилище и hsm.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault purge

Окончательно удалите указанное хранилище или HSM. Ака очищает удаленное хранилище или HSM.

az keyvault purge [--hsm-name]
                  [--location]
                  [--name]
                  [--no-wait]

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

--hsm-name

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

--location -l

Расположение удаленного хранилища или HSM.

--name -n

Имя удаленного хранилища.

--no-wait

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

Default value: False
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault recover

Восстановление хранилища или HSM.

Восстановите ранее удаленное хранилище или HSM, для которого было включено обратимое удаление.

az keyvault recover [--hsm-name]
                    [--location]
                    [--name]
                    [--no-wait]
                    [--resource-group]

Примеры

Восстановление хранилища ключей. (автоматическое создание)

az keyvault recover --location westus2 --name MyKeyVault --resource-group MyResourceGroup

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

--hsm-name

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

--location -l

Расположение удаленного хранилища или HSM.

--name -n

Имя удаленного хранилища.

--no-wait

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

Default value: False
--resource-group -g

Группа ресурсов удаленного хранилища или HSM.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault set-policy

Обновите параметры политики безопасности для Key Vault.

az keyvault set-policy --name
                       [--application-id]
                       [--certificate-permissions {all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update}]
                       [--key-permissions {all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey}]
                       [--no-wait]
                       [--object-id]
                       [--resource-group]
                       [--secret-permissions {all, backup, delete, get, list, purge, recover, restore, set}]
                       [--spn]
                       [--storage-permissions {all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update}]
                       [--upn]

Примеры

Назначьте разрешения ключа get, list, import и secret разрешения backup, restore для идентификатора объекта.

az keyvault set-policy -n MyVault --key-permissions get list import --secret-permissions backup restore --object-id {GUID}

Назначьте разрешения ключа get, list для имени участника-пользователя (имя участника-пользователя).

az keyvault set-policy -n MyVault --key-permissions get list --upn {UPN}

Назначьте разрешения ключа get, list для имени субъекта-службы (имя субъекта-службы).

az keyvault set-policy -n MyVault --key-permissions get list --spn {SPN}

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

--name -n

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

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

--application-id

Идентификатор приложения клиента, выполняющего запрос от имени субъекта. Предоставляется для составного удостоверения с помощью потока проверки подлинности от имени.

--certificate-permissions

Разделенный пробелами список разрешений на назначение сертификатов.

Допустимые значения: all, backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update
--key-permissions

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

Допустимые значения: all, backup, create, decrypt, delete, encrypt, get, getrotationpolicy, import, list, purge, recover, release, restore, rotate, setrotationpolicy, sign, unwrapKey, update, verify, wrapKey
--no-wait

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

Default value: False
--object-id

ИДЕНТИФИКАТОР GUID, определяющий субъект, который получит разрешения.

--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

--secret-permissions

Разделенный пробелами список разрешений секрета для назначения.

Допустимые значения: all, backup, delete, get, list, purge, recover, restore, set
--spn

Имя субъекта-службы, который получит разрешения.

--storage-permissions

Разделенный пробелами список разрешений на хранение.

Допустимые значения: all, backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas, update
--upn

Имя участника-пользователя, который получит разрешения.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault show

Отображение сведений о хранилище или HSM.

az keyvault show [--hsm-name]
                 [--name]
                 [--resource-group]

Примеры

Отображение сведений о хранилище ключей. (автоматическое создание)

az keyvault show --name MyKeyVault

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

--hsm-name

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

--name -n

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

--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault show-deleted

Отображение сведений о удаленном хранилище или HSM.

az keyvault show-deleted [--hsm-name]
                         [--location]
                         [--name]

Примеры

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

az keyvault show-deleted --name MyKeyVault

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

--hsm-name

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

--location -l

Расположение удаленного хранилища или HSM.

--name -n

Имя удаленного хранилища.

Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault update

Обновите свойства хранилища.

az keyvault update --name
                   [--add]
                   [--bypass {AzureServices, None}]
                   [--default-action {Allow, Deny}]
                   [--enable-purge-protection {false, true}]
                   [--enable-rbac-authorization {false, true}]
                   [--enabled-for-deployment {false, true}]
                   [--enabled-for-disk-encryption {false, true}]
                   [--enabled-for-template-deployment {false, true}]
                   [--force-string]
                   [--no-wait]
                   [--public-network-access {Disabled, Enabled}]
                   [--remove]
                   [--resource-group]
                   [--retention-days]
                   [--set]

Примеры

Обновите свойства хранилища. (автоматическое создание)

az keyvault update --enabled-for-disk-encryption true --name MyKeyVault --resource-group MyResourceGroup

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

--name -n

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

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

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--bypass

Обходить трафик для использования с разделением пробелами.

Допустимые значения: AzureServices, None
--default-action

Действие по умолчанию для применения при отсутствии совпадений правил.

Допустимые значения: Allow, Deny
--enable-purge-protection

Свойство, указывающее, включена ли защита от очистки для этого хранилища или управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого пула HSM или управляемого пула HSM и его содержимого. Только служба Key Vault или Managed HSM может инициировать жесткое, безвозвратное удаление. Параметр действует только в том случае, если обратимое удаление также включено. Включение этой функции необратимо.

Допустимые значения: false, true
--enable-rbac-authorization

Свойство, определяющее, как разрешены действия с данными. Если значение true, хранилище ключей будет использовать управление доступом на основе ролей (RBAC) для авторизации действий с данными, а политики доступа, указанные в свойствах хранилища, будут игнорироваться. Если значение false, хранилище ключей будет использовать политики доступа, указанные в свойствах хранилища, и любые политики, хранящиеся в Azure Resource Manager, будут игнорироваться. Если значение NULL или не указано, хранилище создается со значением true по умолчанию. Обратите внимание, что действия управления всегда авторизованы с помощью RBAC.

Допустимые значения: false, true
--enabled-for-deployment

[Только хранилище] Свойство, указываемое, разрешены ли виртуальные машины Azure получать сертификаты, хранящиеся в виде секретов из хранилища ключей.

Допустимые значения: false, true
--enabled-for-disk-encryption

[Только хранилище] Свойство, указываемое, разрешено ли шифрование дисков Azure извлекать секреты из хранилища и распаковывать ключи.

Допустимые значения: false, true
--enabled-for-template-deployment

[Только хранилище] Свойство, указываемое, разрешено ли Azure Resource Manager получать секреты из хранилища ключей.

Допустимые значения: false, true
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--no-wait

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

Default value: False
--public-network-access

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

Допустимые значения: Disabled, Enabled
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> ИЛИ --remove propertyToRemove.

Default value: []
--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

--retention-days

Обратимое удаление дней хранения данных. Он принимает >=7 и <=90.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault update-hsm

Обновите свойства HSM.

az keyvault update-hsm --hsm-name
                       [--add]
                       [--bypass {AzureServices, None}]
                       [--default-action {Allow, Deny}]
                       [--enable-purge-protection {false, true}]
                       [--force-string]
                       [--mi-user-assigned]
                       [--no-wait]
                       [--public-network-access {Disabled, Enabled}]
                       [--remove]
                       [--resource-group]
                       [--secondary-locations]
                       [--set]

Примеры

Обновите свойства HSM.

az keyvault update-hsm --enable-purge-protection true --hsm-name MyHSM --resource-group MyResourceGroup

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

--hsm-name

Имя HSM.

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

--add

Добавьте объект в список объектов, указав пары пути и значения ключа. Пример: --add property.listProperty <key=value, string or JSON string>.

Default value: []
--bypass

Обходить трафик для использования с разделением пробелами.

Допустимые значения: AzureServices, None
--default-action

Действие по умолчанию для применения при отсутствии совпадений правил.

Допустимые значения: Allow, Deny
--enable-purge-protection -e

Свойство, указывающее, включена ли защита от очистки для этого хранилища или управляемого пула HSM. Установка этого свойства на значение true активирует защиту от очистки для этого пула HSM или управляемого пула HSM и его содержимого. Только служба Key Vault или Managed HSM может инициировать жесткое, безвозвратное удаление. Параметр действует только в том случае, если обратимое удаление также включено. Включение этой функции необратимо.

Допустимые значения: false, true
--force-string

При использовании "set" или "add" сохраняйте строковые литералы вместо попытки преобразовать в JSON.

Default value: False
--mi-user-assigned

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

--no-wait

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

Default value: False
--public-network-access

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

Допустимые значения: Disabled, Enabled
--remove

Удалите свойство или элемент из списка. Пример: --remove property.list <indexToRemove> ИЛИ --remove propertyToRemove.

Default value: []
--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

--secondary-locations

--secondary-locations расширяет или контракты пула HSM до перечисленных регионов. Основное расположение, в котором был создан ресурс, не может быть удалено.

--set

Обновите объект, указав путь к свойству и значение для задания. Пример: --set property1.property2=<value>.

Default value: []
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault wait

Поместите интерфейс командной строки в состояние ожидания до тех пор, пока не будет выполнено условие хранилища.

az keyvault wait --name
                 [--created]
                 [--custom]
                 [--deleted]
                 [--exists]
                 [--interval]
                 [--resource-group]
                 [--timeout]
                 [--updated]

Примеры

Приостанавливает интерфейс командной строки до создания хранилища.

az keyvault wait --name MyVault --created

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

--name -n

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

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

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--interval

Интервал опроса в секундах.

Default value: 30
--resource-group -g

Продолжайте работу, только если Key Vault принадлежит указанной группе ресурсов.

--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.

az keyvault wait-hsm

Поместите интерфейс командной строки в состояние ожидания, пока не будет выполнено условие HSM.

az keyvault wait-hsm --hsm-name
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--resource-group]
                     [--timeout]
                     [--updated]

Примеры

Приостанавливает интерфейс командной строки до создания HSM.

az keyvault wait-hsm --hsm-name MyHSM --created

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

--hsm-name

Имя HSM.

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

--created

Подождите, пока не будет создано с помощью provisioningState по адресу "Успешно".

Default value: False
--custom

Подождите, пока условие не будет удовлетворено пользовательским запросом JMESPath. Например, provisioningState!='InProgress', instanceView.statuses[?code='PowerState/running'].

--deleted

Дождитесь удаления.

Default value: False
--exists

Подождите, пока ресурс не существует.

Default value: False
--interval

Интервал опроса в секундах.

Default value: 30
--resource-group -g

Продолжайте, только если HSM принадлежит указанной группе ресурсов.

--timeout

Максимальное ожидание в секундах.

Default value: 3600
--updated

Подождите, пока не будет обновлено с помощью provisioningState по адресу "Успешно".

Default value: False
Глобальные параметры
--debug

Увеличьте детализацию ведения журнала, чтобы отобразить все журналы отладки.

--help -h

Отображение этого сообщения справки и выхода.

--only-show-errors

Отображаются только ошибки, подавляющие предупреждения.

--output -o

Формат вывода.

Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте детализацию ведения журнала. Используйте --debug для полных журналов отладки.