azure.azcollection.azure_rm_webapp – Управление экземплярами веб-приложений
Примечание
Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Чтобы использовать его в плейбуке, укажите: azure.azcollection.azure_rm_webapp.
Новое в версии 0.1.2: of 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 строка |
| Запуск/остановка/перезапуск веб-приложения. | ||
| append_tags логический тип |
| Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта. | ||
| auth_source строка добавлен в 0.0.1 azure.azcollection |
| Управление источником учетных данных для аутентификации. Также может быть задано через переменную среды ANSIBLE_AZURE_AUTH_SOURCE. При значении auto (по умолчанию) приоритет имеет модуль параметров -> env -> credential_file -> cli. При значении env, учетные данные будут считываться из переменных среды.При значении credential_file, профиль будет считываться из ~/.azure/credentials. При значении cli, учетные данные будут взяты из профиля Azure CLI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure CLI.При значении msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка.msi был добавлен в Ansible 2.6. | ||
| cert_validation_mode строка добавлен в 0.0.1 azure.azcollection |
| Управление поведением проверки сертификатов для Azure-точек конечного доступа. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION. | ||
| client_affinity_enabled логический тип |
| Включение или отключение куки-файлов сеанса, которые направляют запросы клиента в рамках одного сеанса на тот же экземпляр. | ||
| 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 логический тип |
| Регистрация имени хоста веб-приложения в DNS при создании. Установите значение false для регистрации. | ||
| 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. Поддерживается только при 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 логический тип |
| Настройка веб-сайта для принятия только запросов https. | ||
| location строка | Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию. | |||
| name строка / обязательно | Уникальное имя приложения для создания или обновления. Для создания или обновления слота развертывания используйте параметр {slot}. | |||
| password строка | Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с главным сервисом. | |||
| plan строка | План службы приложений. Требуется для создания. Может быть именем существующего плана службы приложений в той же группе ресурсов, что и веб-приложение. Может быть идентификатором ресурса существующего плана службы приложений. Например, /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 строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |||
| purge_app_settings булево |
| Очистить все существующие параметры приложения. Заменить параметры приложения веб-приложения параметрами app_settings. | ||
| resource_group строка / обязательно | Имя группы ресурсов, к которой принадлежит ресурс. | |||
| scm_type строка | Тип репозитория источника развертывания, например, LocalGit, GitHub. Список поддерживаемых значений находится по адресу https://docs.microsoft.com/ru-ru/rest/api/appservice/webapps/createorupdate#scmtype. | |||
| secret строка | Секретный ключ клиента Azure. Используется при аутентификации с помощью принципала службы. | |||
| skip_custom_domain_verification булево |
| Пропустить проверку настроенных (не *.azurewebsites.net) доменов, связанных с веб-приложением. Установите значение true, чтобы пропустить. | ||
| startup_file строка | Файл запуска веб-приложения. Используется только для веб-приложений Linux. | |||
| state строка |
| Состояние веб-приложения. Используйте present для создания или обновления веб-приложения и absent для его удаления. | ||
| subscription_id строка | Ваш идентификатор подписки Azure. | |||
| tags словарь | Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в false. | |||
| tenant строка | Идентификатор Azure-аренды. Используется при аутентификации с помощью принципала службы. | |||
| ttl_in_seconds строка | Время жизни в секундах для имени домена по умолчанию веб-приложения. | |||
Примечания
Примечание
- Для аутентификации с 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 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 строка | всегда | Идентификатор текущего веб-приложения. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/sites/myWebApp |
Авторы
- 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_webapp_module.html