azure.azcollection.azure_rm_webappslot – Управление слотом Azure Web App

Примечание

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

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

Для использования в книге задач, укажите: azure.azcollection.azure_rm_webappslot.

Новое в версии 0.1.2: of azure.azcollection

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

Обзор

Создание, обновление и удаление слота Azure Web App.

Требования

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

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 ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. В каноническом режиме любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
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.
auto_swap_slot_name строка				Используется для настройки имени целевого слота для автоматического переключения или отключения автоматического переключения. Установите имя целевого слота для автоматического переключения. Установите значение в False, чтобы отключить автоматическое переключение слотов.
cert_validation_mode строка добавлен в 0.0.1 azure.azcollection			Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-эндпоинтов. По умолчанию все модули проверяют сертификат сервера, но при использовании HTTPS-прокси или работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задано через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка				Идентификатор клиента Azure. Используйте при аутентификации с помощью сервисного принципала.
cloud_environment строка добавлен в 0.0.1 azure.azcollection			По умолчанию: "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 поддерживают `java`, `net_framework`, `php`, `python`, и `node` с июня 2018 года. Веб-приложения Windows поддерживают несколько фреймворков одновременно. Веб-приложения Linux поддерживают `java`, `ruby`, `php`, `dotnetcore`, и `node` с июня 2018 года. Веб-приложения Linux поддерживают только один фреймворк. Фреймворк 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.9` для веб-приложений Windows. `1.8` для веб-приложений Linux.
location строка				Расположение ресурса. Если не задано, расположение из группы ресурсов будет использоваться по умолчанию.
name строка / обязательно				Уникальное имя слота развертывания для создания или обновления.
password строка				Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с сервисным принципалом.
profile строка				Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_app_settings логический тип			Варианты: no ← yes	Очистка существующих параметров приложения. Замена параметров приложения слота параметрами app_settings.
resource_group строка / обязательно				Имя группы ресурсов, к которой принадлежит ресурс.

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

Примечания

Примечание

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

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

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

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

- name: udpate a webapp slot frameworks
  azure_rm_webappslot:
    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

Авторы

Yunge Zhu(@yungezz)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_webappslot_module.html