Модуль azure.azcollection.azure_rm_trafficmanager — управление профилем Traffic Manager.

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"

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

dns_config

dictionary

Параметры DNS профиля Traffic Manager.

relative_name

string

Относительное имя DNS, предоставляемое этим профилем Traffic Manager.

Если имя не указано, будет использоваться имя Traffic Manager.

ttl

integer

Время жизни записи DNS (TTL) в секундах.

endpoints

list / elements=dictionary

Список конечных точек в профиле Traffic Manager.

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

endpoint_location

string

Указывает расположение внешних или вложенных конечных точек при использовании метода маршрутизации трафика «Performance».

endpoint_monitor_status

string

Состояние мониторинга конечной точки.

endpoint_status

string

Состояние конечной точки.

Варианты:

• "Enabled"
• "Disabled"

geo_mapping

list / elements=string

Список стран и регионов, сопоставленных с этой конечной точкой при использовании метода маршрутизации трафика «Geographic».

id

string

Полный идентификатор ресурса.

min_child_endpoints

integer

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

Применимо только к конечным точкам типа «NestedEndpoints».

name

string

Имя конечной точки.

priority

integer

Приоритет этой конечной точки при использовании метода маршрутизации трафика «Priority».

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

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

У двух конечных точек не может быть одинакового значения приоритета.

target

string

Полное доменное имя DNS конечной точки.

target_resource_id

string

URI ресурса Azure для конечной точки.

Не применяется к конечным точкам типа «ExternalEndpoints».

type

string

Тип конечной точки. Например, Microsoft.network/TrafficManagerProfiles/ExternalEndpoints.

weight

integer

Вес этой конечной точки при использовании метода маршрутизации трафика «Weighted».

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

location

string

Допустимое расположение Azure. По умолчанию — «global».

log_mode

string

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

log_path

string

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

monitor_config

dictionary

Параметры мониторинга конечных точек профиля Traffic Manager.

По умолчанию: {"path": "/", "port": 80, "protocol": "HTTP"}

interval_in_seconds

integer

Интервал мониторинга конечных точек в этом профиле.

path

string

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

port

integer

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

profile_monitor_status

string

Состояние мониторинга профиля Traffic Manager.

protocol

string

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

Варианты:

• "HTTP"
• "HTTPS"
• "TCP"

timeout_in_seconds

integer

Тайм-аут мониторинга конечных точек в этом профиле.

tolerated_number_of_failures

integer

Число последовательных неудачных проверок работоспособности, после которого при следующей неудачной проверке конечная точка в этом профиле будет признана ухудшившей состояние (Degraded).

name

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

Имя профиля Traffic Manager.

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, а не субъекта-службы.

profile

string

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

profile_status

string

Состояние профиля Traffic Manager.

Варианты:

• "Enabled" ← (по умолчанию)
• "Disabled"

resource_group

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

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

secret

string

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

state

string

Указывает требуемое состояние профиля Traffic Manager. Используйте present для создания или обновления профиля Traffic Manager и 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.

traffic_routing_method

string

Метод маршрутизации трафика профиля Traffic Manager.

Варианты:

• "Performance" ← (по умолчанию)
• "Priority"
• "Weighted"
• "Geographic"

x509_certificate_path

path

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

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

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

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

state

словарь

Текущее состояние профиля Traffic Manager

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

Пример: {"dns_config": {"fqdn": "tmtest.trafficmanager.net", "relative_name": "tmtest", "ttl": 60}, "endpoints": [{"endpoint_location": "West US 2", "endpoint_monitor_status": "Degraded", "endpoint_status": "Enabled", "geo_mapping": null, "id": "/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1", "min_child_endpoints": null, "name": "e1", "priority": 2, "target": "1.2.3.4", "target_resource_id": null, "type": "Microsoft.Network/trafficManagerProfiles/externalEndpoints", "weight": 1}], "id": "/subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest", "location": "global", "monitor_config": {"interval_in_seconds": 30, "path": "/", "port": 80, "profile_monitor_status": "Degraded", "protocol": "HTTPS", "timeout_in_seconds": 10, "tolerated_number_of_failures": 3}, "name": "tmtest", "profile_status": "Enabled", "tags": {"Environment": "Test"}, "traffic_routing_method": "Priority", "type": "Microsoft.Network/trafficManagerProfiles"}