community.azure.azure_rm_cdnprofile_info – Получение сведений о профилях Azure CDN

Примечание

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

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

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

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

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

Получение данных о конкретном профиле Azure CDN или всех профилей 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` могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется по умолчанию подписка az 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 строка		Ограничение результатов конкретным профилем CDN.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не служебного принципала.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
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 one CDN profile
  community.azure.azure_rm_cdnprofile_info:
    name: Testing
    resource_group: myResourceGroup

- name: Get facts for all CDN profiles
  community.azure.azure_rm_cdnprofile_info:

- name: Get facts by tags
  community.azure.azure_rm_cdnprofile_info:
    tags:
      - Environment:Test

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

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

Ключ		Возвращаемое значение	Описание
cdnprofiles сложный		всегда	Список профилей CDN.
	id строка	успех	Идентификатор профиля CDN. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myCDN
	location строка	успех	Расположение профиля CDN. Пример: WestUS
	name строка	всегда	Имя профиля CDN. Пример: Testing
	provisioning_state строка	успех	Статус подготовки профиля. Пример: Succeeded
	resource_group строка	всегда	Имя группы ресурсов, в которой существует профиль CDN. Пример: myResourceGroup
	resource_state строка	успех	Статус ресурса профиля. Пример: Active
	sku строка	успех	Тарифный план, определяет поставщика CDN, список функций и скорость профиля CDN. Пример: standard_verizon
	tags список / элементы=строка	успех	Теги профиля CDN. Пример: [{'foo': 'bar'}]
	type строка	успех	Тип профиля CDN. Пример: Microsoft.Cdn/profiles

Авторы

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_cdnprofile_info_module.html