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

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

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

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

Примечания

Примечание

Для аутентификации с Azure можно передавать параметры, задавать переменные среды, использовать профиль, хранящийся в файле ~/.azure/credentials, или выполнить вход до выполнения задач или игрового сценария с az login.
Аутентификация также возможна с помощью принципала службы или пользователя 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 в среде.

См. также

Вход с помощью Azure CLI: Как войти с помощью команды az login.

Примеры

- 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 строка		Путь к ресурсу ключа.

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [бета]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Иэн Фильпот (@iphilpot)

Подсказка

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

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