AzureSpringCloud@0 - Tarefa v0 do Azure Spring Apps
Esta tarefa implementa aplicações no Azure Spring Apps e gere essas implementações.
Importante
Esta tarefa é suportada nos planos Básico/Standard e Enterprise do Azure Spring Apps. Para obter mais informações, veja Automatizar implementações de aplicações 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.
# 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' | '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.
# 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.
#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. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.jar.
# Application and Configuration Settings
#EnvironmentVariables: # string. Optional. Use when Action = Deploy. Environment Variables.
#JvmOptions: # string. Optional. Use when Action = Deploy. JVM Options.
#RuntimeVersion: 'Java_11' # 'Java_8' | 'Java_11' | 'NetCore_31'. Optional. Use when Action = Deploy. 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
- Subscrição do Azure
Alias de entrada: ConnectedServiceName
. string
. Obrigatório.
Especifica a subscrição do Azure Resource Manager para a implementação.
Action
- Ação
string
. Obrigatório. Valores permitidos: Deploy
, Set Production
(Definir Implementação de Produção), Delete Staging Deployment
. Valor predefinido: Deploy
.
A ação a ser executada no Azure Spring Apps.
AzureSpringCloud
- Nome do Azure Spring Apps
string
. Obrigatório.
O nome ou ID de recurso da instância do Azure Spring Apps a implementar.
AppName
- Aplicação
string
. Obrigatório.
O nome da aplicação Azure Spring Apps a implementar. A aplicação tem de existir antes da execução da tarefa.
DeploymentType
- Tipo de Implementação
string
. Opcional. Utilize quando Action = Deploy
. Valores permitidos: Artifacts
, CustomContainer
(Contentor Personalizado). Valor predefinido: Artifacts
.
Para implementar com código fonte ou pacote Java, selecione "Artefactos"; Para implementar com a imagem de contentor, selecione "Contentor Personalizado".
UseStagingDeployment
- Utilizar a Implementação de Teste
boolean
. Opcional. Utilize quando Action = Deploy || Action = Set Production
. Valor predefinido: true
.
No momento em que a tarefa é executada, esta entrada seleciona automaticamente a implementação definida como staging
.
Se estiver definido como true
, aplique a tarefa à implementação que está definida como a implementação de teste no momento da execução. Se omitido, o DeploymentName
parâmetro tem de ser definido.
CreateNewDeployment
- Crie uma nova implementação de teste se não existir.
boolean
. Opcional. Utilize quando Action = Deploy && UseStagingDeployment = false
. Valor predefinido: false
.
Se definido como true
, e a implementação especificada por DeploymentName
não existir no momento da execução, será criada. Se omitido, o DeploymentName
parâmetro tem de ser definido.
DeploymentName
- Implementação
string
. Opcional. Utilize quando UseStagingDeployment = false && Action != Delete Staging Deployment
.
A implementação à qual esta tarefa será aplicada. Se não estiver a utilizar implementações verde-azulado, defina este campo como default
. O valor tem de começar com uma letra e consistir apenas em letras minúsculas e números.
Package
- Pacote ou pasta
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = Artifacts
. Valor predefinido: $(System.DefaultWorkingDirectory)/**/*.jar
.
O caminho de ficheiro para o pacote ou pasta que contém o conteúdo da aplicação Azure Spring Apps (.jar
ficheiro para Java, .zip
para .NET Core).
São suportadas variáveis (Versão de Compilação | ) e carateres universais.
Por exemplo, $(System.DefaultWorkingDirectory)/**/*.jar
Package
- Pacote ou pasta
string
. Opcional. Utilize quando Action = Deploy
. Valor predefinido: $(System.DefaultWorkingDirectory)/**/*.jar
.
O caminho de ficheiro para o pacote ou pasta que contém o conteúdo da aplicação Azure Spring Apps (.jar
ficheiro para Java, .zip
para .NET Core).
São suportadas variáveis (Versão de Compilação | ) e carateres universais.
Por exemplo, $(System.DefaultWorkingDirectory)/**/*.jar
Builder
- Construtor
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = Artifacts
.
Selecione um construtor do VMware Tanzu® Build Service™, que pode ser utilizado no escalão empresarial.
Para obter uma descrição detalhada, consulte Utilizar o Tanzu Build Service.
RegistryServer
- Servidor de Registo
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
. Valor predefinido: docker.io
.
O registo da imagem de contentor. Predefinição: docker.io.
RegistryUsername
- Nome de Utilizador do Registo
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
.
O nome de utilizador do registo de contentor.
RegistryPassword
- Palavra-passe do Registo
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
.
A palavra-passe do registo de contentor.
ImageName
- Nome e Etiqueta da Imagem
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
. Valor predefinido: hello-world:v1
.
A etiqueta de imagem de contentor.
ImageCommand
- Comando imagem
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
.
O comando da imagem de contentor.
ImageArgs
- Argumentos de Imagem
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
.
Os argumentos da imagem de contentor.
ImageLanguageFramework
- Language Framework
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = CustomContainer
. Valores permitidos: springboot
.
EnvironmentVariables
- Variáveis de Ambiente
string
. Opcional. Utilize quando Action = Deploy
.
As variáveis de ambiente a introduzir com a sintaxe -key value
(por exemplo: -CUSTOMER_NAME Contoso
-WEBSITE_TIME_ZONE
). Os valores que contêm espaços devem estar entre aspas (por exemplo: "Eastern Standard Time"
).
JvmOptions
- Opções JVM
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = Artifacts
.
Edita as opções JVM da aplicação. Uma cadeia que contém opções JVM, como -Xms1024m -Xmx2048m
.
JvmOptions
- Opções JVM
string
. Opcional. Utilize quando Action = Deploy
.
Edita as opções JVM da aplicação. Uma cadeia que contém opções JVM, como -Xms1024m -Xmx2048m
.
RuntimeVersion
- Versão do Runtime
string
. Opcional. Utilize 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 predefinido: Java_11
.
A versão de runtime na qual a aplicação será executada.
RuntimeVersion
- Versão do Runtime
string
. Opcional. Utilize quando Action = Deploy && DeploymentType = Artifacts
. Valores permitidos: Java_8
(Java 8), Java_11
(Java 11), NetCore_31
(.Net Core 3.1). Valor predefinido: Java_11
.
A versão de runtime na qual a aplicação será executada.
RuntimeVersion
- Versão do Runtime
string
. Opcional. Utilize quando Action = Deploy
. Valores permitidos: Java_8
(Java 8), Java_11
(Java 11), NetCore_31
(.Net Core 3.1). Valor predefinido: Java_11
.
A versão de runtime na qual a aplicação será executada.
DotNetCoreMainEntryPath
- Caminho de Entrada Principal
string
. Opcional. Utilize quando RuntimeVersion = NetCore_31
.
O caminho para o executável .NET relativo à raiz zip.
Version
- Versão
string
. Opcional. Utilize quando Action = Deploy
.
A versão de implementação. Se não estiver definida, a versão permanece inalterada.
Opções de controlo de tarefas
Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.
Variáveis de saída
Esta tarefa define as seguintes variáveis de saída, que pode consumir em passos, tarefas e fases a jusante.
testEndpoint
Apenas após a ação "Implementar". Contém o URL privado para aceder à implementação atualizada.
Observações
Utilize esta tarefa para implementar aplicações no Azure Spring Apps e para gerir implementações do Azure Spring Cloud.
Importante
Esta tarefa é suportada nos planos Básico/Standard e Enterprise do Azure Spring Apps. Para obter mais informações, veja Automatizar implementações de aplicações no Azure Spring Apps.
Exemplos
Os exemplos seguintes demonstram cenários de utilização comuns. Para obter mais informações, veja Automatizar implementações de aplicações no Azure Spring Apps.
Eliminar uma implementação de teste
A ação "Eliminar Implementação de Teste" permite-lhe eliminar a implementação que não está a receber tráfego de produção. Isto liberta recursos utilizados por essa implementação e abre espaço para uma nova implementação de teste:
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
A implementar
Para produção
O exemplo seguinte implementa na implementação de produção predefinida no Azure Spring Apps. Este é o único cenário de implementação possível ao utilizar o SKU Básico:
Nota
O padrão de pesquisa de pacotes só deve devolver exatamente um pacote. Se a tarefa de compilação produzir vários pacotes JAR, como sources.jar e javadoc.jar, terá de refinar o padrão de pesquisa para que corresponda apenas ao artefacto binário da aplicação.
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'
Verde-azulado
O exemplo seguinte implementa numa implementação de teste pré-existente. Esta implementação não receberá tráfego de produção até ser definida como uma implementaçã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 obter mais informações sobre implementações azul-verde, incluindo uma abordagem alternativa, veja Estratégias de implementação verde-azulado.
Definir a implementação de produção
O exemplo seguinte define a implementação de teste atual como produção, trocando efetivamente que implementaçã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 | Description |
---|---|
Tipos de pipeline | YAML, Compilação clássica, Versão clássica |
É executado em | Agente, DeploymentGroup |
Exigências | Nenhuma |
Capacidades | Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa. |
Restrições de comandos | Qualquer |
Variáveis de tabelas definidas | Qualquer |
Versão do agente | 2.104.1 ou superior |
Categoria da tarefa | Implementação |