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

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

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

Обзор

Создание или удаление ключа в заданном хранилище ключей. С помощью хранилища ключей вы можете шифровать ключи и секреты (такие как ключи аутентификации, ключи учетных записей хранилища, ключи шифрования данных, файлы .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 логическое значение	Варианты: нет да ←	Управляет тем, будет ли поле тегов каноническим или просто добавляться к существующим тегам. При канонизации любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 2.5	Варианты: авто 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 сложный		успех	Текущее состояние ключа.
	key_id строка		Путь к ресурсу ключа.

Статус

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

Авторы

Ian Philpot (@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.8/modules/azure_rm_keyvaultkey_module.html