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) | Значение по умолчанию: null | URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственном авторитете ADFS. |
| api_profile (добавлено в 2.5) | Значение по умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags bool |
| Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом поле теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| auth_source (добавлено в 2.5) |
| Управляет источником используемых учетных данных для аутентификации. Если не указано, будет использована переменная среды 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) |
| Управляет поведением проверки сертификатов для 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 обязательно | URL конечной точки хранилища ключей. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory вместо сервисного принципала. | |
| pem_file | Файл PEM. | |
| pem_password | Пароль файла PEM. | |
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| secret | Секрет клиента Azure. Используется при аутентификации с помощью сервисного принципала. | |
| state |
| Утвердить состояние ключа. Используйте 'present' для создания ключа и 'absent' для удаления ключа. |
| subscription_id | Ваш идентификатор подписки Azure. | |
| tags | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false. | |
| tenant | Идентификатор клиента 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 сложный | успех | Текущее состояние ключа. | |
| key_id str | Путь к ресурсу ключа. | ||
Статус
Этот модуль помечен как предварительный, что означает, что его интерфейс не гарантируется как обратной совместимый.
Техническое обслуживание
Этот модуль помечен как сообщественный, что означает, что его поддерживает сообщество Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_keyvaultkey_module.html
