azure_rm_functionapp_facts - Получение фактов о приложении Azure Functions
Новое в версии 2.4.
Обзор
- Получение фактов для одного приложения Azure Functions или всех приложений Functions в группе ресурсов
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user | По умолчанию: None | Имя пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
| api_profile (добавлен в 2.5) |
| Выбирает профиль API для взаимодействия с Azure-службами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. |
| auth_source (добавлен в 2.5) |
| Управляет источником учетных данных для аутентификации. auto будет следовать по умолчанию приоритету параметров модуля -> переменные среды -> профиль по умолчанию в файле учетных данных ~/.azure/credentials.При значении cli, учетные данные будут взяты из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. |
| cert_validation_mode (добавлен в 2.5) |
None | Управляет поведением проверки сертификатов для Azure-точек доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключения к Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id | По умолчанию: None | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| cloud_environment (добавлен в 2.4) | По умолчанию: AzureCloud | Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment), или URL конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name | По умолчанию: None | Показать результаты только для определенного приложения Functions |
| password | По умолчанию: None | Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не службы-принципала. |
| profile | По умолчанию: None | Профиль безопасности, найденный в файле ~/.azure/credentials. |
| resource_group | По умолчанию: None | Ограничить результаты группой ресурсов. Требуется при фильтрации по имени алиасы: resource_group_name |
| secret | По умолчанию: None | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. |
| subscription_id | По умолчанию: None | Ваш идентификатор подписки Azure. |
| tags | По умолчанию: None | Ограничить результаты, указав список тегов. Формат тегов 'ключ' или 'ключ:значение'. |
| tenant | По умолчанию: None | Идентификатор арендатора Azure. Используется при аутентификации с помощью службы-принципала. |
Примечания
Примечание
- Для аутентификации с Azure можно передать параметры, установить переменные среды или использовать профиль, сохраненный в ~/.azure/credentials. Аутентификация возможна с помощью службы-принципала или пользователя 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 в среде.
Примеры
- name: Get facts for one Function App
azure_rm_functionapp_facts:
resource_group: ansible-rg
name: myfunctionapp
- name: Get facts for all Function Apps in a resource group
azure_rm_functionapp_facts:
resource_group: ansible-rg
- name: Get facts for all Function Apps by tags
azure_rm_functionapp_facts:
tags:
- testing
Значения возврата
Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| azure_functionapps список | всегда | Список словарей приложений Azure Functions |
Статус
Этот модуль помечен как бета, что означает, что его интерфейс не гарантируется как обратная совместимость.
Автор
- Thomas Stringer (@tstringer)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_functionapp_facts_module.html
