AzureSpringCloud@0: Azure Spring Apps v0-Aufgabe

Diese Aufgabe stellt Anwendungen in Azure Spring Apps bereit und verwaltet diese Bereitstellungen.

Wichtig

Diese Aufgabe wird von Azure Spring Apps Basic/Standard- und Enterprise-Plänen unterstützt. Weitere Informationen finden Sie unter Automatisieren von Anwendungsbereitstellungen in 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.

Eingaben

azureSubscription - Azure-Abonnement
Eingabealias: ConnectedServiceName. string. Erforderlich.

Gibt das Azure Resource Manager-Abonnement für die Bereitstellung an.

Action - Aktion
string. Erforderlich. Zulässige Werte: Deploy, Set Production (Produktionsbereitstellung festlegen), Delete Staging Deployment. Standardwert. Deploy.

Die Aktion, die in Azure Spring Apps ausgeführt werden soll.

AzureSpringCloud - Azure Spring Apps Name
string. Erforderlich.

Der Name oder die Ressourcen-ID der bereitzustellenden Azure Spring Apps-instance.

AppName - App
string. Erforderlich.

Der Name der bereitzustellenden Azure Spring Apps-App. Die App muss vor der Ausführung des Tasks vorhanden sein.

DeploymentType - Bereitstellungstyp
string. Optional. Verwenden Sie , wenn Action = Deploy. Zulässige Werte: Artifacts, CustomContainer (benutzerdefinierter Container). Standardwert. Artifacts.

Wählen Sie zum Bereitstellen mit Quellcode oder Java-Paketen "Artefakte" aus. Wählen Sie zum Bereitstellen mit einem Containerimage "Benutzerdefinierter Container" aus.

UseStagingDeployment - Verwenden der Stagingbereitstellung
boolean. Optional. Verwenden Sie , wenn Action = Deploy || Action = Set Production. Standardwert. true.

Zu dem Zeitpunkt, zu dem die Aufgabe ausgeführt wird, wählt diese Eingabe automatisch die Bereitstellung aus, die als stagingfestgelegt ist.

Wenn auf truefestgelegt ist, wenden Sie die Aufgabe auf die Bereitstellung an, die zum Zeitpunkt der Ausführung als Stagingbereitstellung festgelegt ist. Wenn er nicht angegeben wird, muss der DeploymentName Parameter festgelegt werden.

CreateNewDeployment - Erstellen Sie eine neue Stagingbereitstellung, falls keine vorhanden ist.
boolean. Optional. Verwenden Sie , wenn Action = Deploy && UseStagingDeployment = false. Standardwert. false.

Wenn auf truefestgelegt ist und die von DeploymentName angegebene Bereitstellung zur Ausführungszeit nicht vorhanden ist, wird sie erstellt. Wenn er nicht angegeben wird, muss der DeploymentName Parameter festgelegt werden.

DeploymentName - Einsatz
string. Optional. Verwenden Sie , wenn UseStagingDeployment = false && Action != Delete Staging Deployment.

Die Bereitstellung , auf die diese Aufgabe angewendet wird. Wenn Sie keine blau-grünen Bereitstellungen verwenden, legen Sie dieses Feld auf fest default. Der Wert darf mit einem Buchstaben beginnen und nur aus Kleinbuchstaben und Zahlen bestehen.

Package - Paket oder Ordner
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = Artifacts. Standardwert. $(System.DefaultWorkingDirectory)/**/*.jar.

Der Dateipfad zu dem Paket oder Ordner, das den Inhalt der Azure Spring Apps-App enthält (.jar Datei für Java, .zip für .NET Core).
Variablen (Buildrelease | ) und Wildcards werden unterstützt.
Zum Beispiel, $(System.DefaultWorkingDirectory)/**/*.jar

Builder - Bauherr
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = Artifacts.

Wählen Sie einen Ersteller von VMware Tanzu® Build Service™ aus. Dieser kann im Enterprise-Tarif verwendet werden.
Eine ausführliche Beschreibung finden Sie unter Tanzu Build Service verwenden.

RegistryServer - Registrierungsserver
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer. Standardwert. docker.io.

Die Registrierung des Containerimages. Standard: docker.io.

RegistryUsername - Registrierungsbenutzername
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer.

Der Benutzername der Containerregistrierung.

RegistryPassword - Registrierungskennwort
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer.

Das Kennwort der Containerregistrierung.

ImageName - Bildname und Tag
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer. Standardwert. hello-world:v1.

Das Containerimagetag.

ImageCommand - Image-Befehl
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer.

Der Befehl des Containerimages.

ImageArgs - Bildargumente
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer.

Die Argumente des Containerimages.

ImageLanguageFramework - Sprachframework
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = CustomContainer. Zulässige Werte: springboot.

