AzureSpringCloud@0 – Azure Spring Apps v0-uppgift

Den här uppgiften distribuerar program till Azure Spring Apps och hanterar dessa distributioner.

Viktigt

Den här uppgiften stöds i Azure Spring Apps Basic-/Standard- och Enterprise-planer. Mer information finns i Automatisera programdistributioner till 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.

Indata

azureSubscription - Azure-prenumeration
Indataalias: ConnectedServiceName. string. Krävs.

Anger Azure Resource Manager-prenumerationen för distributionen.

Action - Åtgärder
string. Krävs. Tillåtna värden: Deploy, Set Production (Ange produktionsdistribution), Delete Staging Deployment. Standardvärde: Deploy.

Åtgärden som ska utföras i Azure Spring Apps.

AzureSpringCloud - Namn på Azure Spring Apps
string. Krävs.

Namnet eller resurs-ID:t för den Azure Spring Apps-instans som ska distribueras.

AppName - App
string. Krävs.

Namnet på den Azure Spring Apps-app som ska distribueras. Appen måste finnas före aktivitetskörningen.

DeploymentType - Distributionstyp
string. Valfritt. Använd när Action = Deploy. Tillåtna värden: Artifacts, CustomContainer (anpassad container). Standardvärde: Artifacts.

Om du vill distribuera med källkod eller Java-paket väljer du "Artifacts"; Om du vill distribuera med containeravbildning väljer du "Anpassad container".

UseStagingDeployment - Använda mellanlagringsdistribution
boolean. Valfritt. Använd när Action = Deploy || Action = Set Production. Standardvärde: true.

När aktiviteten körs väljer indata automatiskt den distribution som anges som staging.

Om den är inställd truepå tillämpar du uppgiften på den distribution som anges som mellanlagringsdistribution vid tidpunkten för körningen. Om den utelämnas måste parametern DeploymentName anges.

CreateNewDeployment - Skapa en ny mellanlagringsdistribution om det inte finns någon.
boolean. Valfritt. Använd när Action = Deploy && UseStagingDeployment = false. Standardvärde: false.

Om värdet trueär , och distributionen som anges av DeploymentName inte finns vid körningen, skapas den. Om den utelämnas måste parametern DeploymentName anges.

DeploymentName - Distribution
string. Valfritt. Använd när UseStagingDeployment = false && Action != Delete Staging Deployment.

Den distribution som den här uppgiften ska gälla för. Om du inte använder blågröna distributioner anger du det här fältet till default. Värdet måste börja med en bokstav och endast bestå av gemener och siffror.

Package - Paket eller mapp
string. Valfritt. Använd när Action = Deploy && DeploymentType = Artifacts. Standardvärde: $(System.DefaultWorkingDirectory)/**/*.jar.

Filsökvägen till paketet eller mappen som innehåller innehållet i Azure Spring Apps-appen (.jar fil för Java, .zip för .NET Core).
Variabler (build release | ) och jokertecken stöds.
Till exempel $(System.DefaultWorkingDirectory)/**/*.jar

Builder - Builder
string. Valfritt. Använd när Action = Deploy && DeploymentType = Artifacts.

Välj en byggare av VMware Tanzu® Build Service™. Detta kan användas på företagsnivå.
Detaljerad beskrivning finns i Använda Tanzu Build Service.

RegistryServer - Registerserver
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer. Standardvärde: docker.io.

Registret för containeravbildningen. Standard: docker.io.

RegistryUsername - Registeranvändarnamn
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer.

Användarnamnet för containerregistret.

RegistryPassword - Registerlösenord
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer.

Lösenordet för containerregistret.

ImageName - Bildnamn och tagg
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer. Standardvärde: hello-world:v1.

Taggen containeravbildning.

ImageCommand - Bildkommando
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer.

Kommandot för containeravbildningen.

ImageArgs - Bildargument
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer.

Argumenten för containeravbildningen.

ImageLanguageFramework - Language Framework
string. Valfritt. Använd när Action = Deploy && DeploymentType = CustomContainer. Tillåtna värden: springboot.

EnvironmentVariables - Miljövariabler
string. Valfritt. Använd när Action = Deploy.

Miljövariablerna som ska anges med hjälp av syntaxen -key value (till exempel: -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Värden som innehåller blanksteg ska omges av dubbla citattecken (till exempel: "Eastern Standard Time").

JvmOptions - JVM-alternativ
string. Valfritt. Använd när Action = Deploy && DeploymentType = Artifacts.

Redigerar appens JVM-alternativ. En sträng som innehåller JVM-alternativ, till exempel -Xms1024m -Xmx2048m.

RuntimeVersion - Körningsversion
string. Valfritt. Använd när Action = Deploy && DeploymentType = Artifacts. Tillåtna värden: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Standardvärde: Java_11.

Körningsversionen som appen ska köras på.

DotNetCoreMainEntryPath - Huvudpostsökväg
string. Valfritt. Använd när RuntimeVersion = NetCore_31.

Sökvägen till den körbara .NET-filen i förhållande till zip-roten.

Version - Version
string. Valfritt. Använd när Action = Deploy.

Distributionsversionen. Om den inte anges lämnas versionen oförändrad.

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Den här aktiviteten definierar följande utdatavariabler, som du kan använda i underordnade steg, jobb och faser.

testEndpoint
Endast efter åtgärden "Distribuera". Innehåller privat URL för åtkomst till den uppdaterade distributionen.

Kommentarer

Använd den här uppgiften för att distribuera program till Azure Spring Apps och för att hantera Azure Spring Cloud-distributioner.

Viktigt

Den här uppgiften stöds i Azure Spring Apps Basic-/Standard- och Enterprise-planer. Mer information finns i Automatisera programdistributioner till Azure Spring Apps.

Exempel

I följande exempel visas vanliga användningsscenarier. Mer information finns i Automatisera programdistributioner till Azure Spring Apps.

Ta bort en mellanlagringsdistribution

Med åtgärden "Ta bort mellanlagringsdistribution" kan du ta bort distributionen som inte tar emot produktionstrafik. Detta frigör resurser som används av distributionen och gör plats för en ny mellanlagringsdistribution:

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

Distribuera

Till produktion

I följande exempel distribueras till standardproduktionsdistributionen i Azure Spring Apps. Det här är det enda möjliga distributionsscenariot när du använder basic-SKU:n:

Anteckning

Paketsökningsmönstret bör bara returnera exakt ett paket. Om bygguppgiften skapar flera JAR-paket, till exempel sources.jar och javadoc.jar, måste du förfina sökmönstret så att det bara matchar programmets binära artefakt.

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'

Blågrön

I följande exempel distribueras till en befintlig mellanlagringsdistribution. Den här distributionen tar inte emot produktionstrafik förrän den har angetts som en produktionsdistribution.

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'

Mer information om blågröna distributioner, inklusive en alternativ metod, finns i Blågröna distributionsstrategier.

Ställa in produktionsdistribution

I följande exempel anges den aktuella mellanlagringsdistributionen som produktion, vilket i praktiken växlar vilken distribution som tar emot produktionstrafik.

variables:
  azureSubscription: Contoso

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

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
Krav	Ingen
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	2.104.1 eller senare
Uppgiftskategori	Distribuera