azure_rm_webapp_facts – Получение фактов о веб-приложении Azure
Новая версия с 2.7.
Обзор
- Получение фактов о конкретном веб-приложении или всех веб-приложениях в группе ресурсов, или всех веб-приложениях в текущей подписке.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- azure >= 2.0.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ad_user строка | Имя пользователя Active Directory. Используйте при аутентификации пользователем Active Directory, а не служебным принципалом. | |
| adfs_authority_url строка добавлен в 2.6 | 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 - | Ограничить результаты по группе ресурсов. | |
| return_publish_profile логическое значение |
| Указывает, следует ли возвращать профиль публикации веб-приложения. |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с помощью служебного принципала. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tags - | Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'. | |
| tenant строка | Идентификатор клиента Azure. Используйте при аутентификации с помощью служебного принципала. |
Примечания
Примечание
- Для аутентификации в Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед запуском задач или playbook с помощью
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 web app by name
azure_rm_webapp_facts:
resource_group: myResourceGroup
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_facts:
resource_group: myResourceGroup
- name: Get facts for web apps with tags
azure_rm_webapp_facts:
tags:
- testtag
- foo:bar
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| webapps сложный | всегда | Список веб-приложений. | |
| app_settings сложный | Настройки приложения. Возвращаются только тогда, когда веб-приложение имеет настройки. | ||
| availability_state строка | Доступность этого веб-приложения. | ||
| default_host_name строка | Имя хоста веб-приложения. | ||
| enabled булево | Указывает, включено ли веб-приложение. | ||
| enabled_host_names список | Включенные имена хостов веб-приложения. | ||
| frameworks сложный | Фреймворки приложения. Возвращаются только тогда, когда веб-приложение имеет фреймворки. | ||
| ftp_publish_url строка | URL публикации веб-приложения, когда тип развертывания - FTP. Пример: ftp://xxxx.ftp.azurewebsites.windows.net | ||
| host_name_ssl_states список | Состояние SSL по именам хостов веб-приложения. | ||
| host_names список | Имена хостов веб-приложения. | ||
| id строка | всегда | Идентификатор веб-приложения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/xx | |
| location строка | всегда | Расположение веб-приложения. | |
| name строка | всегда | Имя веб-приложения. | |
| outbound_ip_addresses строка | Внешний IP-адрес веб-приложения. | ||
| plan строка | всегда | Идентификатор плана службы приложений, используемого веб-приложением. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/xxx | |
| publishing_password строка | только когда return_publish_profile равно True. | Пароль профиля публикации. | |
| publishing_username строка | только когда return_publish_profile равно True. | Имя пользователя профиля публикации. | |
| resource_group строка | всегда | Группа ресурсов веб-приложения. Пример: myResourceGroup | |
| state строка | Состояние веб-приложения (например, запущен). | ||
| tags словарь | Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'} | ||
Статус
- Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/azure_rm_webapp_facts_module.html
