Модуль azure.azcollection.azure_rm_afdorigingroup_info — получение сведений об OriginGroup 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_afdorigingroup_info.

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

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

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

Получение сведений об определенной группе источников (OriginGroup) Azure Front Door (AFD) или обо всех группах AFD OriginGroup.
Этот модуль отличается от классической службы 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	Ограничивает результаты указанной группой AFD OriginGroup.
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 / обязательный	Имя профиля AFD.
resource_group string / обязательный	Имя группы ресурсов, которой принадлежит этот профиль AFD.
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 OriginGroups in AFD Profile
  azure_rm_afdorigingroup_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific AFD OriginGroup
  azure_rm_afdorigingroup_info:
    name: myOriginGroup1
    profile_name: myCDNProfile
    resource_group: myResourceGroup

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

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

Ключ	Описание
afdorigingroups complex	Список групп источников AFD. Возвращается: всегда
deployment_status string	Текущее состояние ресурса. Возвращается: при успешном выполнении Пример: `"NotStarted"`
health_probe_settings dictionary	Параметры проверки доступности источника, используемые для определения его состояния. Возвращается: при успешном выполнении
probe_interval_in_seconds integer	Интервал в секундах между проверками доступности. Возвращается: при успешном выполнении
probe_path string	Путь относительно источника, используемый для определения его состояния. Возвращается: при успешном выполнении
probe_protocol string	Протокол для проверки доступности. Возвращается: при успешном выполнении Возможные возвращаемые значения: `"Http"` `"Https"` `"NotSet"`
probe_request_type string	Тип запроса, отправляемого для проверки доступности. Возвращается: при успешном выполнении Возможные возвращаемые значения: `"GET"` `"HEAD"` `"NotSet"`
id string	Идентификатор группы источников AFD. Возвращается: при успешном выполнении Пример: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myCDN/providers/Microsoft.Cdn/profiles/myProfile/origingroups/myOG1"`
load_balancing_settings dictionary	Параметры балансировки нагрузки для пула серверной части. Возвращается: при успешном выполнении
additional_latency_in_milliseconds integer	Дополнительная задержка в миллисекундах, при которой результаты проверок попадают в корзину с наименьшей задержкой. Возвращается: при успешном выполнении
sample_size integer	Количество выборок, учитываемых при принятии решений о балансировке нагрузки. Возвращается: при успешном выполнении
successful_samples_required integer	Количество выборок за период выборки, которые должны завершиться успешно. Возвращается: при успешном выполнении
name string	Имя группы источников AFD. Возвращается: при успешном выполнении
profile_name string	Имя профиля AFD, в который будет добавлена группа источников. Возвращается: при успешном выполнении
provisioning_state string	Состояние подготовки группы источников AFD. Возвращается: при успешном выполнении Пример: `"Succeeded"`
resource_group string	Имя группы ресурсов, в которой находится или будет создана группа источников AFD. Возвращается: при успешном выполнении
session_affinity_state string	Разрешено ли сохранять привязку сеанса для этого узла. Возвращается: при успешном выполнении Возможные возвращаемые значения: `"Enabled"` `"Disabled"`
type string	Тип ресурса. Возвращается: при успешном выполнении Пример: `"Microsoft.Cdn/profiles/afdorigingroups"`

Авторы

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_info_module.html