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

Примечание

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

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

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

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

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

Обзор

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

Требования

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

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 строка / обязательно				Имя группы ресурсов, к которой принадлежит ресурс.

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

Примечания

Примечание

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

Авторы

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_webappslot_module.html