Модуль azure.azcollection.azure_rm_cdnendpoint — управление конечной точкой Azure CDN
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в сценарии, укажите: azure.azcollection.azure_rm_cdnendpoint.
Добавлено в azure.azcollection 0.1.2
Краткое описание
- Создание, обновление, запуск, остановка и удаление конечной точки Azure CDN.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле tags каноническим или только добавляет значения к существующим тегам. Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта. Варианты:
|
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, например, По умолчанию: |
content_types_to_compress list / элементы=string | Список типов содержимого, для которых применяется сжатие. Это значение должно быть допустимым типом MIME. |
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых конечная точка метаданных недоступна, например в частных облаках или Azure Stack. Процесс обнаружения экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому крайне важно убедиться в том, что настроенный узел центра является действительным и заслуживающим доверия. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
is_compression_enabled boolean | Указывает, включено ли сжатие содержимого в CDN. Варианты:
|
is_http_allowed boolean | Указывает, разрешен ли трафик HTTP для конечной точки. Варианты:
|
is_https_allowed boolean | Указывает, разрешен ли трафик HTTPS для конечной точки. Варианты:
|
location string | Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя конечной точки Azure CDN. |
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 в виде файлов. Также можно задать с помощью переменной среды |
origin_host_header string | Значение заголовка Host, отправляемое источнику с каждым запросом. |
origin_path string | Путь к каталогу источника, из которого CDN может получать содержимое. Например: contoso.cloudapp.net/originpath. |
origins list / элементы=dictionary | Набор источников содержимого, доставляемого через CDN. Обязательный параметр при создании. |
|
host_name string / обязательный |
Адрес источника. Это может быть доменное имя, адрес IPv4 или адрес IPv6. |
|
http_port integer |
Значение порта HTTP. Должно находиться в диапазоне от |
|
https_port integer |
Значение порта HTTPS. Должно находиться в диапазоне от |
|
name string / обязательный |
Имя источника. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации от имени пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
profile_name string / обязательный | Имя профиля CDN, к которому присоединена конечная точка. |
purge boolean | Используйте со значением state=present, чтобы очистить конечную точку. Варианты:
|
purge_content_paths list / элементы=string | Используйте со значениями state=present и purge=true, чтобы указать пути к содержимому для очистки. По умолчанию: |
query_string_caching_behavior string | Определяет способ кэширования CDN запросов, содержащих строки запроса. Варианты:
|
resource_group string / обязательный | Имя группы ресурсов, в которой существует или будет создана конечная точка Azure CDN. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
started boolean | Используйте со значением state=present, чтобы запустить конечную точку. Варианты:
|
state string | Задайте требуемое состояние конечной точки Azure CDN. Используйте Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар «строка:строка», назначаемых объекту в качестве метаданных. Метаданные тегов объекта будут обновлены с учетом всех предоставленных значений. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
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 a Azure CDN endpoint
azure_rm_cdnendpoint:
resource_group: myResourceGroup
profile_name: myProfile
name: myEndpoint
origins:
- name: TestOrig
host_name: "www.example.com"
tags:
testing: testing
delete: on-exit
foo: bar
- name: Delete a Azure CDN endpoint
azure_rm_cdnendpoint:
resource_group: myResourceGroup
profile_name: myProfile
name: myEndpoint
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
host_name string | Имя хоста конечной точки CDN. Возвращается: всегда Пример: |
id string | Идентификатор конечной точки CDN. Возвращается: всегда Пример: |
state string | Текущее состояние конечной точки Azure CDN. Возвращается: всегда |
Ссылки на коллекцию
© 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_cdnendpoint_module.html