azure_rm_keyvault - Управление экземпляром хранилища ключей.
Новая версия с 2.5.
Обзор
- Создание, обновление и удаление экземпляра хранилища ключей.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_policies | Массив от 0 до 16 идентификаторов, имеющих доступ к хранилищу ключей. Все идентификаторы в массиве должны использовать тот же идентификатор клиента, что и идентификатор клиента хранилища ключей. | ||
| secrets |
| Список разрешений на секреты | |
| application_id | Идентификатор приложения клиента, выполняющего запрос от имени принципала | ||
| keys |
| Список разрешений на ключи | |
| tenant_id | Идентификатор клиента Azure Active Directory, который должен использоваться для аутентификации запросов к хранилищу ключей. Текущее значение хранилища ключей tenant_id будет использоваться, если не указано иное. | ||
| certificates |
| Список разрешений на сертификаты | |
| storage | Список разрешений на учетные записи хранения | ||
| object_id обязательно | Идентификатор объекта пользователя, управляющего принципала или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. Обратите внимание, что это не идентификатор приложения. Идентификатор объекта можно получить, выполнив команду "az ad show sp --id <идентификатор приложения>". | ||
| ad_user | Значение по умолчанию: Нет | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо управляющего принципала. | |
| api_profile (добавлено в 2.5) |
| Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. | |
| auth_source (добавлено в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать стандартному приоритету параметров модуля -> переменные среды -> стандартный профиль в файле учетных данных ~/.azure/credentials.При установке в cli, учетные данные будут взяты из стандартного профиля Azure CLI.Также может быть установлено через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. | |
| 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 |
| Свойство для указания, включена ли функция мягкого удаления для этого хранилища ключей. | |
| enabled_for_deployment |
| Свойство для указания, разрешено ли виртуальным машинам Azure извлекать хранящиеся как секреты сертификаты из хранилища ключей. | |
| enabled_for_disk_encryption |
| Свойство для указания, разрешено ли Azure Disk Encryption извлекать секреты из хранилища и расшифровывать ключи. | |
| enabled_for_template_deployment |
| Свойство для указания, разрешено ли Azure Resource Manager извлекать секреты из хранилища ключей. | |
| location | Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию. | ||
| password | Значение по умолчанию: Нет | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо управляющего принципала. | |
| profile | Значение по умолчанию: Нет | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| recover_mode |
| Создать хранилище в режиме восстановления. | |
| resource_group обязательно | Имя группы ресурсов, к которой относится сервер. | ||
| secret | Значение по умолчанию: Нет | Секрет клиента Azure. Используется при аутентификации с помощью управляющего принципала. | |
| sku | Подробности SKU | ||
| name обязательно |
| Имя SKU, чтобы указать, является ли хранилище ключей стандартным или премиум-хранилищем. | |
| family обязательно | Имя семейства 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 str | всегда | Идентификатор ресурса Azure Resource Manager для хранилища ключей. Пример: id |
Статус
Этот модуль помечен как превью, что означает отсутствие гарантии обратной совместимости интерфейса.
Автор
- 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.5/modules/azure_rm_keyvault_module.html
