azure_rm_webapp – Управление экземпляром веб-приложения.

Новая версия с 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.
app_settings -				Настройка параметров веб-приложения. Подпункты в формате ключ-значение.
app_state строка			Варианты: started ← stopped restarted	Запуск/остановка/перезапуск веб-приложения.
append_tags boolean			Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source - добавлено в 2.5			Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, используется переменная среды 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			Варианты: validate ignore	Управляет поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси HTTPS или работе с Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_affinity_enabled boolean			Варианты: no yes ←	True для включения клиентской аффинити; False для прекращения отправки куки аффинити сессии, которые направляют клиентские запросы в одной сессии на один и тот же экземпляр.
client_id -				Идентификатор клиента Azure. Используйте при аутентификации с главным объектом службы.
cloud_environment - добавлено в 2.4			Значение по умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
container_settings -				Настройки контейнера веб-приложения.
	name -			Имя контейнера. Например, "imagename:tag"
	registry_server_password -			Пароль сервера реестра контейнеров.
	registry_server_url -			URL-адрес сервера реестра контейнеров. Например, mydockerregistry.io
	registry_server_user -			Имя пользователя сервера реестра контейнеров.
deployment_source -				Источник развертывания для Git
	branch -			Имя ветки репозитория.
	url -			URL репозитория источника развертывания.
dns_registration boolean			Варианты: no yes	Если true, имя хоста веб-приложения не регистрируется в DNS при создании.
frameworks -				Набор настроек среды выполнения фреймворка. Каждая настройка — словарь. См. https://docs.microsoft.com/ru-ru/azure/app-service/app-service-web-overview для получения дополнительной информации.
	name -		Варианты: java net_framework php python ruby dotnetcore node	Имя фреймворка. Список поддерживаемых фреймворков для Windows веб-приложения и Linux веб-приложения различается. Для Windows веб-приложения поддерживаются имена (июнь 2018 г.): java, net_framework, php, python, node. Можно установить несколько фреймворков одновременно. Для Linux веб-приложения поддерживаются имена (июнь 2018 г.): java, ruby, php, dotnetcore, node. Можно установить только один фреймворк. Фреймворк Java взаимоисключающий с другими.
	settings -			Список настроек фреймворка.
		java_container -		Имя контейнера Java. Поддерживается только для определенных фреймворков `java` . Например, Tomcat, Jetty.
		java_container_version -		Версия контейнера Java. Поддерживается только для определенных фреймворков `java` . Для Tomcat, например, 8.0, 8.5, 9.0. Для Jetty, например, 9.1, 9.3.
	version -			Версия фреймворка. Для Linux веб-приложения поддерживаемые значения см. https://aka.ms/linux-stacks для получения дополнительной информации. Пример поддерживаемых значений net_framework: 'v4.0' для .NET 4.6 и 'v3.0' для .NET 3.5. Пример поддерживаемых значений php: 5.5, 5.6, 7.0. Пример поддерживаемых значений python: 5.5, 5.6, 7.0. Пример поддерживаемых значений node: 6.6, 6.9. Пример поддерживаемых значений dotnetcore: 1.0, 1.1, 1.2. Пример поддерживаемых значений ruby: 2.3. Пример поддерживаемых значений java: 1.8, 1.9 для Windows веб-приложений. 8 для Linux веб-приложений.
https_only boolean			Варианты: no yes	Настраивает веб-сайт для приема только запросов HTTPS.
location -				Расположение ресурса. Если не установлено, используется расположение из группы ресурсов по умолчанию.
name - / обязательно				Уникальное имя приложения для создания или обновления. Для создания или обновления слота развертывания используйте параметр {slot}.

password -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным сервисом.
plan -		План службы приложений. Требуется для создания. Может быть именем существующего плана службы приложений в той же группе ресурсов, что и веб-приложение. Может быть идентификатором ресурса существующего плана службы приложений. Пример: /subscriptions//resourceGroups//providers/Microsoft.Web/serverFarms/ Может быть словарем, содержащим `name`, `resource_group`, `sku`, `is_linux` и `number_of_workers`. `name`. Название плана службы приложений. `resource_group`. Имя группы ресурсов плана службы приложений. `sku`. SKU плана службы приложений. Для разрешенных SKU см. https://azure.microsoft.com/ru-ru/pricing/details/app-service/linux/. `is_linux`. Указывает ли это на план службы приложений Linux. Тип bool. По умолчанию False. `number_of_workers`. Количество рабочих процессов.
profile -		Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_app_settings boolean	Выборы: no yes	Очистить все существующие параметры приложения. Заменить параметры приложения веб-приложения параметрами app_settings.
resource_group - / обязательно		Имя группы ресурсов, к которой принадлежит ресурс.
scm_type -		Тип репозитория источника развертывания. Например, LocalGit, GitHub. Для получения дополнительной информации см. https://docs.microsoft.com/ru-ru/rest/api/appservice/webapps/createorupdate#scmtype.
secret -		Секрет клиента Azure. Используется при аутентификации с помощью главного сервиса.
skip_custom_domain_verification boolean	Выборы: no yes	Если true, связанные с веб-приложением пользовательские домены (не *.azurewebsites.net) не проверяются.
startup_file -		Файл запуска веб-приложения. Применяется только к веб-приложениям Linux.
state -	Выборы: absent present ←	Утверждение состояния веб-приложения. Используйте 'present' для создания или обновления веб-приложения и 'absent' для его удаления.
subscription_id -		Идентификатор вашей подписки Azure.
tags -		Словарь пар "строка:строка" для назначения метаданных объекту. Метаданные объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant -		Идентификатор Azure-аренды. Используется при аутентификации с главным сервисом.
ttl_in_seconds -		Время жизни в секундах для имени домена веб-приложения по умолчанию.

Примечания

Примечание

Для аутентификации в 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: Create a windows web app with non-exist app service plan
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mywinwebapp
    plan:
      resource_group: myappserviceplan_rg
      name: myappserviceplan
      is_linux: false
      sku: S1

- name: Create a docker web app with some app settings, with docker image
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mydockerwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
      is_linux: true
      sku: S1
      number_of_workers: 2
    app_settings:
      testkey: testvalue
      testkey2: testvalue2
    container_settings:
      name: ansible/ansible:ubuntu1404

- name: Create a docker web app with private acr registry
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mydockerwebapp
    plan: myappplan
    app_settings:
      testkey: testvalue
    container_settings:
      name: ansible/ubuntu1404
      registry_server_url: myregistry.io
      registry_server_user: user
      registry_server_password: pass

- name: Create a linux web app with Node 6.6 framework
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mylinuxwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "node"
        version: "6.6"

- name: Create a windows web app with node, php
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mywinwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "node"
        version: 6.6
      - name: "php"
        version: "7.0"

- name: Create a linux web app with java framework
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mylinuxwebapp
    plan:
      resource_group: appserviceplan_test
      name: myappplan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "java"
        version: "8"
        settings:
          java_container: "Tomcat"
          java_container_version: "8.5"

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

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

Ключ	Возвращаемое значение	Описание
azure_webapp словарь	всегда	Идентификатор текущего веб-приложения. Пример: {'id': '/subscriptions//resourceGroups/ansiblewebapp1/providers/Microsoft.Web/sites/ansiblewindowsaaa'}

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом 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_module.html