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			Варианты: 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.
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 -			Имя куки для использования в куки-аффинитете.
	authentication_certificates -			Список ссылок на сертификаты аутентификации шлюза приложений. Применимо только при включенном `cookie_based_affinity`, в противном случае игнорируется.
		id -		Идентификатор ресурса.
	cookie_based_affinity -		Варианты: включено выключено	Аффинити на основе куки.
	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 -		Варианты: статический динамический	Метод распределения частных IP-адресов.

	public_ip_address -		Ссылка на ресурс PublicIP.
	subnet -		Ссылка на ресурс подсети.
frontend_ports -			Список портов передней части ресурса шлюза приложений.
	name -		Имя ресурса, уникальное в пределах группы ресурсов. Это имя может быть использовано для доступа к ресурсу.
	port -		Порт передней части.
gateway_ip_configurations -			Список подсетей, используемых шлюзом приложений.
	name -		Имя ресурса, уникальное в пределах группы ресурсов. Это имя может быть использовано для доступа к ресурсу.
	subnet -		Ссылка на ресурс подсети. Подсеть, из которой шлюз приложений получает свой частный адрес.
http_listeners -			Список слушателей HTTP ресурса шлюза приложений.
	frontend_ip_configuration -		Ресурс конфигурации IP-адреса передней части шлюза приложений.
	frontend_port -		Ресурс порта передней части шлюза приложений.
	host_name -		Имя хоста слушателя `http`.
	name -		Имя ресурса, уникальное в пределах группы ресурсов. Это имя может быть использовано для доступа к ресурсу.
	protocol -	Варианты: http https	Протокол слушателя (http).
	require_server_name_indication -		Применимо только если протокол `https`. Включает SNI для многохостинга.
	ssl_certificate -		Ресурс SSL-сертификата шлюза приложений.
location -			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
name - / обязательно			Имя шлюза приложений.
password строка			Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.
probes - добавлен в 2.8			Пробы, доступные для ресурса шлюза приложений.
	host -		Имя хоста, к которому отправляется проба.
	interval -		Интервал зондирования в секундах. Это интервал времени между двумя последовательными пробами. Допустимые значения от 1 секунды до 86400 секунд.
	name -		Имя пробы, уникальное в пределах шлюза приложений.
	path -		Относительный путь пробы. Действительный путь начинается с '/'. Проба отправляется в <Протокол>://<хост>:<порт><путь>.
	protocol -	Варианты: http https	Протокол, используемый для пробы.
	timeout -		Таймаут пробы в секундах. Проба отмечается как не пройденная, если действительный ответ не получен в этот период таймаута. Допустимые значения от 1 секунды до 86400 секунд.
	unhealthy_threshold -		Количество попыток повторного подключения пробы. Сервер обратной связи отмечается как неисправный после того, как количество последовательных сбоев пробы достигло UnhealthyThreshold. Допустимые значения от 1 до 20.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
redirect_configurations - добавлен в 2.8			Конфигурации перенаправления ресурса шлюза приложений.
	include_path -		Включать путь в перенаправляемый URL.
	include_query_string -		Включать строку запроса в перенаправляемый URL.
	name -		Имя ресурса, уникальное в пределах группы ресурсов.
	redirect_type -	Варианты: permanent found see_other temporary	Тип перенаправления.
	target_listener -		Ссылка на слушатель, к которому перенаправлять запрос.
request_routing_rules -			Список правил маршрутизации запросов ресурса шлюза приложений.
	backend_address_pool -		Ресурс пула адресов обратной связи шлюза приложений.
	backend_http_settings -		Ресурс настроек HTTP обратной связи шлюза приложений.
	http_listener -		Ресурс слушателя HTTP шлюза приложений.
	name -		Имя ресурса, уникальное в пределах группы ресурсов. Это имя может быть использовано для доступа к ресурсу.
	redirect_configuration -		Ресурс конфигурации перенаправления шлюза приложений.
	rule_type -	Варианты: basic path_based_routing	Тип правила.
resource_group - / обязательно			Имя группы ресурсов.
secret строка			Секрет Azure клиента. Используется при аутентификации с помощью Службы-принципала.

sku -			SKU ресурса шлюза приложений.
	capacity -		Ёмкость (количество экземпляров) шлюза приложений.
	name -	Варианты: standard_small standard_medium standard_large waf_medium waf_large	Имя SKU шлюза приложений.
	tier -	Варианты: standard waf	Уровень шлюза приложений.
ssl_certificates -			Сертификаты SSL ресурса шлюза приложений.
	data -		Сертификат в кодировке base-64 pfx. Применимо только для запросов PUT.
	name -		Имя ресурса, уникальное в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
	password -		Пароль для файла pfx, указанного в data. Применимо только для запросов 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 string			Ваш идентификатор подписки Azure.
tags dictionary			Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant string			Идентификатор Azure-аренды. Используйте при аутентификации с помощью принципала службы.

Примечания

Примечание

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

Статус

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