azure_rm_functionapp_facts – Получение фактов о приложении Azure Function
Новая версия 2.4.
Обзор
- Получение фактов для одного приложения Azure Function или всех приложений Function в группе ресурсов
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user - | Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| adfs_authority_url - добавлен в 2.6 | По умолчанию: null | URL-адрес авторизации Azure AD. Используется при аутентификации с именем пользователя/паролем и собственной службой ADFS. |
| api_profile - добавлен в 2.5 | По умолчанию: "latest" | Выбирает профиль API для взаимодействия с Azure-сервисами. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. |
| auth_source - добавлен в 2.5 |
| Определяет источник учетных данных для аутентификации. Если не указано, будет использоваться переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию будет auto если переменная не определена.auto будет следовать стандартному приоритету параметров модуля -> переменных среды -> профиля по умолчанию в файле учетных данных ~/.azure/credentials. При значении cli, учетные данные берутся из профиля Azure CLI по умолчанию.Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении msi, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. |
| cert_validation_mode - добавлен в 2.5 |
| Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. |
| client_id - | Идентификатор клиента Azure. Используется при аутентификации с помощью службы-принципала. | |
| cloud_environment - добавлен в 2.4 | По умолчанию: "AzureCloud" | Для облачных сред, отличных от общедоступного облака США, используется имя среды (как определено в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды AZURE_CLOUD_ENVIRONMENT. |
| name - | Показывать результаты только для определенного приложения функций. | |
| password - | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала. | |
| profile - | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group - | Ограничить результаты определенной группой ресурсов. Требуется при фильтрации по имени. псевдонимы: resource_group_name | |
| secret - | Секрет клиента Azure. Используется при аутентификации с помощью службы-принципала. | |
| subscription_id - | Ваш идентификатор подписки Azure. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов — 'ключ' или 'ключ:значение'. |
| арендатор - | Идентификатор аренды 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 Function Apps |
Статус
- Для этого модуля не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/azure_rm_functionapp_facts_module.html
