Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_afdorigin — управление источником 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_afdorigin.

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

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

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

  • Создание, обновление и удаление источника Azure Front Door (AFD), используемого профилем службы Front Door, созданным с помощью azure_rm_cdnprofile.

Требования

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

  • python >= 2.7
  • На узле, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection из Galaxy
  • Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены на узле, выполняющем модули из azure.azcollection, с помощью pip
  • Полные инструкции по установке приведены по адресу 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"

azure_origin

string

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

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

enabled_state

string

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

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

Варианты:

  • "Enabled"
  • "Disabled"

host_name

string

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

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

http_port

integer

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

По умолчанию: 80

https_port

integer

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

По умолчанию: 443

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 / обязательный

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

origin_host_header

string

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

Для источников Azure Front Door, таких как веб-приложения и хранилище BLOB-объектов,

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

Это значение переопределяет заголовок Host, заданный в конечной точке AFD.

password

string

Пароль пользователя Active Directory. Используется при аутентификации от имени пользователя Active Directory, а не с помощью субъекта-службы.

priority

integer

Приоритет источника в заданной группе источников для балансировки нагрузки.

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

profile

string

Профиль безопасности из файла ~/.azure/credentials.

profile_name

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

Имя профиля AFD.

resource_group

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

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

secret

string

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

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" ← (по умолчанию)
  • "Disconnected"
  • "Pending"
  • "Rejected"
  • "Timeout"

state

string

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

Варианты:

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

subscription_id

string

Идентификатор вашей подписки Azure.

tenant

string

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

thumbprint

string

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

Отпечаток закрытого ключа, указанного в x509_certificate_path.

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

Обязателен, если задан x509_certificate_path.

weight

integer

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

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 Origin
  azure_rm_afdorigin:
    name: myOrigin
    origin_group_name: myOriginGroup
    profile_name: myProfile
    resource_group: myResourceGroup
    state: present
    host_name: "10.0.0.1"
    origin_host_header: "10.0.0.1"
    http_port: 80
    https_port: 443
    priority: 1
    weight: 1000

- name: Delete an AFD Origin
  azure_rm_afdorigin:
    name: myOrigin
    origin_group_name: myOriginGroup
    profile_name: myProfile
    resource_group: myResourceGroup
    state: absent

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

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

Ключ

Описание

host_name

string

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

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

Пример: "myorigin.azurefd.net"

id

string

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

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

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

Авторы

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

Spec-Zone.ru

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