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

ad_user

string

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

adfs_authority_url

string

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

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

allowed_endpoint_record_types

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

Список разрешённых типов записей конечных точек.

Варианты:

• "DomainName"
• "IPv4Address"
• "IPv6Address"
• "Any"

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

Если задано значение msi, на хост-компьютере должен быть включён модуль расширения MSI ресурса Azure. Если ресурсу предоставлен доступ к нескольким подпискам, для указания идентификатора подписки можно использовать 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

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

location

string

Допустимое расположение Azure. По умолчанию используется global, поскольку в общедоступном облаке Azure по умолчанию профиль Traffic Manager можно развернуть только глобально.

См. https://docs.microsoft.com/en-us/azure/traffic-manager/quickstart-create-traffic-manager-profile#create-a-traffic-manager-profile.

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

log_mode

string

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

log_path

string

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

max_return

integer

Максимальное количество возвращаемых конечных точек для типа маршрутизации MultiValue.

monitor_config

dictionary

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

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

custom_headers

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

Список пользовательских заголовков.

name

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

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

value

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

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

expected_status_code_ranges

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

Список ожидаемых диапазонов кодов состояния.

max

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

Максимальный код состояния.

min

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

Минимальный код состояния.

interval

integer

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

path

string

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

port

integer

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

profile_monitor_status

string

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

Варианты:

• "CheckingEndpoint"
• "Online"
• "Degraded"
• "Inactive"
• "Stopped"
• "Disabled"

protocol

string

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

Варианты:

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

timeout

integer

Время ожидания при мониторинге конечных точек этого профиля в секундах.

tolerated_failures

integer

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

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.

routing_method

string

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

Варианты:

• "performance" ← (по умолчанию)
• "priority"
• "weighted"
• "geographic"

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.

x509_certificate_path

path

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

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

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

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

endpoints

list / elements=string

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

Возвращается: если существуют конечные точки диспетчера трафика

Пример: ["/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e2", "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tm049b1ae293/exter nalEndpoints/e1"]

id

string

Идентификатор профиля диспетчера трафика.

Возвращается: если существует профиль диспетчера трафика

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest"