AzureSpringCloud@0 – tarefa do Azure Spring Apps v0

Essa tarefa implanta aplicativos no Azure Spring Apps e gerencia essas implantações.

Importante

Essa tarefa tem suporte nos planos Básico/Standard e Enterprise do Azure Spring Apps. Para obter mais informações, consulte Automatizar implantações de aplicativos no Azure Spring Apps.

Syntax

# 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.

Entradas

azureSubscription - Assinatura do Azure
Alias de entrada: ConnectedServiceName. string. Obrigatórios.

Especifica a assinatura de Resource Manager do Azure para a implantação.

Action - Ação
string. Obrigatórios. Valores permitidos: Deploy, Set Production (Definir Implantação de Produção), Delete Staging Deployment. Valor padrão: Deploy.

A ação a ser executada no Azure Spring Apps.

AzureSpringCloud - Nome do Azure Spring Apps
string. Obrigatórios.

O nome ou a ID do recurso da instância do Azure Spring Apps a ser implantada.

AppName - App
string. Obrigatórios.

O nome do aplicativo Azure Spring Apps a ser implantado. O aplicativo deve existir antes da execução da tarefa.

DeploymentType - Tipo de implantação
string. Opcional. Use quando Action = Deploy. Valores permitidos: Artifacts, CustomContainer (Contêiner Personalizado). Valor padrão: Artifacts.

Para implantar com o código-fonte ou pacote Java, escolha "Artefatos"; Para implantar com a imagem de contêiner, escolha "Contêiner Personalizado".

UseStagingDeployment - Usar a implantação de preparo
boolean. Opcional. Use quando Action = Deploy || Action = Set Production. Valor padrão: true.

No momento em que a tarefa é executada, essa entrada seleciona automaticamente a implantação definida como staging.

Se definido truecomo , aplique a tarefa à implantação definida como a implantação de preparo no momento da execução. Se omitido, o parâmetro DeploymentName deverá ser definido.

CreateNewDeployment - Crie uma nova implantação de preparo se uma não existir.
boolean. Opcional. Use quando Action = Deploy && UseStagingDeployment = false. Valor padrão: false.

Se definido truecomo e a implantação especificada por DeploymentName não existir no momento da execução, ela será criada. Se omitido, o parâmetro DeploymentName deverá ser definido.

DeploymentName - Implantação
string. Opcional. Use quando UseStagingDeployment = false && Action != Delete Staging Deployment.

A implantação à qual essa tarefa será aplicada. Se não estiver usando implantações azul-verde, defina esse campo como default. O valor deve começar com uma letra e consistir apenas em letras minúsculas e números.

Package - Pacote ou pasta
string. Opcional. Use quando Action = Deploy && DeploymentType = Artifacts. Valor padrão: $(System.DefaultWorkingDirectory)/**/*.jar.

O caminho do arquivo para o pacote ou pasta que contém o conteúdo do aplicativo Azure Spring Apps (.jar arquivo para Java, .zip para .NET Core).
Há suporte para variáveis ( | versão de build) e curingas.
Por exemplo, $(System.DefaultWorkingDirectory)/**/*.jar

Builder - Construtor
string. Opcional. Use quando Action = Deploy && DeploymentType = Artifacts.

Selecione um construtor do Serviço™ de Build do VMware Tanzu®, que pode ser usado na camada corporativa.
Para obter uma descrição detalhada, marcar Use o Tanzu Build Service.

RegistryServer - Servidor do Registro
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer. Valor padrão: docker.io.

O registro da imagem de contêiner. Padrão: docker.io.

RegistryUsername - Nome de usuário do Registro
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer.

O nome de usuário do registro de contêiner.

RegistryPassword - Senha do Registro
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer.

A senha do registro de contêiner.

ImageName - Nome e marca da imagem
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer. Valor padrão: hello-world:v1.

A marca de imagem de contêiner.

ImageCommand - Comando Image
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer.

O comando da imagem de contêiner.

ImageArgs - Argumentos de imagem
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer.

Os argumentos da imagem de contêiner.

ImageLanguageFramework - Estrutura de Linguagem
string. Opcional. Use quando Action = Deploy && DeploymentType = CustomContainer. Valores permitidos: springboot.

EnvironmentVariables - Variáveis de ambiente
string. Opcional. Use quando Action = Deploy.

As variáveis de ambiente a serem inseridas usando a sintaxe -key value (por exemplo: -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Os valores que contêm espaços devem ser colocados entre aspas duplas (por exemplo: "Eastern Standard Time").

JvmOptions - Opções de JVM
string. Opcional. Use quando Action = Deploy && DeploymentType = Artifacts.

Edita as opções de JVM do aplicativo. Uma cadeia de caracteres que contém opções de JVM, como -Xms1024m -Xmx2048m.

RuntimeVersion - Versão do runtime
string. Opcional. Use quando Action = Deploy && DeploymentType = Artifacts. Valores permitidos: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21) NetCore_31 (.Net Core 3.1). Valor padrão: Java_11.

A versão de runtime na qual o aplicativo será executado.

DotNetCoreMainEntryPath - Caminho de Entrada Principal
string. Opcional. Use quando RuntimeVersion = NetCore_31.

O caminho para o executável do .NET em relação à raiz zip.

Version - Versão
string. Opcional. Use quando Action = Deploy.

A versão de implantação. Se não estiver definida, a versão será deixada inalterada.

Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Essa tarefa define as variáveis de saída a seguir, que você pode consumir em etapas downstream, trabalhos e estágios.

testEndpoint
Somente após a ação "Implantar". Contém a URL privada para acessar a implantação atualizada.

Comentários

Use essa tarefa para implantar aplicativos no Azure Spring Apps e gerenciar implantações do Azure Spring Cloud.

Importante

Essa tarefa tem suporte nos planos Básico/Standard e Enterprise do Azure Spring Apps. Para obter mais informações, consulte Automatizar implantações de aplicativos no Azure Spring Apps.

Exemplos

Os exemplos a seguir demonstram cenários de uso comuns. Para obter mais informações, consulte Automatizar implantações de aplicativos no Azure Spring Apps.

Excluir uma implantação de preparo

A ação "Excluir implantação de preparo" permite que você exclua a implantação que não está recebendo o tráfego de produção. Isso libera os recursos usados por essa implantação e deixa espaço para uma nova implantação de preparo:

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

Implantando

Para produção

O exemplo a seguir implanta na implantação de produção padrão no Azure Spring Apps. Esse é o único cenário de implantação possível ao usar a SKU básica:

Observação

O padrão de pesquisa de pacote apenas deve retornar exatamente um pacote. Se a tarefa de build produzir vários pacotes JAR, como sources.jar e javadoc.jar, você precisará refinar o padrão de pesquisa para que ele corresponda apenas ao artefato binário do aplicativo.

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'

Blue-green

O exemplo a seguir é implantado em uma implantação de preparo pré-existente. Essa implantação não receberá tráfego de produção até que seja definida como uma implantação de produção.

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'

Para saber mais sobre implantações azul-verde, incluindo uma abordagem alternativa, confira Estratégias de implantação azul-verde.

Definir a implantação de produção

O exemplo a seguir define a implantação de preparo atual como produção, trocando efetivamente qual implantação recebe tráfego de produção.

variables:
  azureSubscription: Contoso

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

Requisitos

Requisito	Descrição
Tipos de pipeline	YAML, build clássico, versão clássica
Executa em	Agent, DeploymentGroup
Demandas	Nenhum
Funcionalidades	Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	2.104.1 ou superior
Categoria da tarefa	Implantar