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 | Значение по умолчанию: 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 - | Ограничить результаты по группе ресурсов. | |
| return_publish_profile boolean |
| Указать, следует ли возвращать профиль публикации веб-приложения. |
| secret - | Секрет клиента Azure. Используется при аутентификации с помощью служебного принципала. | |
| subscription_id - | Ваш идентификатор подписки Azure. | |
| tags - | Ограничить результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'. | |
| tenant - | Идентификатор 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 web app by name
azure_rm_webapp_facts:
resource_group: testrg
name: winwebapp1
- name: Get facts for web apps in resource group
azure_rm_webapp_facts:
resource_group: testrg
- name: Get facts for web apps with tags
azure_rm_webapp_facts:
tags:
- testtag
- foo:bar
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| webapps complex | всегда | Список веб-приложений. | |
| app_settings complex | Настройки приложения. Возвращаются только если у веб-приложения есть настройки. | ||
| availability_state string | Доступность этого веб-приложения. | ||
| default_host_name string | Имя хоста веб-приложения. | ||
| enabled boolean | Указывает, включено ли веб-приложение. | ||
| enabled_host_names list | Включенные имена хостов веб-приложения. | ||
| frameworks complex | Фреймворки приложения. Возвращаются только если у веб-приложения есть фреймворки. | ||
| host_name_ssl_states list | Состояние SSL по именам хостов веб-приложения. | ||
| host_names list | Имена хостов веб-приложения. | ||
| id string | всегда | Идентификатор веб-приложения. Пример: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/sites/xx | |
| location string | всегда | Расположение веб-приложения. | |
| name string | всегда | Название веб-приложения. | |
| outbound_ip_addresses string | Внешний IP-адрес веб-приложения. | ||
| plan string | всегда | Идентификатор плана службы приложений, используемого веб-приложением. Пример: /subscriptions/xxxx/resourceGroups/xxx/providers/Microsoft.Web/serverfarms/xxx | |
| publishing_password string | только если return_publish_profile равно True. | Пароль профиля публикации. | |
| publishing_username string | только если return_publish_profile равно True. | Имя пользователя профиля публикации. | |
| resource_group string | всегда | Группа ресурсов веб-приложения. | |
| state string | Состояние веб-приложения, например, работающее. | ||
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается сообществом 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.7/modules/azure_rm_webapp_facts_module.html
