Spec-Zone.ru › Ansible

модуль azure.azcollection.azure_rm_appgateway — управление экземпляром шлюза приложений

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_appgateway.

Добавлено в azure.azcollection 0.1.2

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

Краткое описание

  • Создание, обновление и удаление экземпляра шлюза приложений.

Требования

На узле, выполняющем этот модуль, необходимы следующие компоненты.

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке доступны по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

ad_user

string

Имя пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

adfs_authority_url

string

добавлено в azure.azcollection 0.0.1

URL-адрес центра Azure AD. Используется при аутентификации по имени пользователя и паролю, если у вас есть собственный центр ADFS.

api_profile

string

добавлено в azure.azcollection 0.0.1

Выбирает профиль API для взаимодействия со службами Azure. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

Если поле каноническое, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

  • false
  • true ← (по умолчанию)

auth_source

string

добавлено в azure.azcollection 0.0.1

Определяет источник учетных данных для аутентификации.

Также можно задать с помощью переменной среды ANSIBLE_AZURE_AUTH_SOURCE.

Если задано значение auto (по умолчанию), приоритет определяется в следующем порядке: параметры модуля -> env -> credential_file -> cli.

Если задано значение env, учетные данные будут получены из переменных среды.

Если задано значение credential_file, профиль будет прочитан из ~/.azure/credentials.

Если задано значение cli, учетные данные будут получены из профиля Azure CLI. Для определения идентификатора подписки, если их несколько, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет использоваться подписка Azure CLI по умолчанию.

Если задано значение msi, хост-компьютер должен быть ресурсом Azure с включенным расширением MSI. Для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, можно использовать subscription_id или переменную среды AZURE_SUBSCRIPTION_ID; в противном случае будет выбрана первая подписка.

Параметр msi добавлен в Ansible 2.6.

Варианты:

  • "auto" ← (по умолчанию)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

authentication_certificates

list / элементы=dictionary

Сертификаты аутентификации ресурса шлюза приложений.

data

string

Открытые данные сертификата — файл pfx в кодировке base64.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

autoscale_configuration

dictionary

добавлено в azure.azcollection 1.15.0

Конфигурация автомасштабирования ресурса шлюза приложений.

max_capacity

integer

Верхний предел количества экземпляров шлюза приложений.

min_capacity

integer

Нижний предел количества экземпляров шлюза приложений.

backend_address_pools

list / элементы=dictionary

Список пулов адресов серверной части ресурса шлюза приложений.

backend_addresses

list / элементы=dictionary

Список адресов серверной части.

fqdn

string

Полное доменное имя (FQDN).

ip_address

string

IP-адрес.

name

string

Ресурс, уникальный в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

backend_http_settings_collection

list / элементы=dictionary

Параметры HTTP серверной части ресурса шлюза приложений.

affinity_cookie_name

string

Имя файла cookie, используемого для обеспечения привязки.

authentication_certificates

list / элементы=dictionary

Список ссылок на сертификаты аутентификации шлюза приложений.

Применяется только при включенном параметре cookie_based_affinity; в противном случае игнорируется без уведомления.

id

string

Идентификатор ресурса.

connection_draining

dictionary

добавлено в azure.azcollection 1.15.0

Отключение подключений для ресурса параметров HTTP серверной части.

drain_timeout_in_sec

integer

Количество секунд, в течение которых действует отключение подключений. Допустимые значения — от 1 до 3600 секунд.

enabled

boolean

Включено ли отключение подключений.

Варианты:

  • false
  • true

cookie_based_affinity

string

Привязка на основе файлов cookie.

Варианты:

  • "enabled"
  • "disabled"

host_name

string

Заголовок Host, отправляемый на серверы серверной части.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

path

string

Путь, который следует использовать в качестве префикса для всех запросов http.

Значение null означает, что префикс пути добавляться не будет. Значение по умолчанию — null.

pick_host_name_from_backend_address

boolean

Следует ли брать заголовок Host из имени хоста сервера серверной части. Значение по умолчанию — false.

Варианты:

  • false
  • true

port

integer

Порт назначения на серверной части.

probe

any

Ресурс пробы шлюза приложений.

protocol

string

Протокол, используемый для взаимодействия с серверной частью.

Варианты:

  • "http"
  • "https"

request_timeout

integer

Тайм-аут запроса в секундах.

Шлюз приложений завершит запрос с ошибкой, если ответ не будет получен в течение времени RequestTimeout.

Допустимые значения — от 1 до 86400 секунд.

trusted_root_certificates

list / элементы=any

добавлено в azure.azcollection 1.15.0

Массив ссылок на доверенные корневые сертификаты шлюза приложений.

