Spec-Zone.ru › Ansible 2.11

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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

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

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

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

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

Обзор

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

Требования

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

  • 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
строка
Отображать результаты только для определенного веб-приложения.
password
строка
Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile
строка
Профиль безопасности, найденный в файле ~/.azure/credentials.
resource_group
строка
Ограничение результатов по группе ресурсов.
return_publish_profile
логическое
    Варианты:
  • нет ←
  • да
Указать, нужно ли вернуть профиль публикации веб-приложения.
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 web app by name
  azure_rm_webapp_info:
    resource_group: myResourceGroup
    name: winwebapp1

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

- name: Get facts for web apps with tags
  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/azure/azcollection/azure_rm_webapp_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API