Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_afdrules_info — получение сведений о правилах Azure Front Door для службы Front Door Standard или Premium

Примечание

Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).

Эта коллекция уже может быть установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_afdrules_info.

Добавлено в azure.azcollection 3.4.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Получение сведений об определенном правиле Azure Front Door (AFD) или обо всех правилах AFD в наборе правил.
  • Отличается от классической службы Front Door и предназначен только для службы Standard или Premium.

Требования

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

  • python >= 2.7
  • В коллекции azure.azcollection, установленной из Galaxy, должен быть узел, выполняющий этот модуль
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены с помощью pip на узле, выполняющем модули из azure.azcollection
  • Полные инструкции по установке см. на странице https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр

Комментарии

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, компьютер должен быть ресурсом 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

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.

rule_set_name

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

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

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

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

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

Примечания

Примечание

  • Для аутентификации в Azure можно передать параметры, задать переменные среды, использовать профиль из ~/.azure/credentials или войти в систему перед запуском задач или плейбука с помощью az login.
  • Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
  • Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
  • Для аутентификации через субъект-службу передайте subscription_id, client_id, secret и tenant либо задайте переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
  • Для аутентификации пользователя Active Directory передайте ad_user и password либо задайте в среде AZURE_AD_USER и AZURE_PASSWORD.
  • Кроме того, учетные данные можно хранить в ~/.azure/credentials. Это INI-файл с разделом [default] и следующими ключами: subscription_id, client_id, secret и tenant либо subscription_id, ad_user и password. Можно также добавить дополнительные профили. Укажите профиль, передав profile или задав в среде AZURE_PROFILE.

См. также

См. также

Вход с помощью Azure CLI

Инструкции по аутентификации с помощью команды az login.

Примеры

- name: Get facts for all Rules in the AFD Profile
  azure_rm_afdrule_info:
    rule_set_name: myRuleset
    profile_name: myProfile
    resource_group: myResourceGroup

- name: Get facts of specific AFD Rule
  azure_rm_afdrule_info:
    name: myRule1
    rule_set_name: myRuleset
    profile_name: myProfile
    resource_group: myResourceGroup

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

afdrules

complex

Список правил AFD.

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

actions

list / elements=dictionary

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

Возвращается: при успешном выполнении

cache_behavior

string

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

Возвращается: при успешном выполнении

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

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

Возвращается: при успешном выполнении

forwarding_protocol

string

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

Возвращается: при успешном выполнении

header_action

string

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

Возвращается: при успешном выполнении

header_name

string

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

Возвращается: при успешном выполнении

is_compression_enabled

string

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

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

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

origin_group

string

Определяет OriginGroup, который заменит DefaultOriginGroup.

Возвращается: при успешном выполнении

preserve_unmatched_path

boolean

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

Возвращается: при успешном выполнении

query_parameters

string

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

Возвращается: при успешном выполнении

query_string_caching_behavior

string

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

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

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

Возвращается: при успешном выполнении

redirect_type

string

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

Возвращается: при успешном выполнении

source_pattern

string

Определяет шаблон URI запроса, который идентифицирует тип запросов, подлежащих переписыванию.

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

Возвращается: при успешном выполнении

value

string

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

Возвращается: при успешном выполнении

conditions

list / elements=dictionary

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

Возвращается: при успешном выполнении

match_values

list / elements=string

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

negate_condition

boolean

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

Возвращается: при успешном выполнении

operator

string

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

Возвращается: при успешном выполнении

selector

string

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

Возвращается: при успешном выполнении

transforms

list / elements=string

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

Возвращается: при успешном выполнении

match_processing_behavior

string

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

Возвращается: при успешном выполнении

name

string

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

Возвращается: при успешном выполнении

order

integer

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

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

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

Возвращается: при успешном выполнении

profile_name

string

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

Возвращается: при успешном выполнении

resource_group

string

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

Возвращается: при успешном выполнении

rule_set_name

string

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

Возвращается: при успешном выполнении

state

string

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

Возвращается: при успешном выполнении

type

string

Тип ресурса.

Возвращается: при успешном выполнении

Авторы

  • Jarret Tooley (@jartoo)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_afdrules_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API