Можно указать имя доверенного корневого сертификата или полный идентификатор ресурса.

cert_validation_mode

string

добавлено в azure.azcollection 0.0.1

Определяет правила проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав ignore. Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CERT_VALIDATION.

Варианты:

  • "ignore"
  • "validate"

client_id

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi).

Также можно задать с помощью переменной среды AZURE_CLIENT_ID.

cloud_environment

string

добавлено в azure.azcollection 0.0.1

Для облачных сред, отличных от общедоступного облака США, — имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязателен для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной среды AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

disable_instance_discovery

boolean

добавлено в azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Значение true полностью отключает обнаружение экземпляра и проверку центра. Эта функция предназначена для сценариев, в которых невозможно подключиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться, что настроенный хост центра является действительным и заслуживающим доверия.

Задается в профиле файла учетных данных или с помощью переменной среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Варианты:

  • false ← (по умолчанию)
  • true

enable_http2

boolean

добавлено в azure.azcollection 1.15.0

Включен ли HTTP2 для ресурса шлюза приложений.

Варианты:

  • false ← (по умолчанию)
  • true

frontend_ip_configurations

list / элементы=dictionary

IP-адреса интерфейса внешнего доступа ресурса шлюза приложений.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

private_ip_address

string

PrivateIPAddress конфигурации IP-адреса сетевого интерфейса.

private_ip_allocation_method

string

Метод выделения частного IP-адреса.

Варианты:

  • "static"
  • "dynamic"

public_ip_address

any

Ссылка на ресурс PublicIP.

subnet

dictionary

Ссылка на ресурс подсети.

id

string

Полный идентификатор ресурса подсети. Обязателен, если не указаны name и virtual_network_name.

name

string

Имя подсети. Используется только в том случае, если также указано virtual_network_name.

virtual_network_name

string

Имя виртуальной сети. Используется только в том случае, если также указано name.

frontend_ports

list / элементы=dictionary

Список портов внешнего интерфейса ресурса шлюза приложений.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

port

string

Порт внешнего интерфейса.

gateway_ip_configurations

list / элементы=dictionary

Список подсетей, используемых шлюзом приложений.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

subnet

dictionary

Ссылка на ресурс подсети. Подсеть, из которой шлюз приложений получает частный адрес.

id

string

Полный идентификатор ресурса подсети. Обязателен, если не указаны name и virtual_network_name.

name

string

Имя подсети. Используется только в том случае, если также указано virtual_network_name.

virtual_network_name

string

Имя виртуальной сети. Используется только в том случае, если также указано name.

gateway_state

string

Запустить или остановить шлюз приложений. Если указано это значение, обновление шлюза не выполняется.

Варианты:

  • "started"
  • "stopped"

http_listeners

list / elements=dictionary

Список прослушивателей HTTP ресурса шлюза приложений.

frontend_ip_configuration

any

Ресурс конфигурации внешнего IP-адреса шлюза приложений.

frontend_port

any

Ресурс внешнего порта шлюза приложений.

host_name

string

Имя узла прослушивателя http.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

protocol

string

Протокол прослушивателя http.

Варианты:

  • "http"
  • "https"

require_server_name_indication

boolean

Применимо только в том случае, если protocol имеет значение https. Включает SNI для размещения нескольких узлов.

Варианты:

  • false
  • true

ssl_certificate

any

Ресурс сертификата SSL шлюза приложений.

identity

dictionary

Удостоверение объекта

type

string

Тип управляемого удостоверения

Варианты:

  • "SystemAssigned"
  • "UserAssigned"
  • "SystemAssigned, UserAssigned"
  • "None" ← (по умолчанию)

user_assigned_identities

dictionary

Управляемые удостоверения, назначенные пользователем, и их параметры

По умолчанию: {}

append

boolean

Нужно ли добавить список удостоверений к текущим удостоверениям (true) или заменить текущие удостоверения (false)

Варианты:

  • false
  • true ← (по умолчанию)

id

list / elements=string

Список идентификаторов назначенных пользователем удостоверений, связанных с объектом

По умолчанию: []

location

string

Расположение ресурса. Если не задано, по умолчанию используется расположение группы ресурсов.

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string / обязательный

Имя шлюза приложений.

oidc_token

string

добавлено в azure.azcollection 3.17.0

Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC.

Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа предоставляет токен OIDC напрямую.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

добавлено в azure.azcollection 3.17.0

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

Пароль пользователя Active Directory. Используйте его при аутентификации от имени пользователя Active Directory, а не субъекта-службы.

probes

list / elements=dictionary

Проверки, доступные для ресурса шлюза приложений.

