Модуль azure.azcollection.azure_rm_loadbalancer – Управление балансировщиками нагрузки Azure

ad_user

строка

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

adfs_authority_url

строка

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

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

api_profile

строка

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

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

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

append_tags

логическое значение

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

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

Варианты:

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

auth_source

строка

добавлено в 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 могут использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка az cli.

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

msi было добавлено в Ansible 2.6.

Варианты:

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

backend_address_pools

список / элементы=словарь

Список пулов адресов бэкенда.

name

строка / обязательно

Имя пула адресов бэкенда.

cert_validation_mode

строка

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

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

Варианты:

• "ignore"
• "validate"

client_id

строка

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

Также может быть задано через переменную окружения AZURE_CLIENT_ID.

cloud_environment

строка

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

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

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

disable_instance_discovery

логическое значение

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

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

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

Варианты:

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

frontend_ip_configurations

список / элементы=словарь

Список передних IP-адресов, которые будут использоваться.

name

строка / обязательно

Имя конфигурации переднего IP-адреса.

private_ip_address

строка

Ссылка на ресурс общедоступного IP.

private_ip_allocation_method

string

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

Варианты:

• "Static"
• "Dynamic"

public_ip_address

string

Имя существующего объекта публичного IP-адреса в текущей группе ресурсов для ассоциации с группой безопасности.

subnet

string

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

Должен быть ID ресурса существующей подсети.

zones

list / elements=string

Список зон доступности, указывающих, из какой зоны должен быть выделен IP-адрес для ресурса.

Это должно быть указано sku=Standard и subnet при установке зон.

inbound_nat_pools

list / elements=dictionary

Определяет диапазон внешних портов для входящего NAT на один порт back-end на сетевых интерфейсах, связанных с балансировщиком нагрузки.

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

Определение пула входящего NAT на вашем балансировщике нагрузки взаимоисключает определение правил входящего NAT.

Пулы входящего NAT ссылаются из наборов масштабирования виртуальных машин.

Сетевые интерфейсы, связанные с отдельными виртуальными машинами, не могут ссылаться на пул входящего NAT.

Они должны ссылаться на отдельные правила входящего NAT.

backend_port

integer / required

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

Допустимые значения находятся в диапазоне от 1 до 65535.

frontend_ip_configuration_name

string / required

Ссылка на внешние IP-адреса.

frontend_port_range_end

integer / required

Последний порт в диапазоне внешних портов, которые будут использоваться для предоставления входящего NAT для сетевых интерфейсов, связанных с балансировщиком нагрузки.

Допустимые значения находятся в диапазоне от 1 до 65535.

frontend_port_range_start

integer / required

Первый порт в диапазоне внешних портов, которые будут использоваться для предоставления входящего NAT для сетевых интерфейсов, связанных с балансировщиком нагрузки.

Допустимые значения находятся в диапазоне от 1 до 65534.

name

string / required

Имя пула входящего NAT.

protocol

string

IP-протокол для пула NAT.

Варианты:

• "Tcp"
• "Udp"
• "All"

inbound_nat_rules

list / elements=dictionary

Коллекция правил входящего NAT, используемых балансировщиком нагрузки.

Определение правил входящего NAT на вашем балансировщике нагрузки взаимоисключает определение пула входящего NAT.

Пулы входящего NAT ссылаются из наборов масштабирования виртуальных машин.

Сетевые интерфейсы, связанные с отдельными виртуальными машинами, не могут ссылаться на пул входящего NAT.

Они должны ссылаться на отдельные правила входящего NAT.

backend_port

integer / required

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

Допустимые значения находятся в диапазоне от 0 до 65535.

Обратите внимание, что значение 0 включает «Любой порт».

enable_floating_ip

boolean

Настраивает конечную точку виртуальной машины для функции плавающего IP-адреса, необходимую для настройки группы доступности SQL AlwaysOn.

Этот параметр необходим при использовании групп доступности SQL AlwaysOn в SQL Server.

Этот параметр нельзя изменить после создания конечной точки.

Варианты:

• false
• true

enable_tcp_reset

boolean

Получать двунаправленный TCP Reset при истечении времени ожидания бездействия TCP-потока или неожиданном завершении соединения.

Этот элемент используется только когда protocol=Tcp.

Варианты:

• false
• true

frontend_ip_configuration

string / required

Ссылка на внешние IP-адреса.

frontend_port

integer / required

Порт для внешней конечной точки.

Номера внешних портов должны быть уникальными для всех правил в пределах балансировщика нагрузки.

Допустимые значения находятся в диапазоне от 0 до 65534.

Обратите внимание, что значение 0 включает «Любой порт».

idle_timeout

integer

Время ожидания для бездействующего TCP-соединения.

Значение может быть установлено в диапазоне от 4 до 30 минут.

Значение по умолчанию составляет 4 минут.

Этот элемент используется только когда protocol=Tcp.

name

строка / обязательно

имя правила входящего NAT.

protocol

строка

протокол IP для правила входящего NAT.

Варианты:

• "Tcp"
• "Udp"
• "All"

load_balancing_rules

список / элементы=словарь

Коллекция объектов, представляющих правила балансировки нагрузки. Получает данные о подготовке.

backend_address_pool

строка / обязательно

Ссылка на пул IP-адресов. Входящий трафик распределяется по IP-адресам в пуле задних IP-адресов случайным образом.

backend_port

целое число

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

Допустимые значения находятся в диапазоне от 0 до 65535.

Обратите внимание, что значение 0 включает «Любой порт».

disable_outbound_snat

логическое

Настройка переадресации внешних адресов источника (SNAT).

По умолчанию, если не указано, поведение эквивалентно disable_outbound_snat=True.

Значение True эквивалентно «(Рекомендуется) Использовать правила исходящего трафика, чтобы предоставить членам пула задних планов доступ к интернету» в портале.

Значение False эквивалентно «Использовать стандартный исходящий доступ» в портале.

Варианты:

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

enable_floating_ip

логическое

Настраивает конечную точку виртуальной машины для возможности плавающего IP-адреса, необходимой для настройки группы доступности SQL AlwaysOn.

Варианты:

• false
• true

frontend_ip_configuration

строка / обязательно

Ссылка на IP-адреса фронтальной части.

frontend_port

целое число / обязательно

Порт для внешней конечной точки.

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

Допустимые значения находятся в диапазоне от 0 до 65534.

Обратите внимание, что значение 0 включает «Любой порт».

idle_timeout

целое число

Таймаут для соединения TCP при простоя.

Значение может быть установлено в диапазоне от 4 до 30 минут.

Значение по умолчанию составляет 4 минут.

Этот элемент используется только в том случае, если протокол установлен в TCP.

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

load_distribution

строка

Политика сохранения сессии для этого правила; Default означает отсутствие сохранения.

Варианты:

• "Default" ← (по умолчанию)
• "SourceIP"
• "SourceIPProtocol"

name

строка / обязательно

Название правила балансировки нагрузки.

probe

строка / обязательно

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

protocol

строка

IP-протокол для правила балансировки нагрузки.

Варианты:

• "Tcp"
• "Udp"
• "All"

location

строка

Действительное расположение Azure. По умолчанию используется расположение группы ресурсов.

log_mode

строка

Аргумент родителя.

log_path

строка

Аргумент родителя.

name

строка / обязательно

Имя балансировщика нагрузки.

password

строка

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

probes

список / элементы=словарь

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

fail_count

aliases: number_of_probes

целое число

Количество проверок, после которого, если нет ответа, дальнейшая доставка трафика к конечному пункту будет прекращена.

Это значение позволяет выводить конечные точки из вращения быстрее или медленнее, чем в типичных случаях в Azure.

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

interval

целое число

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

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

Значение по умолчанию — 15, минимальное значение — 5.

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

name

строка / обязательно

Имя проверки.

port

целое число / обязательно

Порт проверки для связи. Возможные значения находятся в диапазоне от 1 до 65535 включительно.

protocol

строка

Протокол конечной точки, подлежащей проверке.

Если указано Tcp, для успешной проверки требуется получение подтверждения (ACK).

Если указано Http или Https, для успешной проверки требуется ответ 200 OK от указанного URL.

Варианты:

• "Tcp"
• "Http"
• "Https"

request_path

строка

URI, используемый для запроса статуса работоспособности виртуальной машины.

Путь требуется, если protocol=Http или protocol=Https. В противном случае он не разрешен.

profile

строка

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

resource_group

строка / обязательно

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

secret

строка

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

sku

строка

SKU балансировщика нагрузки.

Варианты:

• "Basic"
• "Standard"

state

строка

Утверждение состояния балансировщика нагрузки. Используйте present для создания/обновления балансировщика нагрузки или absent для удаления.

Варианты:

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

subscription_id

строка

Ваш идентификатор подписки Azure.

tags

словарь

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

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

Для удаления тегов установите параметр append_tags в значение false.

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

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

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

tenant

строка

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

thumbprint

строка

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

Отпечаток цифровой подписи частного ключа, указанного в x509_certificate_path.

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

Требуется, если определен x509_certificate_path.

x509_certificate_path

путь

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

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

Сертификат должен быть присоединён к закрытому ключу.

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