AzureSpringCloud@0 - Задача Azure Spring Apps v0

Эта задача развертывает приложения в 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® Build Service™, который можно использовать на корпоративном уровне.
Для получения подробного описания, пожалуйста, ознакомьтесь с разделом «Использование Tanzu Build Service».

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 - Команда изображения
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 - Варианты JVM
string. Необязательно. Используется при Action = Deploy && DeploymentType = Artifacts.

Редактирует параметры JVM приложения. Строка, содержащая параметры JVM, такие как -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.

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

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

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. Это единственный возможный сценарий развертывания при использовании номера 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
Требования	Отсутствует
Возможности	Эта задача не удовлетворяет требованиям к последующим задачам в задании.
ограничения команд	Любое
переменные settable	Любое
Версия агента	2.104.1 или более поздней версии
Категория задач	Развертывание