host

string

Имя узла, на который отправляется проверка.

interval

integer

Интервал проверки в секундах.

Это временной интервал между двумя последовательными проверками.

Допустимые значения: от 1 до 86400 секунд.

match

dictionary

Критерий для определения успешного ответа проверки.

status_codes

list / elements=string

Допустимые диапазоны кодов успешного состояния.

Диапазон кодов успешного состояния по умолчанию: 200–399.

name

string

Имя проверки, уникальное в пределах шлюза приложений.

path

string

Относительный путь проверки.

Допустимый путь начинается с «/».

Проверка отправляется по адресу <Protocol>://<host>:<port><path>.

pick_host_name_from_backend_http_settings

boolean

Следует ли брать заголовок узла из имени узла в параметрах HTTP серверной части. Значение по умолчанию — false.

Варианты:

  • false ← (по умолчанию)
  • true

port

integer

Пользовательский порт, используемый для проверки серверов серверной части.

Допустимый диапазон значений: от 1 до 65535.

Если значение не задано, используется порт из параметров HTTP.

Это свойство допустимо только для Standard_v2 и WAF_v2.

protocol

string

Протокол, используемый для проверки.

Варианты:

  • "http"
  • "https"

timeout

integer

Время ожидания проверки в секундах.

Проверка считается неудачной, если за это время не получен допустимый ответ.

Допустимые значения: от 1 до 86400 секунд.

unhealthy_threshold

integer

Количество повторных попыток проверки.

Сервер серверной части считается недоступным, когда количество последовательных неудачных проверок достигает значения UnhealthyThreshold.

Допустимые значения: от 1 до 20.

profile

string

Профиль безопасности из файла ~/.azure/credentials.

redirect_configurations

list / elements=dictionary

Конфигурации перенаправления ресурса шлюза приложений.

include_path

boolean

Включать путь в URL-адрес перенаправления.

Варианты:

  • false
  • true

include_query_string

boolean

Включать строку запроса в URL-адрес перенаправления.

Варианты:

  • false
  • true

name

string

Имя ресурса, уникальное в пределах группы ресурсов.

path_rules

list / elements=dictionary

добавлено в azure.azcollection 1.10.0

Список правил URL-путей в правиле c(path_based_routing), к которому привязано перенаправление.

name

string

Имя правила URL.

path_map_name

string

Имя карты URL-путей.

redirect_type

string

Тип перенаправления.

Варианты:

  • "permanent"
  • "found"
  • "see_other"
  • "temporary"

request_routing_rules

list / elements=string

добавлено в azure.azcollection 1.10.0

Список имен правил маршрутизации запросов c(basic) в шлюзе приложений, к которым привязано перенаправление.

target_listener

string

Ссылка на прослушиватель, на который следует перенаправить запрос.

url_path_maps

list / elements=string

добавлено в azure.azcollection 1.10.0

Список имен карт URL-путей (правил c(path_based_routing)) в шлюзе приложений, к которым привязано перенаправление.

request_routing_rules

list / elements=dictionary

Список правил маршрутизации запросов ресурса шлюза приложений.

backend_address_pool

any

Ресурс пула адресов серверной части шлюза приложений. Не используется, если rule_type имеет значение path_based_routing.

backend_http_settings

any

Ресурс параметров HTTP серверной части http шлюза приложений.

http_listener

any

Ресурс HTTP-прослушивателя шлюза приложений.

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

priority

integer / обязательный

Приоритет правила маршрутизации запросов.

redirect_configuration

any

Ресурс конфигурации перенаправления шлюза приложений.

rewrite_rule_set

any

добавлено в azure.azcollection 1.11.0

Набор правил переписывания для карты путей.

Можно указать имя набора правил переписывания или полный идентификатор ресурса.

rule_type

string

Тип правила.

Варианты:

  • "basic"
  • "path_based_routing"

url_path_map

any

Ресурс карты URL-путей шлюза приложений. Обязателен, если rule_type имеет значение path_based_routing.

resource_group

string / обязательный

Имя группы ресурсов.

rewrite_rule_sets

list / elements=dictionary

добавлено в azure.azcollection 1.11.0

Список конфигураций перезаписи для ресурса шлюза приложений.

name

string / обязательный

Имя набора правил перезаписи.

rewrite_rules

list / elements=dictionary / обязательный

Список правил перезаписи.

action_set

dictionary / обязательный

Набор действий, выполняемых в рамках правила перезаписи.

request_header_configurations

list / elements=dictionary

Список действий, выполняемых с заголовками запроса.

По умолчанию: []

header_name

string / обязательный

Имя заголовка.

header_value

string

