azure_rm_webappslot – Управление слотами приложений Azure Web App
Новая версия 2.8.
Обзор
- Создание, обновление и удаление слота приложения Azure Web App.
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- 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 строка |
| Запуск/остановка/перезапуск слота. | ||
| append_tags логическое |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, которых нет в параметре тегов, будут удалены из метаданных объекта. | ||
| auth_source строка добавлено в 2.5 |
| Управление источником учетных данных для аутентификации. Если не указано, используется переменная среды 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 |
| Управление поведением проверки сертификата для 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 - |
| Имя фреймворка. Поддерживаемый список фреймворков для 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 - / обязательно | Уникальное имя создаваемого или обновляемого слота развертывания. | |||
| пароль строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо управляющего принципа сервиса. | |||
| профиль строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| purge_app_settings булево |
| Очистить все существующие параметры приложения. Заменить параметры приложения слота параметрами app_settings. | ||
| группа_ресурсов - / обязательно | Имя группы ресурсов, к которой принадлежит ресурс. | |||
| секрет строка | Секрет клиента Azure. Используйте при аутентификации с управляющим принципом сервиса. | |||
| startup_file - | Файл запуска слота. Это применимо только для слота веб-приложения Linux. | |||
| состояние - |
| Состояние слота развертывания веб-приложения. Используйте present для создания или обновления слота и absent для его удаления. | ||
| id_подписки строка | Ваш идентификатор подписки Azure. | |||
| swap - | Переключить слоты развертывания веб-приложения. | |||
| действие - |
| Типы переключения. preview — для применения настроек целевого слота на исходном слоте сначала.swap — для завершения переключения.reset — для сброса переключения. | ||
| preserve_vnet булево |
| True для сохранения виртуальной сети для слота во время переключения. В противном случае %%%CODE_BLOCK_66%%. | ||
| целевой_слот - | Имя целевого слота для переключения. Если установлено значение None, то переключение со слотом производства. | |||
| метки словарь | Словарь пар «строка:строка» для присвоения метаданных объекту. Метаданные метки объекта будут обновлены любыми предоставленными значениями. Для удаления меток установите параметр append_tags в значение false. | |||
| арендатор строка | Идентификатор арендатора Azure. Используйте при аутентификации с управляющим принципом сервиса. | |||
| имя_веб_приложения - / обязательно | Имя веб-приложения, к которому принадлежит этот слот развертывания. | |||
Примечания
Примечание
- Для аутентификации с Azure вы можете передать параметры, установить переменные среды, использовать профиль, сохраненный в файле ~/.azure/credentials, или войти в систему перед запуском задач или игровой доски с помощью %%%CODE_BLOCK_67%%.
- Аутентификация также возможна с использованием управляющего принципа сервиса или пользователя 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
- Как выполнить аутентификацию с помощью команды %%%CODE_BLOCK_68%%.
Примеры
- 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 |
Статус
- Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом 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_webappslot_module.html
