AzureSpringCloud@0 — задача Azure Spring Apps версии 0

Эта задача развертывает приложения в Azure Spring Apps и управляет этими развертываниями.

Важно!

Эта задача поддерживается в планах Azure Spring Apps уровня "Базовый", "Стандартный" и "Корпоративный". Дополнительные сведения см. в статье Автоматизация развертывания приложений в Azure Spring Apps.

Синтаксис

# Azure Spring Apps v0
# Deploy applications to Azure Spring Apps and manage deployments.
- task: AzureSpringCloud@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    Action: 'Deploy' # 'Deploy' | 'Set Production' | 'Delete Staging Deployment'. Required. Action. Default: Deploy.
    AzureSpringCloud: # string. Required. Azure Spring Apps Name. 
    AppName: # string. Required. App. 
    #DeploymentType: 'Artifacts' # 'Artifacts' | 'CustomContainer'. Optional. Use when Action = Deploy. Deployment Type. Default: Artifacts.
    #UseStagingDeployment: true # boolean. Optional. Use when Action = Deploy || Action = Set Production. Use Staging Deployment. Default: true.
    #CreateNewDeployment: false # boolean. Optional. Use when Action = Deploy && UseStagingDeployment = false. Create a new staging deployment if one does not exist. Default: false.
    #DeploymentName: # string. Optional. Use when UseStagingDeployment = false && Action != Delete Staging Deployment. Deployment. 
    #Package: '$(System.DefaultWorkingDirectory)/**/*.jar' # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.jar.
    #RegistryServer: 'docker.io' # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Server. Default: docker.io.
    #RegistryUsername: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Username. 
    #RegistryPassword: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Registry Password. 
    #ImageName: 'hello-world:v1' # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Name and Tag. Default: hello-world:v1.
    #ImageCommand: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Command. 
    #ImageArgs: # string. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Image Arguments. 
    #ImageLanguageFramework: # 'springboot'. Optional. Use when Action = Deploy && DeploymentType = CustomContainer. Language Framework. 
  # Application and Configuration Settings
    #Builder: # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Builder. 
    #EnvironmentVariables: # string. Optional. Use when Action = Deploy. Environment Variables. 
    #JvmOptions: # string. Optional. Use when Action = Deploy && DeploymentType = Artifacts. JVM Options. 
    #RuntimeVersion: 'Java_11' # 'Java_8' | 'Java_11' | 'Java_17' | 'Java_21' | 'NetCore_31'. Optional. Use when Action = Deploy && DeploymentType = Artifacts. Runtime Version. Default: Java_11.
    #DotNetCoreMainEntryPath: # string. Optional. Use when RuntimeVersion = NetCore_31. Main Entry Path. 
    #Version: # string. Optional. Use when Action = Deploy. Version.

Входные данные

azureSubscription - Подписка Azure
Входной псевдоним: ConnectedServiceName. string. Обязательный.

Указывает подписку azure Resource Manager для развертывания.

Action - Действий
string. Обязательный. Допустимые значения: Deploy, Set Production (set Production Deployment), Delete Staging Deployment. Значение по умолчанию: Deploy.

Действие, выполняемого в Azure Spring Apps.

AzureSpringCloud - Имя Azure Spring Apps
string. Обязательный.

Имя или идентификатор ресурса развертываемого экземпляра Azure Spring Apps.

AppName - Приложение
string. Обязательный.

Имя развертываемого приложения Azure Spring Apps. Приложение должно существовать до выполнения задачи.

DeploymentType - Тип развертывания
string. Необязательный элемент. Используйте при Action = Deploy. Допустимые значения: Artifacts, CustomContainer (Пользовательский контейнер). Значение по умолчанию: Artifacts.

Чтобы выполнить развертывание с помощью исходного кода или пакета Java, выберите "Артефакты"; Чтобы выполнить развертывание с помощью образа контейнера, выберите "Пользовательский контейнер".

UseStagingDeployment - Использование промежуточного развертывания
boolean. Необязательный элемент. Используйте при Action = Deploy || Action = Set Production. Значение по умолчанию: true.

Во время выполнения задачи эти входные данные автоматически выбирают развертывание с заданным значением staging.

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

CreateNewDeployment - Создайте новое промежуточное развертывание, если оно не существует.
boolean. Необязательный элемент. Используйте при Action = Deploy && UseStagingDeployment = false. Значение по умолчанию: false.

Если задано значение true, а развертывание, указанное параметром DeploymentName , не существует во время выполнения, оно будет создано. Если этот параметр опущен DeploymentName , необходимо задать параметр .

DeploymentName - Развертывания
string. Необязательный элемент. Используйте при UseStagingDeployment = false && Action != Delete Staging Deployment.

Развертывание, к которому будет применена эта задача. Если не используются сине-зеленые развертывания, задайте для этого поля значение default. Значение должно начинаться с буквы и состоять только из строчных букв и цифр.

Package - Пакет или папка
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = Artifacts. Значение по умолчанию: $(System.DefaultWorkingDirectory)/**/*.jar.

Путь к пакету или папке, содержащей содержимое приложения Azure Spring Apps (.jar файл для Java, .zip для .NET Core).
Поддерживаются переменные (выпусксборки | ) и подстановочные знаки.
Например $(System.DefaultWorkingDirectory)/**/*.jar.