Значение заголовка.

Не задавайте параметр, чтобы удалить заголовок.

По умолчанию: ""

response_header_configurations

list / elements=dictionary

Список действий, выполняемых с заголовками ответа.

По умолчанию: []

header_name

string / обязательный

Имя заголовка.

header_value

string

Значение заголовка.

Не задавайте параметр, чтобы удалить заголовок.

По умолчанию: ""

url_configuration

dictionary

Действие, выполняемое с URL-адресом.

modified_path

string

Значение, на которое будет перезаписан путь URL-адреса.

Не задавайте параметр, чтобы сохранить исходный путь URL-адреса.

modified_query_string

string

Значение, на которое будет перезаписана строка запроса URL-адреса.

Не задавайте параметр, чтобы сохранить исходную строку запроса URL-адреса.

reroute

boolean

Если задано значение true, карта путей, указанная в правилах маршрутизации запросов на основе путей, будет вычислена повторно с использованием измененного пути.

Варианты:

  • false ← (по умолчанию)
  • true

conditions

list / elements=dictionary

Условия, на основании которых будет оцениваться выполнение набора действий.

По умолчанию: []

ignore_case

boolean

Если задать этому параметру значение true, при сопоставлении с шаблоном будет учитываться регистр.

Варианты:

  • false
  • true ← (по умолчанию)

negate

boolean

Если задать этому параметру значение true, будет проверяться отрицание условия, заданного пользователем.

Варианты:

  • false ← (по умолчанию)
  • true

pattern

string / обязательный

Шаблон — фиксированная строка или регулярное выражение, — по которому определяется истинность условия.

variable

string / обязательный

Параметр условия.

name

string / обязательный

Имя правила перезаписи.

rule_sequence

integer / обязательный

Порядковый номер правила, определяющий порядок выполнения в наборе.

secret

string

Секрет клиента Azure. Используется при аутентификации с помощью субъекта-службы.

sku

dictionary

SKU ресурса шлюза приложений.

capacity

integer

Емкость шлюза приложений (количество экземпляров).

name

string

Имя SKU шлюза приложений.

Варианты:

  • "standard_small"
  • "standard_medium"
  • "standard_large"
  • "standard_v2"
  • "waf_medium"
  • "waf_large"
  • "waf_v2"

tier

string

Уровень шлюза приложений.

Варианты:

  • "standard"
  • "standard_v2"
  • "waf"
  • "waf_v2"

ssl_certificates

list / elements=dictionary

SSL-сертификаты ресурса шлюза приложений.

data

string

Сертификат PFX в кодировке Base64.

Применимо только к запросу PUT.

key_vault_secret_id

string

Идентификатор секрета объекта «Secret» или «Certificate» (незашифрованный файл PFX в кодировке Base64), хранящегося в KeyVault.

При использовании этого параметра шлюзу приложений необходимо назначенное пользователем управляемое удостоверение с доступом к Key Vault.

Не может использоваться одновременно с data и password.

По умолчанию: ""

name

string

Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.

password

string

Пароль для файла PFX, указанного в data.

Применимо только к запросу PUT.

ssl_policy

dictionary

Политика SSL ресурса шлюза приложений.

cipher_suites

list / elements=string

Список наборов шифров SSL, которые будут включены для шлюза приложений в указанном порядке.

Варианты:

  • "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"

disabled_ssl_protocols

list / elements=string

Список протоколов SSL, которые будут отключены на шлюзе приложений.

Варианты:

  • "tls_v1_0"
  • "tls_v1_1"
  • "tls_v1_2"

min_protocol_version

string

Минимальная версия протокола SSL, поддерживаемая шлюзом приложений.

Варианты:

  • "tls_v1_0"
  • "tls_v1_1"
  • "tls_v1_2"

policy_name

string

Имя политики Ssl predefined.

Варианты:

  • "ssl_policy20150501"
  • "ssl_policy20170401"
  • "ssl_policy20170401_s"

policy_type

string

Тип политики SSL.

Варианты:

  • "predefined"
  • "custom"

state

string

Задайте требуемое состояние шлюза приложений. Используйте present для создания или обновления и absent для удаления.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)

subscription_id

string

Идентификатор вашей подписки Azure.

tags

dictionary

Словарь пар «строка:строка», назначаемых объекту в качестве метаданных.

Теги метаданных объекта будут обновлены с учетом всех предоставленных значений.

Чтобы удалить теги, задайте для параметра append_tags значение false.

В настоящее время в тегах зон Azure DNS и служб Traffic Manager также нельзя использовать пробелы.

Azure Front Door не поддерживает использование

Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов.

tenant

string

