AzureSpringCloud@0 - Azure Spring Apps v0-taak

Met deze taak worden toepassingen geïmplementeerd in Azure Spring Apps en worden deze implementaties beheerd.

Belangrijk

Deze taak wordt ondersteund in Azure Spring Apps Basic/Standard en Enterprise-abonnementen. Zie Toepassingsimplementaties automatiseren in Azure Spring Apps voor meer informatie.

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.

Invoerwaarden

azureSubscription - Azure-abonnement
Invoeralias: ConnectedServiceName. string. Vereist.

Hiermee geeft u het Azure Resource Manager-abonnement voor de implementatie.

Action - Actie
string. Vereist. Toegestane waarden: Deploy, Set Production (Productie-implementatie instellen), Delete Staging Deployment. Standaardwaarde: Deploy.

De actie die moet worden uitgevoerd op Azure Spring Apps.

AzureSpringCloud - Naam van Azure Spring Apps
string. Vereist.

De naam of resource-id van het Azure Spring Apps-exemplaar dat moet worden geïmplementeerd.

AppName - App
string. Vereist.

De naam van de Azure Spring Apps-app die moet worden geïmplementeerd. De app moet bestaan voordat de taak wordt uitgevoerd.

DeploymentType - Implementatietype
string. Optioneel. Gebruik wanneer Action = Deploy. Toegestane waarden: Artifacts, CustomContainer (aangepaste container). Standaardwaarde: Artifacts.

Als u wilt implementeren met broncode of Java-pakket, kiest u Artefacten; Als u wilt implementeren met containerinstallatiekopieën, kiest u 'Aangepaste container'.

UseStagingDeployment - Faseringsimplementatie gebruiken
boolean. Optioneel. Gebruik wanneer Action = Deploy || Action = Set Production. Standaardwaarde: true.

Op het moment dat de taak wordt uitgevoerd, selecteert deze invoer automatisch de implementatie die is ingesteld als staging.

Als dit is ingesteld op true, past u de taak toe op de implementatie die is ingesteld als de faseringsimplementatie op het moment van uitvoering. Als u dit weglaat, moet de DeploymentName parameter worden ingesteld.

CreateNewDeployment - Maak een nieuwe faseringsimplementatie als deze nog niet bestaat.
boolean. Optioneel. Gebruik wanneer Action = Deploy && UseStagingDeployment = false. Standaardwaarde: false.

Als deze is ingesteld op trueen de implementatie die is opgegeven door DeploymentName niet bestaat tijdens de uitvoering, wordt deze gemaakt. Als u dit weglaat, moet de DeploymentName parameter worden ingesteld.

DeploymentName - Implementatie
string. Optioneel. Gebruik wanneer UseStagingDeployment = false && Action != Delete Staging Deployment.

De implementatie waarop deze taak van toepassing is. Als u geen blauw-groene implementaties gebruikt, stelt u dit veld in op default. De waarde moet beginnen met een letter en alleen uit kleine letters en cijfers bestaan.

Package - Pakket of map
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = Artifacts. Standaardwaarde: $(System.DefaultWorkingDirectory)/**/*.jar.

Het bestandspad naar het pakket of de map met de inhoud van de Azure Spring Apps-app (.jar bestand voor Java, .zip voor .NET Core).
Variabelen (buildrelease | ) en jokertekens worden ondersteund.
Bijvoorbeeld: $(System.DefaultWorkingDirectory)/**/*.jar

Builder - Builder
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = Artifacts.

Selecteer een builder van VMware Tanzu® Build Service™. Deze kan worden gebruikt in de enterprise-laag.
Raadpleeg Tanzu Build-service gebruiken voor een gedetailleerde beschrijving.

RegistryServer - Registerserver
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer. Standaardwaarde: docker.io.

Het register van de containerinstallatiekopieën. Standaardinstelling: docker.io.

RegistryUsername - Registergebruikersnaam
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer.

De gebruikersnaam van het containerregister.

RegistryPassword - Registerwachtwoord
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer.

Het wachtwoord van het containerregister.

ImageName - Naam en tag van installatiekopieën
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer. Standaardwaarde: hello-world:v1.

De tag containerinstallatiekopieën.

ImageCommand - Opdracht Installatiekopieën
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer.

De opdracht van de containerinstallatiekopieën.

ImageArgs - Argumenten voor afbeelding
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer.

De argumenten van de containerinstallatiekopieën.

