Spec-Zone.ru › Ansible

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

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.

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_name

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

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

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 Origins in AFD Profile
  azure_rm_afdorigin_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific AFD Origin
  azure_rm_afdorigin_info:
    name: myOrigin1
    profile_name: myCDNProfile
    resource_group: myResourceGroup

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

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

Ключ

Описание

afdorigins

complex

Список источников AFD.

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

azure_origin

string

Ссылка на ресурс источника AFD.

Возвращается: при успехе

deployment_status

string

Текущее состояние ресурса.

Возвращается: при успехе

Пример: "NotStarted"

enabled_state

string

Указывает, следует ли выполнять проверки работоспособности для серверов, определённых в пулах серверов.

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

Возвращается: при успехе

Пример: "Enabled"

host_name

string

Адрес источника. Поддерживаются доменные имена, адреса IPv4 и IPv6.

В пределах одной конечной точки это значение должно быть уникальным для всех источников.

Возвращается: при успехе

http_port

integer

Значение порта HTTP. Должно находиться в диапазоне от 1 до 65535.

Возвращается: при успехе

Пример: 80

https_port

integer

Значение порта HTTPS. Должно находиться в диапазоне от 1 до 65535.

Возвращается: при успехе

Пример: 443

id

string

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

Возвращается: при успехе

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx/resourcegroups/myRG/providers/Microsoft.Cdn/profiles/myProf/origingroups/myOG/origins/myO"

name

string

Имя источника AFD.

Возвращается: при успехе

origin_group_name

string

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

Возвращается: при успехе

origin_host_header

string

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

Для источников Azure Front Door, таких как веб-приложения, хранилище Blob и облачные службы, по умолчанию значение этого заголовка Host должно совпадать с именем узла источника. Это значение переопределяет заголовок Host, заданный для конечной точки AFD.

Возвращается: при успехе

priority

integer

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

Значение должно находиться в диапазоне от 1 до 5.

Возвращается: при успехе

profile_name

string

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

Возвращается: при успехе

provisioning_state

string

Состояние подготовки источника AFD.

Возвращается: при успехе

Пример: "Succeeded"

resource_group

string

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

Возвращается: при успехе

shared_private_link_resource

dictionary

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

Возвращается: при успехе

group_id

string

Идентификатор группы от поставщика ресурса, для которого предназначен общий ресурс частной конечной точки.

Возвращается: при успехе

private_link

string

Идентификатор ресурса, для которого предназначен общий ресурс частной конечной точки.

Возвращается: при успехе

private_link_location

string

Расположение общего ресурса частной конечной точки.

Возвращается: при успехе

request_message

string

Сообщение с запросом на утверждение общего ресурса частной конечной точки.

Возвращается: при успехе

status

string

Состояние общего ресурса частной конечной точки. Возможные значения: Pending (ожидание), Approved (утверждён), Rejected (отклонён), Disconnected (отключён) или Timeout (истекло время ожидания).

Возвращается: при успехе

Пример: "Approved"

type

string

Тип ресурса.

Возвращается: при успехе

Пример: "Microsoft.Cdn/profiles/origingroups/origins"

weight

integer

Вес источника в указанной группе источников для балансировки нагрузки. Значение должно находиться в диапазоне от 1 до 1000.

Возвращается: при успехе

Авторы

  • 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_afdorigin_info_module.html

Spec-Zone.ru

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