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			URL-адрес полномочий Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственных полномочиях ADFS.
api_profile строка добавлено в 2.5		Значение по умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
api_version -			Конкретная версия API для использования.
auth_source строка добавлено в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная окружения 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		Варианты: ignore validate	Управляет поведением проверки сертификатов для 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 логическое		Варианты: нет ← да	Если включено, будет выполняться проверка идемпотентности, сначала используя метод GET, а затем сравнивая с body
method -		Варианты: GET PUT ← POST HEAD PATCH DELETE MERGE	Метод HTTP запроса или ответа. ДОЛЖЕН быть указан в верхнем регистре.
password -			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
polling_interval целое число добавлено в 2.8		Значение по умолчанию: 60	Если включено, будет выполняться проверка идемпотентности, сначала используя метод GET, а затем сравнивая с body
polling_timeout целое число добавлено в 2.8		Значение по умолчанию: 0	Если включено, будет выполняться проверка идемпотентности, сначала используя метод GET, а затем сравнивая с body
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
provider -			Тип поставщика. Требуется, если URL не указан.
resource_group -			Группа ресурсов для использования. Требуется, если URL не указан.
resource_name -			Имя ресурса. Требуется, если URL не указан.
resource_type -			Тип ресурса. Требуется, если URL не указан.
secret строка			Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
state -		Варианты: absent present ←	Утвердить состояние ресурса. Используйте `present` для создания или обновления ресурса или `absent` для удаления ресурса.
status_code -		Значение по умолчанию: [200, 201, 202]	Действительный числовой код состояния HTTP, указывающий на успешность запроса. Также может быть перечислением кодов состояния через запятую.
subresource -			Список подресурсов
	name -		Имя подресурса
	namespace -		Пространство имен подресурса
	type -		Тип подресурса
subscription_id строка			Ваш идентификатор подписки Azure.
tenant строка			Идентификатор Azure-аренды. Используйте при аутентификации с принципалом службы.
url -			URL ресурса Azure RM.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или плейбука с помощью az login.
Аутентификация также возможна с помощью управляющего сервиса или пользователя 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 в среде.

См. также

Авторизация с помощью Azure CLI: Как выполнить аутентификацию, используя команду az login.

Примеры

- name: Update scaleset info using azure_rm_resource
  azure_rm_resource:
    resource_group: myResourceGroup
    provider: compute
    resource_type: virtualmachinescalesets
    resource_name: myVmss
    api_version: "2017-12-01"
    body: { body }

Значения возврата

Общие значения возврата документированы здесь, ниже приведены поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
response словарь	всегда	Данные ответа, специфичные для типа ресурса.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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.8/modules/azure_rm_resource_module.html