Spec-Zone.ru › Ansible 2.10

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

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.3.1).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_appgateway.

Новое в версии 0.1.2: из azure.azcollection

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

Обзор

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

Требования

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

  • python >= 2.7
  • azure >= 2.0.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
ad_user
строка
Имя пользователя Active Directory. Используется при аутентификации пользователем Active Directory, а не служебным принципалом.
adfs_authority_url
строка
добавлен в 0.0.1 azure.azcollection
URL авторизации Azure AD. Используется при аутентификации с использованием имени пользователя/пароля и собственной службой ADFS.
api_profile
строка
добавлен в 0.0.1 azure.azcollection
Значение по умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags
логическое
    Варианты:
  • no
  • да ←
Используется для управления тем, является ли поле тегов стандартным или просто добавляется к существующим тегам.
В случае стандартного тега любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Управляет источником учетных данных для аутентификации.
Также может быть задан через переменную среды ANSIBLE_AZURE_AUTH_SOURCE.
Когда установлено auto (значение по умолчанию), приоритет имеет параметры модуля -> env -> credential_file -> cli.
Когда установлено env, учетные данные будут считываться из переменных среды.
Когда установлено credential_file, профиль будет считан из ~/.azure/credentials.
При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут быть использованы для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az cli.
При значении 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 для аффинита.
authentication_certificates
строка
Список ссылок на сертификаты аутентификации шлюза приложений.
Применима только если cookie_based_affinity включён, иначе игнорируется.
id
строка
Идентификатор ресурса.
cookie_based_affinity
строка
    Варианты:
  • enabled
  • disabled
Аффинитет на основе 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
строка
добавлен в 0.0.1 azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить эту функцию, передав ignore. Также может быть задано в профиле файла учетных данных или переменной среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор Azure-клиента. Используется при аутентификации служебным принципалом.
cloud_environment
строка
добавлен в 0.0.1 azure.azcollection
Значение по умолчанию:
"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
строка
    Варианты:
  • static
  • dynamic
Метод выделения частного IP-адреса.
public_ip_address
строка
Ссылка на ресурс PublicIP.
subnet
строка
Ссылка на ресурс подсети.
frontend_ports
строка
Список портов фронтального уровня ресурса шлюза приложений.
name
строка
Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
port
строка
Порт фронтального уровня.
gateway_ip_configurations
строка
Список подсетей, используемых шлюзом приложений.
name
строка
Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу.
subnet
строка
Ссылка на ресурс подсети. Подсеть, из которой шлюз приложений получает свой частный адрес.
http_listeners
string
Список HTTP-слушателей ресурса шлюза приложений.
frontend_ip_configuration
string
Ресурс конфигурации IP-адреса переднего плана шлюза приложений.
frontend_port
string
Ресурс порта переднего плана шлюза приложений.
host_name
string
Имя хоста http слушателя.
name
string
Имя ресурса, уникального в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
protocol
string
    Choices:
  • http
  • https
Протокол http слушателя.
require_server_name_indication
string
Применимо только если protocol равен https. Включает SNI для многохостинга.
ssl_certificate
string
Ресурс сертификата SSL шлюза приложений.
location
string
Расположение ресурса. Если не указано, используется расположение из группы ресурсов по умолчанию.
name
string / required
Имя шлюза приложений.
password
string
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
probes
string
Звуковые сигналы, доступные для ресурса шлюза приложений.
host
string
Имя хоста, к которому отправляется звуковой сигнал.
interval
string
Интервал зондирования в секундах.
Это интервал времени между двумя последовательными зондированиями.
Допустимые значения от 1 секунды до 86400 секунд.
name
string
Имя звукового сигнала, уникального в пределах шлюза приложений.
path
string
Относительный путь звукового сигнала.
Действительный путь начинается с '/'.
Звуковой сигнал отправляется по адресу <Протокол>://<хост>:<порт><путь>.
protocol
string
    Choices:
  • http
  • https
