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 сложный		всегда	Список 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/community/azure/azure_rm_cdnendpoint_info_module.html