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

actions

list / elements=dictionary

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

cache_behavior

string

Поведение кэширования запросов.

Варианты:

• "BypassCache"
• "Override"
• "SetIfMissing"
• "HonorOrigin"
• "OverrideAlways"
• "OverrideIfOriginMissing"

cache_duration

string

Продолжительность кэширования содержимого. Допустимый формат: [d.]hh:mm:ss.

custom_fragment

string

Фрагмент, добавляемый к URL-адресу перенаправления. Фрагмент — это часть URL-адреса, которая идет после

custom_hostname

string

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

custom_path

string

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

custom_query_string

string

Набор строк запроса, добавляемых в URL-адрес перенаправления.

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

Строка запроса должна иметь формат <key>=:code:<value>. Символы ? и & будут добавлены автоматически, поэтому не указывайте их.

destination

string

Укажите относительный URL-адрес, на который будут перенаправляться указанные выше запросы.

destination_protocol

string

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

Варианты:

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

forwarding_protocol

string

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

Варианты:

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

header_action

string

Выполняемое действие.

Варианты:

• "Append"
• "Overwrite"
• "Delete"

header_name

string

Имя заголовка для изменения.

is_compression_enabled

string

Конфигурация кэширования для этого маршрута. Указывает, включено ли сжатие содержимого в AzureFrontDoor.

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

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

Варианты:

• "Enabled"
• "Disabled"

name

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

Имя действия для правила доставки.

Варианты:

• "ModifyRequestHeader"
• "ModifyResponseHeader"
• "RouteConfigurationOverride"
• "UrlRedirect"
• "UrlRewrite"

origin_group

string

Определяет OriginGroup, переопределяющую DefaultOriginGroup.

preserve_unmatched_path

boolean

Следует ли сохранять несовпавший путь.

Варианты:

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

query_parameters

string

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

query_string_caching_behavior

string

Конфигурация кэширования для этого маршрута. Определяет, как Front Door кэширует запросы со строками запроса.

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

или кэшировать определенные строки запроса.

Варианты:

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

redirect_type

string

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

Варианты:

• "Moved"
• "Found"
• "TemporaryRedirect"
• "PermanentRedirect"

source_pattern

string

Задает шаблон URI запроса, определяющий тип запросов, которые можно переписать.

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

value

string

Значение для указанного действия.

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

conditions

list / elements=dictionary

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

match_values

list / elements=string

Значение для сопоставления с условием правила доставки.

name

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

Имя условия для правила доставки.

Варианты:

• "ClientPort"
• "Cookies"
• "HostName"
• "HttpVersion"
• "IsDevice"
• "PostArgs"
• "QueryString"
• "RemoteAddress"
• "RequestBody"
• "RequestHeader"
• "RequestMethod"
• "RequestScheme"
• "RequestUri"
• "ServerPort"
• "SocketAddr"
• "SslProtocol"
• "UrlFileExtension"
• "UrlFileName"
• "UrlPath"

negate_condition

boolean

Указывает, является ли условие отрицательным.

Варианты:

• false
• true

operator

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

Оператор для сопоставления.

Варианты:

• "Any"
• "Equal"
• "Contains"
• "BeginsWith"
• "EndsWith"
• "LessThan"
• "LessThanOrEqual"
• "GreaterThan"
• "GreaterThanOrEqual"
• "RegEx"
• "IPMatch"
• "GeoMatch"

selector

string

Имя элемента для сопоставления.

transforms

list / elements=string

Список преобразований.

Варианты:

• "Lowercase"
• "RemoveNulls"
• "Trim"
• "Uppercase"
• "URLDecode"
• "URLEncode"

disable_instance_discovery

boolean

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

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

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

Варианты:

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

log_mode

string

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

log_path

string

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

match_processing_behavior

string

Если это правило совпало, должен ли обработчик правил продолжить выполнение оставшихся правил или остановиться?

Варианты:

• "Continue" ← (по умолчанию)
• "Stop"

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.

order

integer

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

Правило с меньшим порядковым номером применяется раньше правила с большим номером. Правило с номером 0 является особым.

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

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.

rule_set_name

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

Имя набора правил в профиле.

secret

string

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

state

string

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

Варианты:

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

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

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

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

id

string

Идентификатор ресурса.

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