Модуль azure.azcollection.azure_rm_afdroute — управление маршрутом Azure Front Door

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"

content_types_to_compress

list / elements=string

Параметры кэширования и сжатия для этого маршрута.

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

Требуется совместно с (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters)

custom_domains

list / elements=string

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

disable_cache_configuration

boolean

Чтобы отключить настройки кэширования, задайте значение true и не указывайте cache_configuration.

При этом любые указанные вами настройки cache_configuration будут переопределены.

Варианты:

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

disable_instance_discovery

boolean

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

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

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

Варианты:

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

enabled_state

string

Включить или отключить это правило. Допустимые значения: «Enabled» или «Disabled».

Варианты:

• "Enabled"
• "Disabled"

endpoint_name

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

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

forwarding_protocol

string

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

Варианты:

• "HttpOnly"
• "HttpsOnly"
• "MatchRequest"

https_redirect

string

Автоматически перенаправлять трафик HTTP на HTTPS.

Варианты:

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

is_compression_enabled

boolean

Параметры кэширования и сжатия для этого маршрута.

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

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

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

Требуется совместно с (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters)

Варианты:

• false
• true

link_to_default_domain

string

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

Варианты:

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

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.

origin_group

string

Ссылка на группу источников.

origin_path

string

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

password

string

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

patterns_to_match

list / elements=string

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

profile

string

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

profile_name

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

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

query_parameters

string

Параметры кэширования для этого маршрута.

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

Требуется совместно с (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters)

query_string_caching_behavior

string

Параметры кэширования для этого маршрута.

Определяет, как Front Door кэширует запросы, содержащие строки запроса.

Можно игнорировать все строки запроса при кэшировании, игнорировать определенные строки запроса,

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

Требуется совместно с (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters)

Варианты:

• "IgnoreQueryString"
• "IgnoreSpecifiedQueryStrings"
• "IncludeSpecifiedQueryStrings"
• "UseQueryString"

resource_group

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

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

rule_sets

list / elements=string

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

secret

string

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

state

string

Задайте требуемое состояние маршрута. Используйте present для создания или обновления профиля CDN и absent для его удаления.

Варианты:

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

subscription_id

string

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

supported_protocols

list / elements=string

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

Варианты:

• "Http" ← (по умолчанию)
• "Https" ← (по умолчанию)

По умолчанию: ["Http", "Https"]

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

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

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

id

string

ID маршрута.

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

Пример: "id: '/subscriptions/xxxxxx-xxxx-xxxx-xxxx-xxxxxxxx/resourcegroups/myRG/providers/Microsoft.Cdn/profiles/myProf/afdendpoints/myEP/routes/myRoute'"