azure_rm_appgateway – Управление экземпляром Application Gateway

Новое в версии 2.7.

Описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения
Статус

Описание

Создание, обновление и удаление экземпляра Application Gateway.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

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.
append_tags логическое значение			Варианты: нет да ←	Используется для управления тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5			Варианты: авто 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.
authentication_certificates -				Сертификаты аутентификации ресурса шлюза приложений.
	data -			Открытые данные сертификата — закодированный в base64 pfx.
	name -			Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
backend_address_pools -				Список пулов адресов обратного подключения ресурса шлюза приложений.
	backend_addresses -			Список адресов обратного подключения.
		fqdn -		Полное доменное имя (FQDN).
		ip_address -		IP-адрес.
	name -			Ресурс, уникальный в рамках группы ресурсов. Это имя может быть использовано для доступа к ресурсу.
backend_http_settings_collection -				Настройки http обратного подключения ресурса шлюза приложений.
	affinity_cookie_name -			Имя cookie, используемого для cookie-аффинитета.
	authentication_certificates -			Список ссылок на сертификаты аутентификации шлюза приложений.
		id -		Идентификатор ресурса.
	cookie_based_affinity -		Варианты: включено выключено	Аффинитет на основе cookie.
	host_name -			Заголовок хоста, который должен быть отправлен на серверы обратного подключения.
	name -			Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	path -			Путь, который должен использоваться в качестве префикса для всех `http` запросов. Null означает, что префикс пути не будет добавлен. Значение по умолчанию — null.
	pick_host_name_from_backend_address -			Нужно ли выбирать заголовок хоста из имени хоста сервера обратного подключения. Значение по умолчанию — false.
	port -			Порт назначения на сервере обратного подключения.
	probe -			Ресурс зондирования шлюза приложений.
	protocol -		Варианты: http https	Протокол, используемый для взаимодействия с серверами обратного подключения.
	request_timeout -			Таймаут запроса в секундах. Шлюз приложений отклонит запрос, если ответ не будет получен в течение RequestTimeout. Допустимые значения от 1 до 86400 секунд.
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`.
frontend_ip_configurations -				IP-адреса фронтального подключения ресурса шлюза приложений.
	name -			Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	private_ip_address -			PrivateIPAddress конфигурации IP-адреса сетевого интерфейса.
	private_ip_allocation_method -		Варианты: статический динамический	Метод выделения privateIP.
	public_ip_address -			Ссылка на ресурс PublicIP.

	подсеть -		Ссылка на ресурс подсети.
передние_порты -			Список передних портов ресурса шлюза приложений.
	имя -		Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	порт -		Передний порт.
шлюзы_ip_конфигураций -			Список подсетей, используемых шлюзом приложений.
	имя -		Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	подсеть -		Ссылка на ресурс подсети. Подсеть, из которой шлюз приложений получает свой частный адрес.
http_слушатели -			Список HTTP-слушателей ресурса шлюза приложений.
	передняя_ip_конфигурация -		Ресурс конфигурации переднего IP-адреса шлюза приложений.
	передний_порт -		Ресурс переднего порта шлюза приложений.
	имя_хоста -		Имя хоста `http` слушателя.
	имя -		Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	протокол -	Варианты: http https	Протокол слушателя (http).
	требовать_указание_имени_сервера -		Применимо только если протокол `https`. Включает SNI для многохостинга.
	ssl_сертификат -		Ресурс SSL-сертификата шлюза приложений.
местоположение -			Местоположение ресурса. Если не задано, будет использоваться местоположение из группы ресурсов по умолчанию.
имя - / обязательно			Имя шлюза приложений.
пароль -			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо сервисного принципала.
зонды - добавлен в 2.8			Зонды, доступные для ресурса шлюза приложений.
	хост -		Имя хоста, к которому отправляется зонд.
	интервал -		Интервал зондирования в секундах. Это интервал времени между двумя последовательными зондированиями. Допустимые значения от 1 секунды до 86400 секунд.
	имя -		Имя зонда, уникальное в рамках шлюза приложений.
	путь -		Относительный путь зонда. Допустимый путь начинается с '/'. Зонд отправляется по <Протокол>://<хост>:<порт><путь>.
	протокол -	Варианты: http https	Протокол, используемый для зонда.
	таймаут -		Таймаут зондирования в секундах. Зонд отмечается как неисправный, если действительный ответ не получен в течение этого таймаута. Допустимые значения от 1 секунды до 86400 секунд.
	порог_неисправности -		Количество попыток повторного зондирования. Фоновый сервер отмечается как неисправный, после того как количество последовательных неудачных зондирований достигает порога неисправности. Допустимые значения от 1 до 20.
профиль строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
конфигурации_перенаправления - добавлен в 2.8			Конфигурации перенаправления ресурса шлюза приложений.
	включать_путь -		Включать путь в перенаправленный URL.
	включать_строку_запроса -		Включать строку запроса в перенаправленный URL.
	имя -		Имя ресурса, уникальное в группе ресурсов.
	тип_перенаправления -	Варианты: постоянное найдено см_другое временное	Тип перенаправления.
	целевой_слушатель -		Ссылка на слушатель, к которому перенаправлять запрос.
правила_маршрутизации_запросов -			Список правил маршрутизации запросов ресурса шлюза приложений.
	пул_адресов_бекенда -		Ресурс пула адресов бэкенда шлюза приложений.
	настройки_бекенда_http -		Ресурс настроек бэкенда `http` шлюза приложений.
	http_слушатель -		Ресурс слушателя http шлюза приложений.
	имя -		Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	конфигурация_перенаправления -		Ресурс конфигурации перенаправления шлюза приложений.
	тип_правила -	Варианты: базовое маршрутизация_по_пути	Тип правила.
группа_ресурсов - / обязательно			Имя группы ресурсов.
секрет строка			Секретный ключ клиента Azure. Используется при аутентификации с помощью сервисного принципала.
sku -			SKU ресурса шлюза приложений.

	емкость -		Ёмкость (количество экземпляров) шлюза приложений.
	имя -	Варианты: standard_small standard_medium standard_large waf_medium waf_large	Имя SKU шлюза приложений.
	уровень -	Варианты: standard waf	Уровень шлюза приложений.
ssl_certificates -			Сертификаты SSL ресурса шлюза приложений.
	данные -		Сертификат pfx, закодированный в Base-64. Применим только в запросах PUT.
	имя -		Имя ресурса, уникального в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	пароль -		Пароль для файла pfx, указанного в данные. Применим только в запросах PUT.
ssl_policy -			Политика SSL ресурса шлюза приложений.
	cipher_suites -	Варианты: tls_ecdhe_rsa_with_aes_256_gcm_sha384 tls_ecdhe_rsa_with_aes_128_gcm_sha256 tls_ecdhe_rsa_with_aes_256_cbc_sha384 tls_ecdhe_rsa_with_aes_128_cbc_sha256 tls_ecdhe_rsa_with_aes_256_cbc_sha tls_ecdhe_rsa_with_aes_128_cbc_sha tls_dhe_rsa_with_aes_256_gcm_sha384 tls_dhe_rsa_with_aes_128_gcm_sha256 tls_dhe_rsa_with_aes_256_cbc_sha tls_dhe_rsa_with_aes_128_cbc_sha tls_rsa_with_aes_256_gcm_sha384 tls_rsa_with_aes_128_gcm_sha256 tls_rsa_with_aes_256_cbc_sha256 tls_rsa_with_aes_128_cbc_sha256 tls_rsa_with_aes_256_cbc_sha tls_rsa_with_aes_128_cbc_sha tls_ecdhe_ecdsa_with_aes_256_gcm_sha384 tls_ecdhe_ecdsa_with_aes_128_gcm_sha256 tls_ecdhe_ecdsa_with_aes_256_cbc_sha384 tls_ecdhe_ecdsa_with_aes_128_cbc_sha256 tls_ecdhe_ecdsa_with_aes_256_cbc_sha tls_ecdhe_ecdsa_with_aes_128_cbc_sha tls_dhe_dss_with_aes_256_cbc_sha256 tls_dhe_dss_with_aes_128_cbc_sha256 tls_dhe_dss_with_aes_256_cbc_sha tls_dhe_dss_with_aes_128_cbc_sha tls_rsa_with_3des_ede_cbc_sha tls_dhe_dss_with_3des_ede_cbc_sha	Список наборов шифров SSL, которые должны быть включены в указанном порядке для шлюза приложений.
	disabled_ssl_protocols -	Варианты: tls_v1_0 tls_v1_1 tls_v1_2	Список протоколов SSL, которые нужно отключить на шлюзе приложений.
	min_protocol_version -	Варианты: tls_v1_0 tls_v1_1 tls_v1_2	Минимальная версия протокола Ssl, поддерживаемая шлюзом приложений.
	policy_name -	Варианты: ssl_policy20150501 ssl_policy20170401 ssl_policy20170401_s	Имя политики Ssl `predefined`.
	policy_type -	Варианты: predefined custom	Тип политики SSL.
state -		Варианты: absent present ←	Утвердите состояние общедоступного IP-адреса. Используйте `present`, чтобы создать или обновить, и `absent`, чтобы удалить.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка, назначаемых в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
tenant строка			Идентификатор Azure-аренды. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

Для аутентификации в 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. Также возможно добавление дополнительных профилей. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

Вход в Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create instance of Application Gateway
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myappgateway
    sku:
      name: standard_small
      tier: standard
      capacity: 2
    gateway_ip_configurations:
      - subnet:
          id: "{{ subnet_id }}"
        name: app_gateway_ip_config
    frontend_ip_configurations:
      - subnet:
          id: "{{ subnet_id }}"
        name: sample_gateway_frontend_ip_config
    frontend_ports:
      - port: 90
        name: ag_frontend_port
    backend_address_pools:
      - backend_addresses:
          - ip_address: 10.0.0.4
        name: test_backend_address_pool
    backend_http_settings_collection:
      - port: 80
        protocol: http
        cookie_based_affinity: enabled
        name: sample_appgateway_http_settings
    http_listeners:
      - frontend_ip_configuration: sample_gateway_frontend_ip_config
        frontend_port: ag_frontend_port
        name: sample_http_listener
    request_routing_rules:
      - rule_type: Basic
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

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

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

Ключ	Возвращаемое	Описание
id строка	всегда	Идентификатор ресурса. Пример: id

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Зим Калиновский (@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_appgateway_module.html