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

Примечание

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

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

Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_webapp.

Новое в версии 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.
app_settings строка				Настройка параметров веб-приложения. Подварианты в формате пар ключ-значение.
app_state строка			Варианты: started ← stopped restarted	Запуск/остановка/перезапуск веб-приложения.
append_tags булево			Варианты: no yes ←	Управляет тем, является ли поле тегов каноническим или оно просто добавляется к существующим тегам. При каноническом формате любые теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.
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_affinity_enabled булево			Варианты: no yes ←	Указывает, следует ли отправлять cookie сессии с аффинитетом клиента, которые направляют запросы клиента в той же сессии на тот же экземпляр.
client_id строка				Идентификатор клиента Azure. Используйте при аутентификации с главным объектом службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки конечного доступа для обнаружения метаданных (необходим для Azure Stack). Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
container_settings строка				Параметры контейнера веб-приложения.
	name строка			Имя контейнера, например, `imagename:tag`. Для создания многоконтейнерного приложения имя должно быть 'COMPOSE\|' или 'KUBE\|' с последующей кодировкой конфигурации в base64.
	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 булево			Варианты: no yes	Настраивает веб-сайт для приема только запросов HTTPS.
location строка				Расположение ресурса. Если не задано, расположение из группы ресурсов используется по умолчанию.
name строка / обязательно				Уникальное имя приложения для создания или обновления. Для создания или обновления слота развертывания используйте параметр {slot}.
password строка				Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с главным объектом службы.

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

Примечания

Примечание

Для аутентификации с 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: 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 multi-container web app
  azure_rm_webapp:
    resource_group: myResourceGroup
    name: myMultiContainerWebapp
    plan: myAppServicePlan
    app_settings:
      testkey: testvalue
    container_settings:
      name: "COMPOSE|{{ lookup('file', 'docker-compose.yml') | b64encode }}"

- 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 string	всегда	Идентификатор текущего веб-приложения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp

Авторы

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.10/collections/azure/azcollection/azure_rm_webapp_module.html