ImageLanguageFramework - Taalframework
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = CustomContainer. Toegestane waarden: springboot.

EnvironmentVariables - Omgevingsvariabelen
string. Optioneel. Gebruik wanneer Action = Deploy.

De omgevingsvariabelen die moeten worden ingevoerd met behulp van de syntaxis -key value (bijvoorbeeld: -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Waarden die spaties bevatten, moeten tussen dubbele aanhalingstekens worden geplaatst (bijvoorbeeld: "Eastern Standard Time").

JvmOptions - JVM-opties
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = Artifacts.

Hiermee bewerkt u de JVM-opties van de app. Een tekenreeks met JVM-opties, zoals -Xms1024m -Xmx2048m.

RuntimeVersion - Runtime-versie
string. Optioneel. Gebruik wanneer Action = Deploy && DeploymentType = Artifacts. Toegestane waarden: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Standaardwaarde: Java_11.

De runtimeversie waarop de app wordt uitgevoerd.

DotNetCoreMainEntryPath - Hoofdinvoerpad
string. Optioneel. Gebruik wanneer RuntimeVersion = NetCore_31.

Het pad naar het uitvoerbare .NET-bestand ten opzichte van de zip-hoofdmap.

Version - Versie
string. Optioneel. Gebruik wanneer Action = Deploy.

De implementatieversie. Als dit niet is ingesteld, blijft de versie ongewijzigd.

Opties voor taakbeheer

Alle taken hebben besturingsopties naast hun taakinvoer. Zie Opties voor besturingselementen en algemene taakeigenschappen voor meer informatie.

Uitvoervariabelen

Deze taak definieert de volgende uitvoervariabelen, die u kunt gebruiken in downstreamstappen, taken en fasen.

testEndpoint
Alleen na de actie Implementeren. Bevat een persoonlijke URL voor toegang tot de bijgewerkte implementatie.

Opmerkingen

Gebruik deze taak om toepassingen te implementeren in Azure Spring Apps en om Azure Spring Cloud-implementaties te beheren.

Belangrijk

Deze taak wordt ondersteund in Azure Spring Apps Basic-/Standard- en Enterprise-abonnementen. Zie Implementaties van toepassingen automatiseren naar Azure Spring Apps voor meer informatie.

Voorbeelden

In de volgende voorbeelden ziet u veelvoorkomende gebruiksscenario's. Zie Implementaties van toepassingen automatiseren naar Azure Spring Apps voor meer informatie.

Een faseringsimplementatie verwijderen

Met de actie 'Faseringsimplementatie verwijderen' kunt u de implementatie verwijderen die geen productieverkeer ontvangt. Hierdoor worden resources vrijgemaakt die door die implementatie worden gebruikt en is er ruimte voor een nieuwe faseringsimplementatie:

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

Implementeren

Naar productie

In het volgende voorbeeld wordt de standaardproductie-implementatie geïmplementeerd in Azure Spring Apps. Dit is het enige mogelijke implementatiescenario bij het gebruik van de Basic-SKU:

Notitie

Het zoekpatroon voor pakketten mag slechts precies één pakket retourneren. Als de build-taak meerdere JAR-pakketten produceert, zoals sources.jar en javadoc.jar, moet u het zoekpatroon verfijnen zodat het alleen overeenkomt met het binaire artefact van de toepassing.

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'

Blauwgroen

In het volgende voorbeeld wordt geïmplementeerd in een bestaande faseringsimplementatie. Deze implementatie ontvangt geen productieverkeer totdat deze is ingesteld als een productie-implementatie.

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'

Zie Blauw-groene implementatiestrategieën voor meer informatie over blauw-groene implementaties, waaronder een alternatieve benadering.

Productie-implementatie instellen

In het volgende voorbeeld wordt de huidige faseringsimplementatie ingesteld als productie, waarbij effectief wordt gewisseld welke implementatie productieverkeer ontvangt.

variables:
  azureSubscription: Contoso

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

Vereisten

Vereiste	Beschrijving
Pijplijntypen	YAML, klassieke build, klassieke release
Wordt uitgevoerd op	Agent, DeploymentGroup
Eisen	Geen
Functies	Deze taak voldoet niet aan eventuele vereisten voor volgende taken in de taak.
Opdrachtbeperkingen	Alle
Instelbare variabelen	Alle
Agentversie	2.104.1 of hoger
Taakcategorie	Implementeren