azure.azcollection.azure_rm_cdnendpoint_info – Получение фактов о точке Azure CDN

Примечание

Этот плагин является частью коллекции azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Для использования в книге задач укажите: azure.azcollection.azure_rm_cdnendpoint_info.

Добавлено в версии 0.1.2: коллекции azure.azcollection

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

Обзор

Получение фактов о конкретной точке Azure CDN или всех точках Azure CDN.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в 0.0.1 коллекции azure.azcollection		URL-адрес авторизации Azure AD. Используется при аутентификации с помощью имени пользователя/пароля и собственной службой ADFS авторизации.
api_profile строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "latest"	Выбирает профиль API для использования при общении с Azure-сервисами. Значение по умолчанию `latest` подходит для публичных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлено в 0.0.1 коллекции azure.azcollection	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задано через переменную среды `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.
cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 коллекции azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от публичного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки доступа для обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name строка		Ограничение результатов до конкретной точки доступа Azure CDN.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
profile_name строка / обязательно		Имя профиля CDN.
resource_group строка / обязательно		Имя группы ресурсов, к которой принадлежит этот профиль CDN.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципалом службы.
subscription_id строка		Ваш идентификатор подписки Azure.
tags строка		Ограничение результатов путем предоставления списка тегов. Формат тегов 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-арендатора. Используется при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или книги задач с помощью az login.
Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
Для аутентификации через принципала службы передайте 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 endpoints in CDN profile
  azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific CDN endpoint
  azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile
    name: myEndpoint1

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

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

Ключ		Возвращаемое значение	Описание
cdnendpoints сложный		всегда	Список Azure CDN конечных точек.
	content_types_to_compress список / элементы=строка	успешно	Список типов содержимого, к которому применяется сжатие. Пример: ['text/plain', 'text/html', 'text/css', 'text/javascript', 'application/x-javascript', 'application/javascript', 'application/json', 'application/xml']
	id строка	успешно	Идентификатор конечной точки Azure CDN. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myCDN/providers/Microsoft.Cdn/profiles/myProfile/endpoints/myEndpoint1
	is_compression_enabled булево	успешно	Указывает, включено ли сжатие содержимого в CDN. Пример: True
	is_http_allowed булево	успешно	Указывает, разрешен ли HTTP-трафик на конечной точке. Пример: True
	is_https_allowed булево	успешно	Указывает, разрешен ли HTTPS-трафик на конечной точке. Пример: True
	location строка	успешно	Расположение конечной точки Azure CDN. Пример: WestUS
	name строка	всегда	Имя конечной точки Azure CDN. Пример: myEndpoint
	origin_host_header строка	успешно	Значение заголовка хоста, отправляемого источнику с каждым запросом. Пример: xxxxxxxx.blob.core.windows.net
	origin_path строка	успешно	Путь к каталогу в источнике, который CDN может использовать для получения содержимого. Пример: /pic/
	origins строка	успешно	Источник содержимого, предоставляемого через CDN. Пример: {'host_name': 'xxxxxxxx.blob.core.windows.net', 'http_port': None, 'https_port': None, 'name': 'xxxxxxxx-blob-core-windows-net'}
	profile_name строка	всегда	Имя профиля Azure CDN, к которому прикреплена эта конечная точка. Пример: myProfile
	provisioning_state строка	успешно	Статус подготовки конечной точки Azure CDN. Пример: Выполнено
	query_string_caching_behavior строка	успешно	Определяет, как CDN кеширует запросы, содержащие строки запроса. Пример: IgnoreQueryString
	resource_group строка	всегда	Имя группы ресурсов, в которой существует конечная точка Azure CDN. Пример: myResourceGroup
	resource_state строка	успешно	Статус ресурса профиля. Пример: Работает
	tags список / элементы=строка	успешно	Теги конечной точки Azure CDN. Пример: foo

Авторы

Hai Cao (@caohai)
Yunge zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_cdnendpoint_info_module.html