Идентификатор клиента Azure. Используется при аутентификации с помощью субъекта-службы.

thumbprint

string

добавлено в azure.azcollection 1.14.0

Отпечаток закрытого ключа, указанного в x509_certificate_path.

Используется при аутентификации с помощью субъекта-службы.

Обязателен, если задан x509_certificate_path.

trusted_root_certificates

list / elements=dictionary

добавлено в azure.azcollection 1.15.0

Доверенные корневые сертификаты ресурса шлюза приложений.

data

string

Открытые данные сертификата.

key_vault_secret_id

string

Идентификатор секрета объекта «Secret» или «Certificate» (незашифрованный файл PFX в кодировке Base64), хранящегося в KeyVault.

По умолчанию: ""

name

string

Имя доверенного корневого сертификата, уникальное в пределах шлюза приложений.

url_path_maps

list / elements=dictionary

Список карт путей URL-адресов ресурса шлюза приложений.

default_backend_address_pool

string

Ресурс пула адресов серверной части шлюза приложений, используемый, если ни один путь не совпадает.

Не может использоваться одновременно с default_redirect_configuration.

default_backend_http_settings

string

Ресурс параметров HTTP серверной части шлюза приложений; используется с default_backend_address_pool.

default_redirect_configuration

string

добавлено в azure.azcollection 1.10.0

Имя ресурса конфигурации перенаправления шлюза приложений, используемого, если ни один путь не совпадает.

Не может использоваться одновременно с default_backend_address_pool.

default_rewrite_rule_set

string

добавлено в azure.azcollection 1.11.0

Набор правил перезаписи по умолчанию для карты путей.

Можно указать имя набора правил перезаписи или полный идентификатор ресурса.

name

string

Имя ресурса, уникальное в пределах шлюза приложений. Это имя можно использовать для доступа к ресурсу.

path_rules

list / elements=dictionary

Список правил для путей URL-адресов.

backend_address_pool

string

Ресурс пула адресов серверной части шлюза приложений, который будет использоваться при совпадении пути.

Несовместимо с redirect_configuration.

backend_http_settings

string

Ресурс параметров HTTP серверной части шлюза приложений; используется для backend_address_pool пути.

name

string

Имя ресурса, уникальное в пределах карты путей.

paths

list / elements=string

Список путей.

redirect_configuration

string

добавлено в azure.azcollection 1.10.0

Имя ресурса конфигурации перенаправления шлюза приложений, который будет использоваться при совпадении пути.

Несовместимо с backend_address_pool.

rewrite_rule_set

string

добавлено в azure.azcollection 1.11.0

Набор правил перезаписи для карты путей.

Может быть именем набора правил перезаписи или полным идентификатором ресурса.

web_application_firewall_configuration

dictionary

добавлено в azure.azcollection 1.15.0

Конфигурация веб-брандмауэра приложения для ресурса шлюза приложений.

Обратите внимание: начиная с версии 2.8.0 вместо устаревших параметров требуется firewall_policy. См. https://github.com/ansible-collections/azure/pull/1697.

disabled_rule_groups

list / elements=dictionary

(Устарело) Отключенные группы правил.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

По умолчанию: []

rule_group_name

string

Имя группы правил, которую необходимо отключить.

rules

list / elements=integer

Список правил, которые будут отключены. Если значение равно null, будут отключены все правила группы.

По умолчанию: []

enabled

boolean

(Устарело) Включен ли веб-брандмауэр приложения.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

Варианты:

  • false
  • true

exclusions

list / elements=dictionary

(Устарело) Список исключений.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

По умолчанию: []

match_variable

string

Переменная, которую следует исключить.

selector

string

Если match_variable является коллекцией, оператор, указывающий, к каким элементам коллекции применяется это исключение.

selector_match_operator

string

Если match_variable является коллекцией, операция над селектором, указывающая, к каким элементам коллекции применяется это исключение.

file_upload_limit_in_mb

integer

(Устарело) Максимальный размер загружаемого файла в МБ для WAF.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

firewall_mode

string

(Устарело) Режим веб-брандмауэра приложения.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

Варианты:

  • "Detection"
  • "Prevention"

firewall_policy

dictionary

добавлено в azure.azcollection 2.8.0

Политика веб-брандмауэра приложения для шлюза приложений.

force_association

boolean

Если значение равно true, политика брандмауэра связывается со шлюзом приложений независимо от того, отличается ли политика от конфигурации WAF.

Варианты:

  • false
  • true ← (по умолчанию)

id

string

Идентификатор ресурса политики брандмауэра. Обязателен, если параметр name не указан.

name

string

Имя политики брандмауэра (в той же подписке и регионе). Используется, если параметр id не указан.

