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 | По умолчанию: null | URL-адрес авторизации Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS. |
| api_profile - добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags boolean |
| Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. |
| 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 - / обязательно | URI конечной точки хранилища ключей. | |
| 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 complex | success | Текущее состояние ключа. | |
| key_id string | Путь к ресурсу ключа. | ||
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_keyvaultkey_module.html