Builder - Построитель
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = Artifacts.

Выберите построитель службы™ сборки VMware Tanzu®, которую можно использовать на корпоративном уровне.
Для подробного описания проверка используйте службу сборки Tanzu.

RegistryServer - Сервер реестра
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer. Значение по умолчанию: docker.io.

Реестр образа контейнера. По умолчанию: docker.io.

RegistryUsername - Имя пользователя реестра
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer.

Имя пользователя для реестра контейнеров.

RegistryPassword - Пароль реестра
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer.

Пароль реестра контейнеров.

ImageName - Имя и тег изображения
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer. Значение по умолчанию: hello-world:v1.

Тег образа контейнера.

ImageCommand - Команда Image
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer.

Команда образа контейнера.

ImageArgs - Аргументы изображения
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer.

Аргументы образа контейнера.

ImageLanguageFramework - Языковая платформа
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = CustomContainer. Допустимые значения: springboot.

EnvironmentVariables - Переменные среды
string. Необязательный элемент. Используйте при Action = Deploy.

Переменные среды, которые необходимо ввести с помощью синтаксиса -key value (например, -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Значения, содержащие пробелы, должны быть заключены в двойные кавычки (например, "Eastern Standard Time").

JvmOptions - Параметры виртуальной машины Java
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = Artifacts.

Изменяет параметры виртуальной машины JVM приложения. Строка, содержащая параметры виртуальной машины Java, например -Xms1024m -Xmx2048m.

RuntimeVersion - Версия среды выполнения
string. Необязательный элемент. Используйте при Action = Deploy && DeploymentType = Artifacts. Допустимые значения: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Значение по умолчанию: Java_11.

Версия среды выполнения, в которой будет выполняться приложение.

DotNetCoreMainEntryPath - Путь основной записи
string. Необязательный элемент. Используйте при RuntimeVersion = NetCore_31.

Путь к исполняемому файлу .NET относительно корня ZIP.

Version - Версия
string. Необязательный элемент. Используйте при Action = Deploy.

Версия развертывания. Если значение не задано, версия остается без изменений.

Параметры управления задачами

Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.

Выходные переменные

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

testEndpoint
Только после действия "Развернуть". Содержит частный URL-адрес для доступа к обновленному развертыванию.

Комментарии

Эта задача предназначена для развертывания приложений в Azure Spring Apps и управления развертываниями Azure Spring Cloud.

Важно!

Эта задача поддерживается в планах Azure Spring Apps уровня "Базовый", "Стандартный" и "Корпоративный". Дополнительные сведения см. в статье Автоматизация развертывания приложений в Azure Spring Apps.

Примеры

Следующие примеры демонстрируют распространенные сценарии использования. Дополнительные сведения см. в статье Автоматизация развертывания приложений в Azure Spring Apps.

Удаление промежуточного развертывания

Действие Delete Staging Deployment (Удалить промежуточное развертывание) позволяет удалить развертывание, не получающее рабочий трафик. Это освобождает ресурсы, используемые этим развертыванием, а также освобождает место для нового промежуточного развертывания:

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
  continueOnError: true # Don't fail the pipeline if a staging deployment doesn't already exist.
  inputs:
    continueOnError: true
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Delete Staging Deployment'
    AppName: customer-api
    AzureSpringCloud: contoso-dev-az-spr-cld

Развертывание

В рабочей среде

В следующем примере выполняется развертывание в рабочем развертывании по умолчанию в Azure Spring Apps. Это единственный возможный сценарий развертывания при использовании Basic SKU:

Примечание

Шаблон поиска пакетов должен возвращать только один пакет. Если задача сборки создает несколько JAR-пакетов, таких как sources.jar и javadoc.jar, необходимо уточнить шаблон поиска, чтобы он соответствовал только двоичному артефакту приложения.

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Deploy'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: false
    DeploymentName: default
    Package: '$(System.DefaultWorkingDirectory)/**/*customer-api*.jar'

Сине-зеленый

В следующем примере выполняется развертывание в уже существующем промежуточном развертывании. Это развертывание не будет получать рабочий трафик, пока оно не будет задано в качестве рабочего развертывания.

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Deploy'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: true
    Package: '$(System.DefaultWorkingDirectory)/**/*customer-api*.jar'

Дополнительные сведения о сине-зеленых развертываниях, включая альтернативный подход, см. в статье Стратегии сине-зеленого развертывания.

Настройка рабочего развертывания

В следующем примере текущее промежуточное развертывание задается как рабочее, фактически заменяя то, какое развертывание получает рабочий трафик.

variables:
  azureSubscription: Contoso

steps:
- task: AzureSpringCloud@0
    inputs:
    azureSubscription: $(azureSubscription)
    Action: 'Set Production'
    AzureSpringCloud: contoso-dev-az-spr-cld
    AppName: customer-api
    UseStagingDeployment: true

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка, классический выпуск
Выполняется в	Агент, DeploymentGroup
Требования	None
Capabilities	Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд	Любой
Устанавливаемые переменные	Любой
Версия агента	2.104.1 или более поздней версии
Категория задач	Развертывание