max_request_body_size

integer

(Устарело) Максимальный размер тела запроса для WAF.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

max_request_body_size_in_kb

integer

(Устарело) Максимальный размер тела запроса в КБ для WAF.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

request_body_check

boolean

(Устарело) Разрешена ли WAF проверка тела запроса.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

Варианты:

  • false
  • true

rule_set_type

string

(Устарело) Тип набора правил веб-брандмауэра приложения.

Возможные значения: ‘OWASP’.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

Варианты:

  • "OWASP"

rule_set_version

string

(Устарело) Версия типа набора правил.

Этот параметр устарел и будет удален в одной из следующих версий. Вместо него используйте firewall_policy.

x509_certificate_path

path

добавлено в azure.azcollection 1.14.0

Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы.

Закрытый ключ должен быть добавлен после сертификата.

Используйте при аутентификации с помощью субъекта-службы.

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или выполнить вход перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации с помощью субъекта-службы передайте 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
        connection_draining:
          drain_timeout_in_sec: 60
          enabled: true
        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
        priority: 100

- name: Create instance of Application Gateway with custom trusted root certificate
  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
    trusted_root_certificates:
      - name: "root_cert"
        key_vault_secret_id: "https://kv/secret"
    ssl_certificates:
      - name: "ssl_cert"
        key_vault_secret_id: "https://kv/secrets/ssl-cert"
    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
        connection_draining:
          drain_timeout_in_sec: 60
          enabled: true
        name: sample_appgateway_http_settings
        trusted_root_certificates:
          - "root_cert"
    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
        priority: 100
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

- name: Create instance of Application Gateway by looking up virtual network and subnet
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myAppGateway
    sku:
      name: standard_small
      tier: standard
      capacity: 2
    gateway_ip_configurations:
      - subnet:
          name: default
          virtual_network_name: my-vnet
        name: app_gateway_ip_config
    frontend_ip_configurations:
      - subnet:
          name: default
          virtual_network_name: my-vnet
        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
        priority: 100
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

- name: Create instance of Application Gateway with path based rules
  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: path_based_routing
        priority: 100
        http_listener: sample_http_listener
        name: rule1
        url_path_map: path_mappings
    url_path_maps:
      - name: path_mappings
        default_backend_address_pool: test_backend_address_pool
        default_backend_http_settings: sample_appgateway_http_settings
        path_rules:
          - name: path_rules
            backend_address_pool: test_backend_address_pool
            backend_http_settings: sample_appgateway_http_settings
            paths:
              - "/abc"
              - "/123/*"

- name: Create instance of Application Gateway with complex routing and redirect rules
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myComplexAppGateway
    sku:
      name: standard_small
      tier: standard
      capacity: 2
    ssl_policy:
      policy_type: "predefined"
      policy_name: "ssl_policy20170401_s"
    ssl_certificates:
      - name: ssl_cert
        password: "{{ password }}"
        data: "{{ lookup('file', 'certfile') }}"
    gateway_ip_configurations:
      - subnet:
          id: "{{ subnet_output.state.id }}"
          name: app_gateway_ip_config
    frontend_ip_configurations:
      - subnet:
          id: "{{ subnet_output.state.id }}"
          name: sample_gateway_frontend_ip_config
    frontend_ports:
      - name: "inbound-http"
        port: 80
      - name: "inbound-https"
        port: 443
    backend_address_pools:
      - name: test_backend_address_pool1
        backend_addresses:
          - ip_address: 10.0.0.1
      - name: test_backend_address_pool2
        backend_addresses:
          - ip_address: 10.0.0.2
    backend_http_settings_collection:
      - name: "http-profile1"
        port: 443
        protocol: https
        pick_host_name_from_backend_address: true
        probe: "http-probe1"
        cookie_based_affinity: "Disabled"
      - name: "http-profile2"
        port: 8080
        protocol: http
        pick_host_name_from_backend_address: true
        probe: "http-probe2"
        cookie_based_affinity: "Disabled"
    http_listeners:
      - name: "inbound-http"
        protocol: "http"
        frontend_ip_configuration: "sample_gateway_frontend_ip_config"
        frontend_port: "inbound-http"
      - name: "inbound-traffic1"
        protocol: "https"
        frontend_ip_configuration: "sample_gateway_frontend_ip_config"
        frontend_port: "inbound-https"
        host_name: "traffic1.example.com"
        require_server_name_indication: true
        ssl_certificate: "ssl_cert"
      - name: "inbound-traffic2"
        protocol: "https"
        frontend_ip_configuration: "sample_gateway_frontend_ip_config"
        frontend_port: "inbound-https"
        host_name: "traffic2.example.com"
        require_server_name_indication: true
        ssl_certificate: "ssl_cert"
    url_path_maps:
      - name: "path_mappings"
        default_redirect_configuration: "redirect-traffic1"
        path_rules:
          - name: "path_rules"
            backend_address_pool: "test_backend_address_pool1"
            backend_http_settings: "http-profile1"
            paths:
              - "/abc"
              - "/123/*"
    request_routing_rules:
      - name: "app-routing1"
        rule_type: "basic"
        priority: 100
        http_listener: "inbound-traffic1"
        backend_address_pool: "test_backend_address_pool2"
        backend_http_settings: "http-profile1"
      - name: "app-routing2"
        rule_type: "path_based_routing"
        priority: 101
        http_listener: "inbound-traffic2"
        url_path_map: "path_mappings"
      - name: "redirect-routing"
        rule_type: "basic"
        priority: 102
        http_listener: "inbound-http"
        redirect_configuration: "redirect-http"
    probes:
      - name: "http-probe1"
        interval: 30
        path: "/abc"
        protocol: "https"
        pick_host_name_from_backend_http_settings: true
        timeout: 30
        unhealthy_threshold: 2
      - name: "http-probe2"
        interval: 30
        path: "/xyz"
        protocol: "http"
        pick_host_name_from_backend_http_settings: true
        timeout: 30
        unhealthy_threshold: 2
    redirect_configurations:
      - name: "redirect-http"
        redirect_type: "permanent"
        target_listener: "inbound-traffic1"
        include_path: true
        include_query_string: true
        request_routing_rules:
          - "redirect-routing"
      - name: "redirect-traffic1"
        redirect_type: "found"
        target_listener: "inbound-traffic1"
        include_path: true
        include_query_string: true
        url_path_maps:
          - "path_mappings"

