Модуль azure.azcollection.azure_rm_cdnendpoint_info – Получение фактов о точке конечного доступа Azure CDN
Примечание
Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: azure.azcollection.azure_rm_cdnendpoint_info.
Новинка в azure.azcollection 0.1.2
Описание
- Получение фактов о конкретной точке конечного доступа Azure CDN или всех точках конечного доступа 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 added in azure.azcollection 0.0.1 | URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете свой собственный узел ADFS. |
api_profile string added in azure.azcollection 0.0.1 | Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию Default: |
auth_source string added in azure.azcollection 0.0.1 | Управляет источником учетных данных, используемых для аутентификации. Также может быть установлен через переменную среды При установке в При установке в При установке в При установке в При установке в Параметр Варианты:
|
cert_validation_mode string added in azure.azcollection 0.0.1 | Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды |
cloud_environment string added in azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, Default: |
disable_instance_discovery boolean added in azure.azcollection 2.3.0 | Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных авторизации из https://login.microsoft.com/ для проверки авторизации. Установив это значение в **True**, проверка авторизации отключается. В результате важно убедиться, что настроенный узел авторизации является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды Варианты:
|
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string | Ограничивает результаты до определенной конечной точки Azure CDN. |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным субъектом безопасности. |
profile string | Профиль безопасности, найденный в файле ~/.azure/credentials. |
profile_name string / required | Имя профиля CDN. |
resource_group string / required | Имя группы ресурсов, к которой принадлежит этот профиль CDN. |
secret string | Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности. |
subscription_id string | Ваш идентификатор подписки Azure. |
tags list / elements=string | Ограничить результаты, указав список тегов. Формат тегов: ‘ключ’ или ‘ключ:значение’. |
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.
- Для аутентификации через сервисный принципал, передайте 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
tags:
- key
- key:value
- 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 список / элементы=строка |
Список типов содержимого, к которому применяется сжатие. Возвращается: успешно Пример: |
|
id строка |
Идентификатор конечной точки Azure CDN. Возвращается: успешно Пример: |
|
is_compression_enabled булево |
Указывает, включено ли сжатие содержимого в CDN. Возвращается: успешно Пример: |
|
is_http_allowed булево |
Указывает, разрешен ли HTTP-трафик для конечной точки. Возвращается: успешно Пример: |
|
is_https_allowed булево |
Указывает, разрешен ли HTTPS-трафик для конечной точки. Возвращается: успешно Пример: |
|
location строка |
Расположение конечной точки Azure CDN. Возвращается: успешно Пример: |
|
name строка |
Имя конечной точки Azure CDN. Возвращается: всегда Пример: |
|
origin_host_header строка |
Значение заголовка хоста, отправляемое источнику с каждым запросом. Возвращается: успешно Пример: |
|
origin_path строка |
Путь к каталогу в источнике, который CDN может использовать для получения содержимого. Возвращается: успешно Пример: |
|
origins словарь |
Источник содержимого, предоставляемого через CDN. Возвращается: успешно Пример: |
|
profile_name строка |
Имя профиля Azure CDN, к которому прикреплена эта конечная точка. Возвращается: всегда Пример: |
|
provisioning_state строка |
Статус подготовки конечной точки Azure CDN. Возвращается: успешно Пример: |
|
query_string_caching_behavior строка |
Определяет, как CDN кэширует запросы, содержащие строки запроса. Возвращается: успешно Пример: |
|
resource_group строка |
Имя группы ресурсов, в которой существует конечная точка Azure CDN. Возвращается: всегда Пример: |
|
resource_state строка |
Статус ресурса профиля. Возвращается: успешно Пример: |
|
Теги список / элементы=строка |
Теги конечной точки Azure CDN. Возвращаемое значение: успешно Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_cdnendpoint_info_module.html