community.azure.azure_rm_webapp_info – Получение сведений о веб-приложении Azure

Примечание

Этот плагин является частью коллекции community.azure (версия 1.0.0).

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

Для использования в playbook укажите: community.azure.azure_rm_webapp_info.

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

Описание

Получение сведений о конкретном веб-приложении или всех веб-приложениях в группе ресурсов, или всех веб-приложениях в текущей подписке.

Требования

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

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` может использоваться для указания идентификатора подписки, если их несколько; в противном случае используется стандартная подписка Azure 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 строка		Показать результаты только для конкретного веб-приложения.
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
  community.azure.azure_rm_webapp_info:
    resource_group: myResourceGroup
    name: winwebapp1

- name: Get facts for web apps in resource group
  community.azure.azure_rm_webapp_info:
    resource_group: myResourceGroup

- name: Get facts for web apps with tags
  community.azure.azure_rm_webapp_info:
    tags:
      - testtag
      - foo:bar

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

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

Ключ		Возвращаемое значение	Описание
webapps сложный		всегда	Список веб-приложений.
	app_settings словарь	всегда	Настройки приложения. Возвращаются только если у веб-приложения есть настройки. Пример: {'testkey': 'testvalue', 'testkey2': 'testvalue2'}
	availability_state строка	всегда	Доступность этого веб-приложения. Пример: Нормальная
	default_host_name строка	всегда	Имя хоста веб-приложения. Пример: vxxisurg397winapp4.azurewebsites.net
	enabled логическое	всегда	Указывает, включено ли веб-приложение. Пример: True
	enabled_host_names список / элементы=строка	всегда	Включенные имена хостов веб-приложения. Пример: ['vxxisurg397winapp4.azurewebsites.net', 'vxxisurg397winapp4.scm.azurewebsites.net']
	frameworks список / элементы=строка	всегда	Фреймворки приложения. Возвращаются только если у веб-приложения есть фреймворки. Пример: [{'name': 'net_framework', 'version': 'v4.0'}, {'name': 'java', 'settings': {'java_container': 'tomcat', 'java_container_version': '8.5'}, 'version': '1.7'}, {'name': 'php', 'version': '5.6'}]
	ftp_publish_url строка	всегда	URL публикации веб-приложения при типе развертывания FTP. Пример: ftp://xxxx.ftp.azurewebsites.windows.net
	host_name_ssl_states список / элементы=строка	всегда	Состояние SSL по именам хостов веб-приложения. Пример: [{'hostType': 'Стандартный', 'name': 'vxxisurg397winapp4.azurewebsites.net', 'sslState': 'Выключен'}, {'hostType': 'Репозиторий', 'name': 'vxxisurg397winapp4.scm.azurewebsites.net', 'sslState': 'Выключен'}]
	host_names список / элементы=строка	всегда	Имена хостов веб-приложения. Пример: ['vxxisurg397winapp4.azurewebsites.net']
	id строка	всегда	Идентификатор веб-приложения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp
	location строка	всегда	Расположение веб-приложения. Пример: eastus
	name строка	всегда	Имя веб-приложения. Пример: winwebapp1
	outbound_ip_addresses строка	всегда	Внешний IP-адрес веб-приложения. Пример: 40.71.11.131,40.85.166.200,168.62.166.67,137.135.126.248,137.135.121.45
	plan строка	всегда	Идентификатор плана службы приложений, используемого веб-приложением. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myAppServicePlan
	publishing_password строка	только при return_publish_profile=True.	Пароль профиля публикации. Пример: uvANsPQpGjWJmrFfm4Ssd5rpBSqGhjMk11pMSgW2vCsQtNx9tcgZ0xN26s9A
	publishing_username строка	только при return_publish_profile=True.	Имя пользователя профиля публикации. Пример: $vxxisuRG397winapp4
	resource_group строка	всегда	Группа ресурсов веб-приложения. Пример: myResourceGroup
	state строка	всегда	Состояние веб-приложения. Пример: запущен
	tags словарь	всегда	Теги, назначенные ресурсу. Словарь пар строка:строка. Пример: {'tag1': 'abc'}

Авторы

Yunge Zhu (@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/azure/azure_rm_webapp_info_module.html