- name: Create v2 instance of Application Gateway with rewrite rules
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myV2AppGateway
    sku:
      name: standard_v2
      tier: standard_v2
      capacity: 2
    ssl_policy:
      policy_type: predefined
      policy_name: ssl_policy20170401_s
    ssl_certificates:
      - name: ssl_cert
        password: "{{ password }}"
        data: "{{ lookup('file', ssl_cert) }}"
    gateway_ip_configurations:
      - subnet:
          id: "{{ subnet_output.state.id }}"
        name: app_gateway_ip_config
    frontend_ip_configurations:
      - name: "public-inbound-ip"
        public_ip_address: my-appgw-pip
    frontend_ports:
      - name: "inbound-http"
        port: 80
      - name: "inbound-https"
        port: 443
    backend_address_pools:
      - name: test_backend_address_pool1
        backend_addresses:
          - ip_address: 10.0.0.1
      - name: test_backend_address_pool2
        backend_addresses:
          - ip_address: 10.0.0.2
    backend_http_settings_collection:
      - name: "http-profile1"
        port: 443
        protocol: https
        pick_host_name_from_backend_address: true
        probe: "http-probe1"
        cookie_based_affinity: "Disabled"
      - name: "http-profile2"
        port: 8080
        protocol: http
        pick_host_name_from_backend_address: true
        probe: "http-probe2"
        cookie_based_affinity: "Disabled"
    http_listeners:
      - name: "inbound-http"
        protocol: "http"
        frontend_ip_configuration: "public-inbound-ip"
        frontend_port: "inbound-http"
      - name: "inbound-traffic1"
        protocol: "https"
        frontend_ip_configuration: "public-inbound-ip"
        frontend_port: "inbound-https"
        host_name: "traffic1.example.com"
        require_server_name_indication: true
        ssl_certificate: "ssl_cert"
      - name: "inbound-traffic2"
        protocol: "https"
        frontend_ip_configuration: "public-inbound-ip"
        frontend_port: "inbound-https"
        host_name: "traffic2.example.com"
        require_server_name_indication: true
        ssl_certificate: "ssl_cert"
    url_path_maps:
      - name: "path_mappings"
        default_redirect_configuration: "redirect-traffic1"
        default_rewrite_rule_set: "configure-headers"
        path_rules:
          - name: "path_rules"
            backend_address_pool: "test_backend_address_pool1"
            backend_http_settings: "http-profile1"
            paths:
              - "/abc"
              - "/123/*"
    request_routing_rules:
      - name: "app-routing1"
        rule_type: "basic"
        priority: 100
        http_listener: "inbound-traffic1"
        backend_address_pool: "test_backend_address_pool2"
        backend_http_settings: "http-profile1"
        rewrite_rule_set: "configure-headers"
      - name: "app-routing2"
        rule_type: "path_based_routing"
        priority: 101
        http_listener: "inbound-traffic2"
        url_path_map: "path_mappings"
      - name: "redirect-routing"
        rule_type: "basic"
        priority: 102
        http_listener: "inbound-http"
        redirect_configuration: "redirect-http"
    rewrite_rule_sets:
      - name: "configure-headers"
        rewrite_rules:
          - name: "add-security-response-header"
            rule_sequence: 1
            action_set:
              response_header_configurations:
                - header_name: "Strict-Transport-Security"
                  header_value: "max-age=31536000"
          - name: "remove-backend-response-headers"
            rule_sequence: 2
            action_set:
              response_header_configurations:
                - header_name: "Server"
                - header_name: "X-Powered-By"
          - name: "set-custom-header-condition"
            rule_sequence: 3
            conditions:
              - variable: "var_client_ip"
                pattern: "1.1.1.1"
              - variable: "http_req_Authorization"
                pattern: "12345"
                ignore_case: false
            action_set:
              request_header_configurations:
                - header_name: "Foo"
                  header_value: "Bar"
    probes:
      - name: "http-probe1"
        interval: 30
        path: "/abc"
        protocol: "https"
        pick_host_name_from_backend_http_settings: true
        timeout: 30
        unhealthy_threshold: 2
      - name: "http-probe2"
        interval: 30
        path: "/xyz"
        protocol: "http"
        pick_host_name_from_backend_http_settings: true
        timeout: 30
        unhealthy_threshold: 2
    redirect_configurations:
      - name: "redirect-http"
        redirect_type: "permanent"
        target_listener: "inbound-traffic1"
        include_path: true
        include_query_string: true
        request_routing_rules:
          - "redirect-routing"
      - name: "redirect-traffic1"
        redirect_type: "found"
        target_listener: "inbound-traffic1"
        include_path: true
        include_query_string: true
        url_path_maps:
          - "path_mappings"

