azure_rm_keyvaultsecret - Использование секретов Azure KeyVault.
Новая версия с 2.5.
Обзор
- Создать или удалить секрет в заданном хранилище ключей. Используя хранилище ключей, вы можете шифровать ключи и секреты (такие как ключи аутентификации, ключи учетных записей хранилища, ключи шифрования данных, файлы .PFX и пароли).
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | Значение по умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| append_tags | Значение по умолчанию: yes | Управление полем тегов: каноническое или добавляется к существующим тегам. При каноническом значении теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать стандартной очередности параметров модуля -> переменные окружения -> профиля по умолчанию в файле credential ~/.azure/credentials.При установке в cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также можно установить через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управление поведением проверки сертификатов для Azure-точке. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack, возможно, потребуется отключить это поведение, передав ignore. Также можно установить через профиль файла учетных данных или переменную окружения AZURE_CERT_VALIDATION. |
| client_id | Значение по умолчанию: None | Azure client ID. Используется при аутентификации с помощью служебного принципала. |
| cloud_environment (добавлен в 2.4) | Значение по умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также можно установить через профиль файла учетных данных или переменную окружения AZURE_CLOUD_ENVIRONMENT. |
| keyvault_uri обязательно | URI конечной точки хранилища ключей. | |
| password | Значение по умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо служебного принципала. |
| profile | Значение по умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| secret | Значение по умолчанию: None | Секрет Azure client. Используется при аутентификации с помощью служебного принципала. |
| secret_name обязательно | Имя секрета в хранилище ключей. | |
| secret_value | Секрет, который необходимо защитить в хранилище ключей. псевдонимы: secret | |
| state |
| Утвердить состояние подсети. Используйте '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 secret
azure_rm_keyvaultsecret:
secret_name: MySecret
secret_value: My_Pass_Sec
keyvault_uri: https://contoso.vault.azure.net/
tags:
testing: testing
delete: never
- name: Delete a secret
azure_rm_keyvaultsecret:
secret_name: MySecret
keyvault_uri: https://contoso.vault.azure.net/
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| state сложное | success | Текущее состояние секрета. | |
| secret_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_keyvaultsecret_module.html