EnvironmentVariables - Umgebungsvariablen
string. Optional. Verwenden Sie , wenn Action = Deploy.

Die Umgebungsvariablen, die mithilfe der Syntax -key value eingegeben werden sollen (z. B. ). -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE Werte, die Leerzeichen enthalten, sollten in doppelte Anführungszeichen eingeschlossen werden (z. B. ). "Eastern Standard Time"

JvmOptions - JVM-Optionen
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = Artifacts.

Bearbeitet die JVM-Optionen der App. Eine Zeichenfolge, die JVM-Optionen enthält, z. B -Xms1024m -Xmx2048m. .

RuntimeVersion - Laufzeitversion
string. Optional. Verwenden Sie , wenn Action = Deploy && DeploymentType = Artifacts. Zulässige Werte: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.NET Core 3.1). Standardwert. Java_11.

Die Laufzeitversion, unter der die App ausgeführt wird.

DotNetCoreMainEntryPath - Haupteintragspfad
string. Optional. Verwenden Sie , wenn RuntimeVersion = NetCore_31.

Der Pfad zur ausführbaren .NET-Datei relativ zum ZIP-Stamm.

Version - Version
string. Optional. Verwenden Sie , wenn Action = Deploy.

Die Bereitstellungsversion. Wenn sie nicht festgelegt ist, bleibt die Version unverändert.

Optionen für die Vorgangskontrolle

Alle Vorgänge verfügen zusätzlich zu ihren Eingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerungsoptionen und allgemeine Aufgabeneigenschaften.

Ausgabevariablen

Diese Aufgabe definiert die folgenden Ausgabevariablen, die Sie in nachgelagerten Schritten, Aufträgen und Phasen nutzen können.

testEndpoint
Nur nach der Aktion "Bereitstellen". Enthält eine private URL für den Zugriff auf die aktualisierte Bereitstellung.

Hinweise

Verwenden Sie diese Aufgabe, um Anwendungen in Azure Spring Apps bereitzustellen und Azure Spring Cloud-Bereitstellungen zu verwalten.

Wichtig

Diese Aufgabe wird in Azure Spring Apps Basic/Standard- und Enterprise-Plänen unterstützt. Weitere Informationen finden Sie unter Automatisieren von Anwendungsbereitstellungen in Azure Spring Apps.

Beispiele

Die folgenden Beispiele veranschaulichen gängige Verwendungsszenarien. Weitere Informationen finden Sie unter Automatisieren von Anwendungsbereitstellungen in Azure Spring Apps.

Zurückspeicherungs-Bereitstellung löschen

Mit der Aktion „Zurückspeicherungs-Bereitstellung löschen“ können Sie die Bereitstellung löschen, die keinen Produktionsdatenverkehr empfängt. Dadurch werden von dieser Bereitstellung verwendete Ressourcen freigegeben und Platz für eine neue Zurückspeicherungs-Bereitstellung geschaffen:

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

Wird bereitgestellt

In einer Produktionsumgebung

Im folgenden Beispiel wird in der Standardproduktionsbereitstellung in Azure Spring Apps bereitgestellt. Dies ist das einzig mögliche Bereitstellungsszenario bei Verwendung der Basic-SKU:

Hinweis

Das Paketsuchmuster sollte nur genau ein Paket zurückgeben. Wenn die Buildaufgabe mehrere JAR-Pakete wie sources.jar und javadoc.jar erzeugt, müssen Sie das Suchmuster verfeinern, damit es nur mit dem binären Artefakte der Anwendung übereinstimmt.

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'

Blau-grün

Im folgenden Beispiel wird eine Bereitstellung in einer bereits vorhandenen Stagingbereitstellung durchgeführt. Diese Verteilung erhält keinen Produktionsdatenverkehr, bis sie als Produktionsbereitstellung festgelegt wird.

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'

Weitere Informationen zu Blau-Grün-Bereitstellungen, einschließlich eines alternativen Ansatzes, finden Sie unter Blau-Grün-Bereitstellungsstrategien.

Produktionsbereitstellung festlegen

Im folgenden Beispiel wird die aktuelle Stagingbereitstellung als Produktion festgelegt. Dabei wird effektiv ausgetauscht, welche Bereitstellung Produktionsdatenverkehr empfängt.

variables:
  azureSubscription: Contoso

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

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Klassischer Build, klassische Version
Wird ausgeführt auf	Agent, DeploymentGroup
Forderungen	Keine
Capabilities	Diese Aufgabe erfüllt keine Anforderungen an nachfolgende Aufgaben im Auftrag.
Befehlseinschränkungen	Any
Einstellbare Variablen	Any
Agent-Version	2.104.1 oder höher
Aufgabenkategorie	Bereitstellen