- name: Create instance of Application Gateway with autoscale configuration
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myAppGateway
    sku:
      name: standard_small
      tier: standard
    autoscale_configuration:
      max_capacity: 2
      min_capacity: 1
    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
        priority: 100
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1

- name: Create instance of Application Gateway waf_v2 with waf configuration
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myAppGateway
    sku:
      name: waf_v2
      tier: waf_v2
      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
        priority: 100
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: sample_http_listener
        name: rule1
    web_application_firewall_configuration:
      - enabled: true
        firewall_mode: Detection
        rule_set_type: OWASP
        rule_set_version: 3.0
        request_body_check: true
        max_request_body_size_in_kb: 128
        file_upload_limit_in_mb: 100

- name: Create application gateway with multi parameters
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myappgateway
    sku:
      name: standard_v2
      tier: standard_v2
      capacity: 2
    gateway_ip_configurations:
      - subnet:
          id: "{{ subnet_id }}"
        name: app_gateway_ip_config
    frontend_ip_configurations:
      - name: sample_gateway_frontend_ip_config
        public_ip_address: "pip{{ rpfx }}"
    frontend_ports:
      - port: 80
        name: http_frontend_port
    backend_address_pools:
      - name: test_backend_address_pool  # empty pool which will receive attachment to NIC.
    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: http_frontend_port
        protocol: http
        name: http_listener
    probes:
      - name: testprobes01
        protocol: http
        path: '/'
        timeout: 30
        host: testazure
        interval: 90
        port: 80
        match:
          status_codes:
            - 200
    request_routing_rules:
      - rule_type: basic
        priority: 100
        backend_address_pool: test_backend_address_pool
        backend_http_settings: sample_appgateway_http_settings
        http_listener: http_listener
        name: rule1

- name: Stop an Application Gateway instance
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myAppGateway
    gateway_state: stopped

- name: Start an Application Gateway instance
  azure_rm_appgateway:
    resource_group: myResourceGroup
    name: myAppGateway
    gateway_state: started

Возвращаемые значения

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

Ключ

Описание

id

string

Идентификатор ресурса шлюза приложений.

Возвращается: всегда

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/myAppGw"

location

string

Расположение шлюза приложений.

Возвращается: всегда

Пример: "centralus"

name

string

Имя шлюза приложений.

Возвращается: всегда

Пример: "myAppGw"

operational_state

string

Рабочее состояние шлюза приложений.

Возвращается: всегда

Пример: "Running"

provisioning_state

string

Состояние подготовки шлюза приложений.

Возвращается: всегда

Пример: "Succeeded"

resource_group

string

Имя группы ресурсов.

Возвращается: всегда

Пример: "myResourceGroup"

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_appgateway_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API