azure_rm_keyvault – Управление экземпляром хранилища ключей.
Новая версия с 2.5.
Описание
- Создание, обновление и удаление экземпляра хранилища ключей.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_policies - | Массив из 0 до 16 идентификаторов, имеющих доступ к хранилищу ключей. Все идентификаторы в массиве должны использовать тот же идентификатор клиента, что и хранилище ключей. | ||
| application_id - | Идентификатор приложения клиента, выполняющего запрос от имени принципала | ||
| certificates - |
| Список разрешений на сертификаты | |
| keys - |
| Список разрешений на ключи | |
| object_id - / обязательно | Идентификатор объекта пользователя, службы или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. Обратите внимание, что это не идентификатор приложения. Идентификатор объекта можно получить, выполнив команду "az ad show sp --id <идентификатор_приложения>". | ||
| secrets - |
| Список разрешений на секреты | |
| storage - | Список разрешений на учетные записи хранения | ||
| tenant_id - | Идентификатор клиента Azure Active Directory, который должен использоваться для проверки подлинности запросов к хранилищу ключей. Текущее значение хранилища ключей tenant_id будет использоваться, если не указано иное. | ||
| 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. | |
| 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. | |
| 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. | |
| enable_soft_delete boolean |
| Свойство для указания, включена ли функция мягкого удаления для данного хранилища ключей. | |
| enabled_for_deployment boolean |
| Свойство для указания, разрешено ли виртуальным машинам Azure получать сертификаты, хранящиеся как секреты в хранилище ключей. | |
| enabled_for_disk_encryption boolean |
| Свойство для указания, разрешено ли шифрование дисков Azure получать секреты из хранилища и расшифровывать ключи. | |
| enabled_for_template_deployment boolean |
| Свойство для указания, разрешено ли Azure Resource Manager получать секреты из хранилища ключей. | |
| location - | Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию. | ||
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| recover_mode boolean |
| Создать хранилище в режиме восстановления. | |
| resource_group - / обязательно | Имя группы ресурсов, к которой принадлежит сервер. | ||
| secret - | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| sku - | Детали SKU | ||
| family - / обязательно | Имя семейства SKU | ||
| name - / обязательно |
| Имя SKU для указания, является ли хранилище ключей стандартным или премиум-класса. | |
| state - |
| Утверждение состояния хранилища ключей. Используйте 'present' для создания или обновления хранилища ключей и 'absent' для его удаления. | |
| subscription_id - | Ваш идентификатор подписки Azure. | ||
| tenant - | Идентификатор Azure-аренды. Используется при аутентификации с помощью Служебного принципа. | ||
| vault_name - / обязательно | Имя хранилища ключей | ||
| vault_tenant - | Идентификатор Azure Active Directory аренды, который должен использоваться для аутентификации запросов к хранилищу ключей. | ||
Примечания
Примечание
- Для аутентификации с 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 instance of Key Vault
azure_rm_keyvault:
resource_group: myresourcegroup
vault_name: samplekeyvault
enabled_for_deployment: yes
vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
sku:
name: standard
access_policies:
- tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
object_id: 99998888-8666-4144-9199-2d7cd0111111
keys:
- get
- list
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| id строка | всегда | Идентификатор ресурса Azure Resource Manager для хранилища ключей. Пример: id |
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Zim Kalinowski (@zikalino)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_keyvault_module.html
