azure.azcollection.azure_rm_cdnprofile_info – Получение фактов о профиле Azure CDN
Примечание
Этот плагин входит в состав коллекции azure.azcollection (версия 1.3.1).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_cdnprofile_info.
Новое в версии 0.1.2: из azure.azcollection
Описание
- Получить факты о конкретном профиле Azure CDN или всех профилях 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через 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 azure.azcollection |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задан через профиль файла учетных данных или AZURE_CERT_VALIDATION переменной среды. |
| client_id строка | ID клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| cloud_environment строка добавлен в 0.0.1 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
azure_rm_cdnprofile_info:
name: Testing
resource_group: myResourceGroup
- name: Get facts for all CDN profiles
azure_rm_cdnprofile_info:
- name: Get facts by tags
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/azure/azcollection/azure_rm_cdnprofile_info_module.html