модуль azure.azcollection.azure_rm_afdroute_info — получение сведений о маршрутах Azure Front Door для использования со службой Front Door Standard или Premium

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"

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, на узле должен быть включен модуль 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

endpoint_name

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

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

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.

password

string

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

profile

string

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

profile_name

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

Имя профиля Azure Front Door Standard или Azure Front Door Premium, уникальное в пределах группы ресурсов.

resource_group

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

Имя группы ресурсов в подписке Azure.

secret

string

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

subscription_id

string

Идентификатор вашей подписки Azure.

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

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

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

afdroutes

complex

Список маршрутов AFD.

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

content_types_to_compress

list / elements=string

Список типов содержимого (str), для которых применяется сжатие. Значение должно быть допустимым типом MIME.

Возвращается: при успехе

custom_domains

list / elements=string

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

Возвращается: при успехе

deployment_status

string

Текущее состояние ресурса.

Возвращается: при успехе

Пример: "NotStarted"

enabled_state

string

Указывает, включено ли использование этого правила.

Возвращается: при успехе

endpoint_name

string

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

Возвращается: при успехе

forwarding_protocol

string

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

Возвращается: при успехе

https_redirect

string

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

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

Возвращается: при успехе

id

string

Идентификатор маршрута AFD.

Возвращается: при успехе

Пример: "/subscriptions/xxxxx-xxxx-xxxx-xxxx-xxxxxx/resourcegroups/myRG/providers/Microsoft.Cdn/profiles/myProf/routegroups/myRtGrp/routes/myRt"

is_compression_enabled

boolean

Указывает, включено ли сжатие содержимого в AzureFrontDoor. Если сжатие включено,

содержимое будет передаваться в сжатом виде, если пользователь запросит сжатую версию. Содержимое не будет сжато

в AzureFrontDoor, если размер запрошенного содержимого меньше 1 байта или больше 1 МБ.

Возвращается: при успехе

link_to_default_domain

string

Указывает, будет ли этот маршрут связан с доменом конечной точки по умолчанию.

Возвращается: при успехе

name

string

Имя маршрута AFD.

Возвращается: при успехе

origin_group_id

string

Идентификатор группы источников.

Возвращается: при успехе

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx/resourcegroups/myRG/providers/Microsoft.Cdn/profiles/myProf/origingroups/myOG"

origin_path

string

Путь к каталогу на источнике, который AzureFrontDoor может использовать для получения содержимого, например contoso.cloudapp.net/originpath.

Возвращается: при успехе

patterns_to_match

list / elements=string

Шаблоны маршрута для этого правила.

Возвращается: при успехе

profile_name

string

Имя профиля AFD, в котором находится маршрут.

Возвращается: при успехе

provisioning_state

string

Состояние подготовки маршрута AFD.

Возвращается: при успехе

Пример: "Succeeded"

query_parameters

string

Параметры запроса, которые нужно включить или исключить (через запятую).

Возвращается: при успехе

query_string_caching_behavior

string

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

игнорировать определённые строки запроса, кэшировать каждый запрос с уникальным URL или кэшировать определённые строки запроса.

Возвращается: при успехе

resource_group_name

string

Имя группы ресурсов, в которой находится маршрут AFD.

Возвращается: при успехе

rule_sets

list / elements=string

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

Возвращается: при успехе

supported_protocols

list / elements=string

Список протоколов, поддерживаемых этим маршрутом.

Возвращается: при успехе

type

string

Тип ресурса.

Возвращается: при успехе

Пример: "Microsoft.Cdn/profiles/afdendpoints/routes"