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

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, будут удалены из метаданных объекта.

Варианты:

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

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

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

Варианты:

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

backend_address_pools

list / elements=dictionary

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

name

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

Имя пула внутренних IP-адресов.

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

frontend_ip_configurations

list / elements=dictionary

Список используемых внешних IP-адресов.

name

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

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

private_ip_address

string

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

private_ip_allocation_method

string

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

Варианты:

• "Static"
• "Dynamic"

public_ip_address

string

Имя существующего объекта общедоступного IP-адреса в текущей группе ресурсов, который нужно связать с группой безопасности.

subnet

string

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

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

zones

list / elements=string

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

При указании зон необходимо задать sku=Standard и subnet.

inbound_nat_pools

list / elements=dictionary

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

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

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

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

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

Для них необходимо указывать отдельные правила входящего NAT.

backend_port

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

Порт для внутренних подключений к конечной точке.

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

frontend_ip_configuration_name

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

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

frontend_port_range_end

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

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

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

frontend_port_range_start

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

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

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

name

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

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

protocol

string

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

Варианты:

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

inbound_nat_rules

list / elements=dictionary

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

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

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

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

Для них необходимо указывать отдельные правила входящего NAT.

backend_port

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

Порт для внутренних подключений к конечной точке.

Допустимые значения: от 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 / обязательный

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

frontend_port

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

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

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

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

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

idle_timeout

integer

Время ожидания неактивного TCP-подключения.

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

Значение по умолчанию — 4 минут.

Этот параметр используется только при protocol=Tcp.

name

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

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

protocol

string

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

Варианты:

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

load_balancing_rules

list / elements=dictionary

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

backend_address_pool

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

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

backend_port

integer

Порт для внутренних подключений к конечной точке.

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

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

disable_outbound_snat

boolean

Настройка трансляции исходных сетевых адресов (SNAT) для исходящего трафика.

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

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

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

Варианты:

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

enable_floating_ip

boolean

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

Варианты:

• false
• true

enable_tcp_reset

boolean

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

Этот параметр используется только при выборе протокола TCP.

Варианты:

• false
• true

frontend_ip_configuration

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

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

frontend_port

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

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

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

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

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

idle_timeout

integer

Время ожидания неактивного TCP-подключения.

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

Значение по умолчанию — 4 минут.

Этот параметр используется только при выборе протокола TCP.

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

load_distribution

string

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

Варианты:

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

name

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

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

probe

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

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

protocol

string

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

Варианты:

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

location

string

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

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.

outbound_rules

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

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

Правила исходящего трафика.

allocated_outbound_ports

integer

Количество исходящих портов, используемых для NAT.

backend_address_pool

string

Ссылка на пул DIP.

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

enable_tcp_reset

boolean

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

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

Варианты:

• false
• true

frontend_ip_configurations

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

Внешние IP-адреса балансировщика нагрузки.

idle_timeout_in_minutes

integer

Время ожидания для неактивного TCP-соединения.

name

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

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

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

protocol

string

Протокол для правила исходящего трафика балансировщика нагрузки.

Варианты:

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

password

string

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

probes

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

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

fail_count

псевдонимы: number_of_probes

integer

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

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

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

interval

integer

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

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

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

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

name

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

Имя пробы.

port

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

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

protocol

string

Протокол проверяемой конечной точки.

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

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

Варианты:

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

request_path

string

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

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

profile

string

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

resource_group

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

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

secret

string

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

sku

string

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

Варианты:

• "Basic"
• "Standard"

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.

x509_certificate_path

path

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

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

Сертификат должен быть добавлен в конец закрытого ключа.

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

changed

boolean

Изменился ли ресурс.

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

state

dictionary

Текущее состояние балансировщика нагрузки.

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