azure_rm_cdnendpoint_facts – Получение фактов о конечных точках CDN Azure

Новое в версии 2.8.

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

Обзор

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

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ad_user строка		Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 2.6		URL-адрес полномочий Azure AD. Используется при аутентификации с именем пользователя/паролем и наличии собственного центра полномочий ADFS.
api_profile строка добавлен в 2.5	По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source строка добавлен в 2.5	Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных `~/.azure/credentials`. При установке в `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задано через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` может быть использована для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-конечных точек. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси-сервера HTTPS или подключения к Azure Stack, возможно, потребуется отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment строка добавлен в 2.4	По умолчанию: "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, или войти в систему перед выполнением задач или playbook с помощью 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_facts:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific CDN endpoint
  azure_rm_cdnendpoint_facts:
    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 строка		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 кеширует запросы, содержащие строки запроса. Пример: ИгнорироватьСтрокуЗапроса
	resource_group строка	всегда	Имя группы ресурсов, в которой находится конечная точка Azure CDN. Пример: myResourceGroup
	resource_state строка		Статус ресурса профиля. Пример: Запущен
	tags список		Теги конечной точки Azure CDN. Пример: foo

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [бета]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.8/modules/azure_rm_cdnendpoint_facts_module.html