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

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

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

Новая в azure.azcollection 0.1.2

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

Описание

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

Требования

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

python >= 2.7
На хосте, который выполняет данный модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, который выполняет модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user строка	Имя пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлено в azure.azcollection 0.0.1	URL авторитета Azure AD. Используется при аутентификации с именем пользователя/паролем и собственным авторитетом ADFS.
api_profile строка добавлено в azure.azcollection 0.0.1	Выбирает профиль API для использования при общении с Azure-службами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack. По умолчанию: `"latest"`
app_settings словарь	Настройка параметров приложения слота веб-приложения. Дополнительные параметры в формате ключ-значение.
app_state строка	Запуск/остановка/перезапуск слота. Варианты: `"started"` ← (по умолчанию) `"stopped"` `"restarted"`
append_tags булево	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта. Варианты: `false` `true` ← (по умолчанию)
auth_source строка добавлено в azure.azcollection 0.0.1	Определяет источник учетных данных для аутентификации. Также может быть задан через переменную среды `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"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
auto_swap_slot_name любой	Используется для настройки целевого имени слота для автоматической замены или отключения автоматической замены. Установите целевое имя слота для автоматической замены. Установите значение False для отключения автоматической замены слотов.
cert_validation_mode строка добавлено в azure.azcollection 0.0.1	Управляет поведением проверки сертификатов для Azure-точке. По умолчанию все модули проверяют серверный сертификат, но при использовании HTTPS-прокси или подключении к Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id строка	Идентификатор клиента Azure. Используется при аутентификации с помощью принципала службы или управляемой идентификации (msi). Также может быть задан через переменную среды `AZURE_CLIENT_ID`.
cloud_environment строка добавлено в azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес точки обнаружения метаданных (необходим для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. По умолчанию: `"AzureCloud"`
configuration_source строка	Исходный слот для клонирования настроек при создании слота. Используйте имя веб-приложения для ссылки на производственный слот.
container_settings словарь	Параметры контейнера слота веб-приложения.
name строка / обязательно	Имя контейнера, например `imagename:tag`.
registry_server_password строка	Пароль сервера реестра контейнеров.
registry_server_url строка	URL-адрес сервера реестра контейнеров, например `mydockerregistry.io`.
registry_server_user строка	Имя пользователя сервера реестра контейнеров.

deployment_source dictionary	Источник развертывания для Git.
branch string	Имя ветки репозитория.
url string	URL репозитория источника развертывания.
disable_instance_discovery boolean добавлен в azure.azcollection 2.3.0	Определяет, будет ли выполнено обнаружение экземпляра при попытке аутентификации. Установка значения в True полностью отключит как обнаружение экземпляра, так и проверку полномочий. Эта функция предназначена для использования в сценариях, где метаданные конечной точки недоступны, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляра предполагает получение метаданных полномочий с https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате крайне важно убедиться, что указанный хост полномочий является валидным и надежным. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
frameworks list / elements=dictionary	Набор настроек среды выполнения фреймворка. Каждая настройка — это словарь. См. https://docs.microsoft.com/ru-ru/azure/app-service/app-service-web-overview для получения дополнительной информации.
name string / обязательно	Имя фреймворка. Поддерживаемый список фреймворков для веб-приложения Windows и Linux отличается. Веб-приложения Windows поддерживают `java`, `net_framework`, `php`, `python`, и `node` с июня 2018 года. Веб-приложения Windows поддерживают несколько фреймворков одновременно. Веб-приложения Linux поддерживают `java`, `ruby`, `php`, `dotnetcore`, и `node` с июня 2018 года. Веб-приложения Linux поддерживают только один фреймворк. Фреймворк Java взаимоисключающий с другими. Варианты: `"java"` `"net_framework"` `"php"` `"python"` `"ruby"` `"dotnetcore"` `"node"`
settings dictionary	Список настроек фреймворка.
java_container string / обязательно	Имя контейнера Java. Это поддерживается только определенными фреймворками `java`, например, `Tomcat`, `Jetty`.
java_container_version string / обязательно	Версия контейнера Java. Это поддерживается только определенными фреймворками `java`. Для `Tomcat`, например `8.0`, `8.5`, `9.0`. Для `Jetty`, например `9.1`, `9.3`.
version string / обязательно	Версия фреймворка. Для поддерживаемых значений веб-приложения 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 string	Расположение ресурса. Если не указано, в качестве значения по умолчанию используется расположение из группы ресурсов.
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string / обязательно	Уникальное имя развертываемого слота для создания или обновления.
password string	Пароль пользователя Active Directory. Используется при аутентификации с помощью пользователя Active Directory, а не принципала службы.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
purge_app_settings boolean	Очистить все существующие параметры приложения. Заменить параметры приложения слота параметрами app_settings. Варианты: `false` ← (по умолчанию) `true`

END_OF_DOCUMENT_MARKER

resource_group строка / обязательно	Имя группы ресурсов, к которой относится ресурс.
secret строка	Секретный ключ клиента Azure. Используется при аутентификации с помощью Служебного принципала.
startup_file строка	Файл запуска слота. Это применимо только для слотов веб-приложений Linux.
state строка	Состояние слота развертывания веб-приложения. Используйте `present` для создания или обновления слота и `absent` для его удаления. Выбори: `"absent"` `"present"` ← (по умолчанию)
subscription_id строка	Ваш идентификатор подписки Azure.
swap словарь	Переключение слотов развертывания веб-приложения.
action строка	Типы переключения. `preview` — для применения настроек целевого слота к исходному слоту сначала. `swap` — для завершения переключения. `reset` — для сброса переключения. Выбори: `"preview"` ← (по умолчанию) `"swap"` `"reset"`
preserve_vnet логическое	`True` — для сохранения виртуальной сети в слоте во время переключения. В противном случае `False`. Выбори: `false` `true` ← (по умолчанию)
target_slot строка	Имя целевого слота для переключения. Если установлено в None, то переключается со слотом production.
tags словарь	Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в false. В настоящее время зоны Azure DNS и службы Traffic Manager также не допускают использование пробелов в теге. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают только 15 тегов на ресурсах.
tenant строка	Идентификатор клиента Azure. Используется при аутентификации с помощью Служебного принципала.
thumbprint строка добавлено в azure.azcollection 1.14.0	Отпечаток пальца закрытого ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципала. Необходимо, если определен x509_certificate_path.
webapp_name строка / обязательно	Имя веб-приложения, к которому принадлежит этот слот развертывания.
x509_certificate_path путь добавлено в azure.azcollection 1.14.0	Путь к сертификату X509, используемому для создания служебного принципала в формате PEM. Сертификат должен быть добавлен к закрытому ключу. Используется при аутентификации с помощью Служебного принципала.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед выполнением задач или книги с playbooks с помощью 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_webappslot_module.html