azure.azcollection.azure_rm_functionapp_info – Получение фактов о приложении Azure Function

Примечание

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

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

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

Добавлено в версии 0.1.2: сборки azure.azcollection

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

Обзор

Получение фактов об одном приложении Azure Function или всех приложениях Function в группе ресурсов.

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

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	Варианты: 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 azure.azcollection	Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка		Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection	По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечного доступа для обнаружения метаданных (требуется для Azure Stack). Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
name строка		Показывать результаты только для конкретного приложения Function.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group строка		Ограничить результаты группой ресурсов. Требуется при фильтрации по имени. псевдонимы: resource_group_name
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 Function App
  azure_rm_functionapp_info:
    resource_group: myResourceGroup
    name: myfunctionapp

- name: Get facts for all Function Apps in a resource group
  azure_rm_functionapp_info:
    resource_group: myResourceGroup

- name: Get facts for all Function Apps by tags
  azure_rm_functionapp_info:
    tags:
      - testing

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

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

Ключ	Возвращаемое значение	Описание
azure_functionapps список / элементы=строка	всегда	Список словарей приложений Azure Function. Пример: {'состояние_доступности': 'Нормальное', 'client_affinity_enabled': True, 'client_cert_enabled': False, 'размер_контейнера': 1536, 'суточная_квота_памяти_времени': 0, 'имя_хоста_по_умолчанию': 'myfunctionapp.azurewebsites.net', 'включено': True, 'включенные_имена_хостов': ['myfunctionapp.azurewebsites.net', 'myfunctionapp.scm.azurewebsites.net'], 'состояния_ssl_имен_хостов': [{'тип_хоста': 'Стандартный', 'имя': 'myfunctionapp.azurewebsites.net', 'состояние_ssl': 'Отключено'}, {'тип_хоста': 'Репозиторий', 'имя': 'myfunctionapp.scm.azurewebsites.net', 'состояние_ssl': 'Отключено'}], 'имена_хостов': ['myfunctionapp.azurewebsites.net'], 'отключенные_имена_хостов': False, 'id': '/subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/sites/myfunctionapp', 'вид': 'functionapp', 'время_последнего_изменения_utc': '2017-08-22T18:54:01.190Z', 'местоположение': 'Восточные США', 'имя': 'myfunctionapp', 'внешние_ip_адреса': '............', 'имя_сайта_репозитория': 'myfunctionapp', 'зарезервировано': False, 'группа_ресурсов': 'myResourceGroup', 'scm_сайт_также_остановлен': False, 'идентификатор_серверной_фермы': '/subscriptions/.../resourceGroups/ansible-rg/providers/Microsoft.Web/serverfarms/EastUSPlan', 'состояние': 'Запущено', 'тип': 'Microsoft.Web/sites', 'состояние_использования': 'Нормальное'}

Авторы

Thomas Stringer (@trstringer)

© 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_functionapp_info_module.html