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 ←	Определяет, следует ли отправлять куки сеанса сродства клиента, которые направляют запросы клиента в рамках одного сеанса на один и тот же экземпляр.
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	Указывает, регистрируется ли имя хоста веб-приложения в DNS при создании. Установите значение `false` для регистрации.
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 поддерживают `java`, `net_framework`, `php`, `python`, и `node` начиная с июня 2018 г. Веб-приложения Windows поддерживают несколько фреймворков одновременно. Веб-приложения Linux поддерживают `java`, `ruby`, `php`, `dotnetcore`, и `node` начиная с июня 2018 г. Веб-приложения Linux поддерживают только один фреймворк. Фреймворк Java взаимоисключает другие.
	settings -			Список настроек фреймворка.
		java_container -		Имя контейнера Java. Поддерживается только при frameworks=java. Примеры значений `Tomcat`, `Jetty`.
		java_container_version -		Версия контейнера Java. Поддерживается только при frameworks=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.9` для Windows веб-приложений. `1.8` для Linux веб-приложений.

https_only boolean	Варианты: нет да	Настраивает веб-сайт для приема только запросов https.
location -		Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
name - / обязательно		Уникальное имя приложения для создания или обновления. Для создания или обновления узла развертывания используйте параметр {slot}.
password строка		Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
plan -		План службы приложений. Требуется для создания. Может быть именем существующего плана службы приложений в той же группе ресурсов, что и веб-приложение. Может быть идентификатором ресурса существующего плана службы приложений. Например, /subscriptions//resourceGroups//providers/Microsoft.Web/serverFarms/. Может быть словарем, содержащим пять параметров, определенных ниже. `name`, имя плана службы приложений. `resource_group`, группа ресурсов плана службы приложений. `sku`, SKU плана службы приложений, разрешённые значения перечислены на https://azure.microsoft.com/ru-ru/pricing/details/app-service/linux/. `is_linux`, является ли план службы приложений Linux. По умолчанию `False`. `number_of_workers`, количество рабочих процессов для плана службы приложений.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_app_settings boolean	Варианты: нет да	Очистить все существующие параметры приложения. Заменить параметры приложения веб-приложения на 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	Варианты: нет да	Пропустить ли проверку настраиваемых (не *.azurewebsites.net) доменов, связанных с веб-приложением. Установите в `true` для пропуска.
startup_file -		Файл запуска веб-приложения. Используется только для веб-приложений Linux.
state -	Варианты: absent present ←	Состояние веб-приложения. Используйте `present` для создания или обновления веб-приложения и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
tags словарь		Словарь пар «строка:строка», которые будут назначены в качестве метаданных к объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant строка		Идентификатор 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: myAppServicePlan_rg
      name: myAppServicePlan
      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: myAppServicePlan
    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: myAppServicePlan_rg
      name: myAppServicePlan
    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: myAppServicePlan_rg
      name: myAppServicePlan
    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: myAppServicePlan_rg
      name: myAppServicePlan
    app_settings:
      testkey:testvalue

- name: Create a linux web app with java framework
  azure_rm_webapp:
    resource_group: myResourceGroup
    name: myLinuxWebapp
    plan:
      resource_group: myAppServicePlan_rg
      name: myAppServicePlan
    app_settings:
      testkey: testvalue
    frameworks:
      - name: "java"
        version: "8"
        settings:
          java_container: "Tomcat"
          java_container_version: "8.5"

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

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

Ключ	Возвращаемое значение	Описание
azure_webapp строка	всегда	Идентификатор текущего веб-приложения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp

Статус

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