azure_rm_resource - Создание любого ресурса Azure.
Новая версия с 2.6.
Обзор
- Создание, обновление или удаление любого ресурса Azure с помощью Azure REST API.
- Этот модуль предоставляет доступ к ресурсам, которые не поддерживаются модулями Ansible.
- Обратитесь к https://docs.microsoft.com/en-us/rest/api/ для получения подробной информации о конкретном REST API ресурса.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- 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. | |
| api_version обязательно | Конкретная версия API для использования. | ||
| 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. | |
| body | Тело http запроса/ответа веб-сервису. | ||
| 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. | |
| idempotency bool |
| Если включено, проверка идемпотентности будет выполнена с использованием метода GET вначале, а затем сравнение с body
| |
| method |
| HTTP-метод запроса или ответа. Он ДОЛЖЕН быть в верхнем регистре. | |
| password | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы. | ||
| profile | Профиль безопасности, найденный в файле ~/.azure/credentials. | ||
| provider | Тип поставщика. Необходимо, если URL не указан. | ||
| resource_group | Группа ресурсов, которая будет использоваться. Необходимо, если URL не указан. | ||
| resource_name | Имя ресурса. Необходимо, если URL не указан. | ||
| resource_type | Тип ресурса. Необходимо, если URL не указан. | ||
| secret | Секрет клиента Azure. Используется при аутентификации с принципалом службы. | ||
| state |
| Утверждение состояния ресурса. Используйте present для создания или обновления ресурса или absent для удаления ресурса. | |
| status_code | Значение по умолчанию: [200, 201, 202] | Действительный числовой HTTP-код состояния, указывающий на успешность запроса. Также может быть списком кодов состояния, разделённых запятыми. | |
| subresource | Список подресурсов | ||
| namespace | Пространство имен подресурса | ||
| type | Тип подресурса | ||
| name | Имя подресурса | ||
| subscription_id | Ваш идентификатор подписки Azure. | ||
| tenant | Идентификатор клиента Azure. Используется при аутентификации с принципалом службы. | ||
| url | URL ресурса Azure RM. | ||
Примечания
Примечание
- Для аутентификации с 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: Update scaleset info using azure_rm_resource
azure_rm_resource:
resource_group: "{{ resource_group }}"
provider: compute
resource_type: virtualmachinescalesets
resource_name: "{{ scaleset_name }}"
api_version: "2017-12-01"
body: "{{ body }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| response dict | всегда | Ответ, специфичный для типа ресурса. |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/azure_rm_resource_module.html
