azure_rm_keyvaultkey - Использование ключей Azure KeyVault.

Новое в версии 2.5.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Создание или удаление ключа в заданном хранилище ключей. Используя хранилище ключей, можно шифровать ключи и секреты (такие как ключи аутентификации, ключи учетных записей хранилища, ключи шифрования данных, файлы .PFX и пароли).

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user	Значение по умолчанию: None	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
api_profile (добавлено в 2.5)	Варианты: latest ←	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags	Значение по умолчанию: yes	Используется для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом теге любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source (добавлено в 2.5)	Варианты: auto ← cli credential_file env	Управляет источником учетных данных для аутентификации. `auto` будет следовать по умолчанию приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI по умолчанию. Также можно установить через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`.
byok_file		Файл BYOK.
cert_validation_mode (добавлено в 2.5)	Варианты: validate ignore Значение по умолчанию: None	Управляет поведением проверки сертификатов для Azure-эндпоинтов. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id	Значение по умолчанию: None	Azure идентификатор клиента. Используется при аутентификации с главным принципом службы.
cloud_environment (добавлено в 2.4)	Значение по умолчанию: AzureCloud	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес для обнаружения метаданных (требуется для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
key_name обязательно		Имя ключа хранилища ключей.
keyvault_uri обязательно		URI конечной точки хранилища ключей.
password	Значение по умолчанию: None	Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным принципом службы.
pem_file		Файл PEM.
pem_password		Пароль файла PEM.
profile	Значение по умолчанию: None	Профиль безопасности, найденный в файле ~/.azure/credentials.
secret	Значение по умолчанию: None	Секрет клиента Azure. Используется при аутентификации с главным принципом службы.
state	Варианты: absent present ←	Утверждает состояние ключа. Используйте 'present' для создания ключа и 'absent' для удаления ключа.
subscription_id	Значение по умолчанию: None	Ваш идентификатор подписки Azure.
tags	Значение по умолчанию: None	Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Чтобы удалить теги, установите параметр append_tags в значение false.
tenant	Значение по умолчанию: None	Идентификатор клиента Azure. Используется при аутентификации с главным принципом службы.

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, устанавливать переменные среды или использовать профиль, сохраненный в файле ~/.azure/credentials. Аутентификация возможна с помощью главного принципа службы или пользователя Active Directory. Для аутентификации через главного принципа службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также можно добавить дополнительные профили. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

Примеры

- name: Create a key
  azure_rm_keyvaultkey:
    key_name: MyKey
    keyvault_uri: https://contoso.vault.azure.net/

- name: Delete a key
  azure_rm_keyvaultkey:
    key_name: MyKey
    keyvault_uri: https://contoso.vault.azure.net/
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ		Возвращаемое значение	Описание
state сложное		success	Текущее состояние ключа.
	key_id str		Путь к ресурсу ключа.

Статус

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

Автор

Ian Philpot (@tripdubroot)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_keyvaultkey_module.html