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

Новая версия с 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.
app_settings -				Настройка параметров приложения веб-приложения. Подварианты в формате пар ключ-значение.
app_state строка			Варианты: started ← stopped restarted	Запуск/остановка/перезапуск веб-приложения.
append_tags логическое			Варианты: 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			Варианты: ignore validate	Управляет поведением проверки сертификатов для Azure-эндпоинтов. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно установить через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_affinity_enabled логическое			Варианты: no yes ←	Истина для включения клиентской аффинити; Ложь для отключения отправки cookie-файлов сессионной аффинити, которые направляют запросы клиента в одной сессии на один и тот же экземпляр.
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 логическое			Варианты: 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 логическое			Варианты: no yes	Настройка веб-сайта для принятия только HTTPS-запросов.
location -				Расположение ресурса. Если не задано, расположение из группы ресурсов будет использоваться по умолчанию.
name - / обязательно				Уникальное имя приложения для создания или обновления. Для создания или обновления слота развертывания используйте параметр {slot}.

пароль -		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
план -		План службы приложений. Требуется для создания. Это может быть имя существующего плана службы приложений в той же группе ресурсов, что и веб-приложение. Это может быть идентификатор ресурса существующего плана службы приложений. Например, /subscriptions/<subs_id>/resourceGroups/<resource_group>/providers/Microsoft.Web/serverFarms/<plan_name> Это может быть словарь, который содержит `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`. Количество рабочих процессов.
профиль строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_app_settings булево	Варианты: нет да	Очистить все существующие параметры приложения. Заменить параметры приложения веб-приложения параметрами app_settings.
группа_ресурсов - / обязательно		Имя группы ресурсов, к которой относится ресурс.
scm_type -		Тип репозитория источника развертывания. Например, LocalGit, GitHub. Дополнительную информацию см. по адресу https://docs.microsoft.com/ru-ru/rest/api/appservice/webapps/createorupdate#scmtype.
секрет строка		Секрет Azure клиента. Используется при аутентификации с принципалом службы.
skip_custom_domain_verification булево	Варианты: нет да	Если значение true, пользовательские (не *.azurewebsites.net) домены, связанные с веб-приложением, не проверяются.
startup_file -		Файл запуска веб-приложения. Это применимо только для веб-приложений Linux.
состояние -	Варианты: отсутствует наличие ←	Утвердить состояние веб-приложения. Используйте `present` для создания или обновления веб-приложения и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
метки словарь		Словарь пар строка:строка для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
аренда строка		Идентификатор аренды Azure. Используется при аутентификации с принципалом службы.
ttl_in_seconds -		Время существования в секундах для имени домена по умолчанию веб-приложения.

Примечания

Примечание

Для аутентификации с 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: 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 stage deployment slot for an existing web app
  azure_rm_webapp:
    resource_group: myresourcegroup
    name: mywebapp/slots/stage
    plan:
      resource_group: myresourcegroup
      name: myappplan
    app_settings:
      testkey:testvalue

- 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/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/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.8/modules/azure_rm_webapp_module.html