azure_rm_webappslot – Управление слотом веб-приложения Azure

Новая версия с 2.8.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Создание, обновление и удаление слота веб-приложения Azure.

Требования

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

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.
auto_swap_slot_name -				Используется для настройки имени целевого слота для автоматической замены или отключения автоматической замены. Установите имя целевого слота для автоматической замены. Установите в False, чтобы отключить автоматическую замену слотов.
cert_validation_mode строка добавлено в 2.5			Варианты: ignore validate	Управляет поведением проверки сертификата для Azure-точек конечного доступа. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка				Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлено в 2.4			По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`) или URL-адрес точки конечного доступа к метаданным (необходим для Azure Stack). Также может быть установлено через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
configuration_source -				Исходный слот для клонирования конфигураций при создании слота. Используйте имя веб-приложения для ссылки на слот производства.
container_settings -				Параметры контейнера слота веб-приложения.
	name -			Имя контейнера. Например, "imagename:tag"
	registry_server_password -			Пароль сервера реестра контейнеров.
	registry_server_url -			URL-адрес сервера реестра контейнеров. Например, mydockerregistry.io
	registry_server_user -			Имя пользователя сервера реестра контейнеров.
deployment_source -				Источник развертывания для git
	branch -			Имя ветки репозитория.
	url -			URL-адрес репозитория источника развертывания.
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.
location -				Расположение ресурса. Если не установлено, используется расположение из группы ресурсов по умолчанию.
name - / обязательно				Уникальное имя создаваемого или обновляемого слота развертывания.
password -				Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.

purge_app_settings boolean		Выбранные значения: no yes	Очистить все существующие параметры приложения. Заменить параметры приложения слота на app_settings.
resource_group - / обязательно			Имя группы ресурсов, к которой относится ресурс.
secret string			Секрет Azure-клиента. Используется при аутентификации с помощью управляющего принципа.
startup_file -			Файл запуска слота. Это относится только к веб-приложению Linux-слота.
state -		Выбранные значения: absent present ←	Утвердить состояние слота развертывания веб-приложения. Используйте `present` для создания или обновления слота и `absent` для его удаления.
subscription_id string			Ваш идентификатор подписки Azure.
swap -			Переключить слоты развертывания веб-приложения.
	action -	Выбранные значения: preview ← swap reset	Типы переключения. preview — для применения настроек целевого слота на исходный слот сначала. swap — для завершения переключения. reset — для сброса переключения.
	preserve_vnet boolean	Выбранные значения: no yes ←	True, чтобы сохранить виртуальную сеть в слоте при переключении. В противном случае False.
	target_slot -		Имя целевого слота для переключения. Если установлено в None, то переключаться с производственным слотом.
tags dictionary			Словарь пар "строка:строка" для назначения в качестве метаданных объекту. Метаданные теги объекта будут обновлены с любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false.
tenant string			Идентификатор Azure-аренды. Используется при аутентификации с помощью управляющего принципа.
webapp_name - / обязательно			Имя веб-приложения, к которому принадлежит этот слот развертывания.

Примечания

Примечание

Для аутентификации с 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 webapp slot
  azure_rm_webapp_slot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    configuration_source: myJavaWebApp
    app_settings:
      testkey: testvalue

- name: swap the slot with production slot
  azure_rm_webapp_slot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    swap:
      action: swap

- name: stop the slot
  azure_rm_webapp_slot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    app_state: stopped

- name: udpate a webapp slot app settings
  azure_rm_webapp_slot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    app_settings:
      testkey: testvalue2

- name: udpate a webapp slot frameworks
  azure_rm_webapp_slot:
    resource_group: myResourceGroup
    webapp_name: myJavaWebApp
    name: stage
    frameworks:
      - name: "node"
        version: "10.1"

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

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

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

Статус

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