Протокол, используемый для звукового сигнала.
timeout
string
Тайм-аут зондирования в секундах.
Звуковой сигнал отмечается как неудачный, если валидный ответ не получен в течение этого интервала тайм-аута.
Допустимые значения от 1 секунды до 86400 секунд.
unhealthy_threshold
string
Количество попыток повторного зондирования звукового сигнала.
Задний сервер помечается как неисправный после достижения количества последовательных неудачных зондирований, указанного в UnhealthyThreshold.
Допустимые значения от 1 секунды до 20.
profile
string
Профиль безопасности, найденный в файле ~/.azure/credentials.
redirect_configurations
string
Конфигурации перенаправления ресурса шлюза приложений.
include_path
string
Включить путь в перенаправленный URL.
include_query_string
string
Включить строку запроса в перенаправленный URL.
name
string
Имя ресурса, уникального в группе ресурсов.
redirect_type
string
    Choices:
  • permanent
  • found
  • see_other
  • temporary
Тип перенаправления.
target_listener
string
Ссылка на слушатель для перенаправления запроса.
request_routing_rules
string
Список правил маршрутизации запросов ресурса шлюза приложений.
backend_address_pool
string
Ресурс пула адресов бэкенда шлюза приложений.
backend_http_settings
string
Ресурс настроек бэкенда http шлюза приложений.
http_listener
string
Ресурс слушателя HTTP шлюза приложений.
name
string
Имя ресурса, уникального в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
redirect_configuration
string
Ресурс конфигурации перенаправления шлюза приложений.
rule_type
string
    Choices:
  • basic
  • path_based_routing
Тип правила.
resource_group
string / required
Имя группы ресурсов.
secret
string
Секрет клиента Azure. Используется при аутентификации с принципалом службы.
sku
string
SKU ресурса шлюза приложений.
capacity
string
Ёмкость (количество экземпляров) шлюза приложений.
name
string
    Choices:
  • standard_small
  • standard_medium
  • standard_large
  • standard_v2
  • waf_medium
  • waf_large
  • waf_v2
Имя SKU шлюза приложений.
tier
string
    Choices:
  • standard
  • standard_v2
  • waf
  • waf_v2
Уровень шлюза приложений.
ssl_certificates
string
Сертификаты SSL ресурса шлюза приложений.
data
string
Сертификат pfx в кодировке Base-64.
Применимо только в запросе PUT.
name
string
Имя ресурса, уникального в группе ресурсов. Это имя может быть использовано для доступа к ресурсу.
password
string
Пароль для файла pfx, указанного в data.
Применимо только в запросе PUT.
ssl_policy
string
Политика SSL ресурса шлюза приложений.
cipher_suites
string
    Choices:
  • 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
string
    Choices:
  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Список SSL протоколов, которые необходимо отключить в шлюзе приложений.
min_protocol_version
string
    Choices:
  • tls_v1_0
  • tls_v1_1
  • tls_v1_2
Минимальная версия протокола Ssl, поддерживаемая шлюзом приложений.
policy_name
string
    Choices:
  • ssl_policy20150501
  • ssl_policy20170401
  • ssl_policy20170401_s
Имя политики Ssl predefined.
policy_type
string
    Choices:
  • predefined
  • custom
Тип политики SSL.
state
string
    Choices:
  • absent
  • present ←
Указывает состояние общедоступного IP-адреса. Используйте present, чтобы создать или обновить, и absent, чтобы удалить.
subscription_id
string
Ваш идентификатор подписки Azure.
tags
dictionary
Словарь пар "строка:строка", назначаемых в качестве метаданных объекту.
Метаданные теги объекта будут обновлены любыми предоставленными значениями.
Для удаления тегов установите параметр append_tags в false.
tenant
string
Идентификатор клиента 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
string
всегда
Идентификатор ресурса.

Пример:
id


Авторы

  • 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.10/collections/azure/azcollection/azure_rm_appgateway_module.html

Spec-Zone.ru

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