Spec-Zone.ru › Ansible 2.10

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

Примечание

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

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

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

Новое в версии 0.1.2: of 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 of azure.azcollection
URL авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной авторизацией ADFS.
api_profile
строка
добавлено в 0.0.1 of azure.azcollection
Значение по умолчанию:
"latest"
Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
auth_source
строка
добавлено в 0.0.1 of 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 of azure.azcollection
    Варианты:
  • ignore
  • validate
Управляет поведением проверки сертификатов для конечных точек Azure. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack, может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.
client_id
строка
Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.
cloud_environment
строка
добавлено в 0.0.1 of 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

Значения возврата

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

END_OF_DOCUMENT_MARKER
Ключ Возвращаемое значение Описание
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/azure/azcollection/azure_rm_cdnendpoint_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API