Модуль azure.azcollection.azure_rm_afdorigingroup — управление OriginGroup Azure Front Door для использования со Standard или Premium Frontdoor
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Эта коллекция уже может быть установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_afdorigingroup.
Добавлено в azure.azcollection 3.4.0
Краткое описание
- Создание, обновление и удаление OriginGroup Azure Front Door (AFD), используемой профилем службы Front Door, созданным с помощью azure_rm_cdnprofile.
- Этот модуль отличается от классической службы 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. Значение по умолчанию По умолчанию: |
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (согласно определению Azure Python SDK, например По умолчанию: |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Если задать значение true, обнаружение экземпляров и проверка центра сертификации будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно получить доступ к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляров включает получение метаданных центра сертификации с адреса https://login.microsoft.com/ для проверки центра сертификации. Если задать значение **True**, проверка центра сертификации будет отключена. Поэтому крайне важно убедиться, что настроенный узел центра сертификации является допустимым и надежным. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
health_probe_settings dictionary | Параметры проверки работоспособности источника, используемые для определения его состояния. |
|
probe_interval_in_seconds integer |
Интервал в секундах между проверками работоспособности. |
|
probe_path string |
Путь относительно источника, используемый для определения его работоспособности. |
|
probe_protocol string |
Протокол для проверки работоспособности. Варианты:
|
|
probe_request_type string |
Тип запроса, отправляемого для проверки работоспособности. Варианты:
|
load_balancing_settings dictionary | Параметры балансировки нагрузки для пула серверной части. |
|
additional_latency_in_milliseconds integer |
Дополнительная задержка в миллисекундах, при которой проверки попадают в корзину с наименьшей задержкой. |
|
sample_size integer |
Количество выборок, учитываемых при принятии решений о балансировке нагрузки. |
|
successful_samples_required integer |
Количество выборок за период выборки, которые должны завершиться успешно. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя OriginGroup AFD. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), напрямую используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions и Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
profile_name string / обязательный | Имя профиля AFD, в который будет добавлена OriginGroup. |
resource_group string / обязательный | Имя группы ресурсов, в которой существует или будет создана OriginGroup AFD. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
session_affinity_state string | Разрешено ли использование привязки сеанса на этом узле. Варианты:
|
state string | Задает требуемое состояние OriginGroup AFD. Используйте Варианты:
|
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: Create an AFD OriginGroup
azure_rm_afdorigingroup:
name: myOriginGroup
profile_name: myProfile
resource_group: myResourceGroup
state: present
tags:
testing: testing
- name: Delete the AFD OriginGroup
azure_rm_afdorigingroup:
name: myOriginGroup
profile_name: myProfile
resource_group: myResourceGroup
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
id string | Идентификатор OriginGroup AFD. Возвращается: всегда Пример: |
Авторы
- 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_afdorigingroup_module.html