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

Примечание

Этот плагин входит в состав коллекции community.azure (версия 1.0.0).

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

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

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

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

Получение фактов для конкретной конечной точки 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` могут быть использованы для определения идентификатора подписки, если их несколько; в противном случае используется по умолчанию подписка Azure 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
  community.azure.azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

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

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

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

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

Авторы

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

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