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		Варианты: 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		Варианты: validate ignore	Управляет поведением проверки сертификата для 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 boolean		Варианты: no ← yes	Если включено, проверка идемпотентности будет выполнена с использованием метода GET, а затем сравнение с body
method -		Варианты: GET PUT ← POST HEAD PATCH DELETE MERGE	Метод HTTP запроса или ответа. ДОЛЖЕН быть указан заглавными буквами.
password -			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
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. Аутентификация возможна с использованием принципала службы или пользователя 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 словарь	всегда	Данные, специфичные для типа ресурса.

Статус

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