AzureSpringCloud@0 – úloha Azure Spring Apps v0

Článek
07/02/2024

Tato úloha nasadí aplikace do Azure Spring Apps a spravuje tato nasazení.

Důležité

Tato úloha se podporuje v plánech Azure Spring Apps Basic/Standard a Enterprise. Další informace najdete v tématu Automatizace nasazení aplikací do 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.

Vstupy

azureSubscription - Předplatné Azure
Alias vstupu: ConnectedServiceName. string. Povinná hodnota.

Určuje předplatné Azure Resource Manager pro nasazení.

Action - Akce
string. Povinná hodnota. Povolené hodnoty: Deploy, Set Production (Nastavit produkční nasazení), Delete Staging Deployment. Výchozí hodnota: Deploy.

Akce, která se má provést v Azure Spring Apps.

AzureSpringCloud - Název aplikace Azure Spring
string. Povinná hodnota.

Název nebo ID prostředku instance Azure Spring Apps, která se má nasadit.

AppName - App
string. Povinná hodnota.

Název aplikace Azure Spring Apps, která se má nasadit. Aplikace musí existovat před spuštěním úlohy.

DeploymentType - Typ nasazení
string. Nepovinný parametr. Použijte, když Action = Deploy. Povolené hodnoty: Artifacts, CustomContainer (vlastní kontejner). Výchozí hodnota: Artifacts.

Pokud chcete provést nasazení se zdrojovým kódem nebo balíčkem Java, zvolte Artifacts(Artefakty). Pokud chcete provést nasazení s imagí kontejneru, zvolte Vlastní kontejner.

UseStagingDeployment - Použití přípravného nasazení
boolean. Nepovinný parametr. Použijte, když Action = Deploy || Action = Set Production. Výchozí hodnota: true.

Při spuštění úlohy tento vstup automaticky vybere nasazení, které je nastavené jako staging.

Pokud je nastavená na true, použijte úlohu na nasazení , které je v době provádění nastavené jako pracovní nasazení. Pokud je parametr vynechán, DeploymentName musí být nastaven.

CreateNewDeployment - Vytvořte nové pracovní nasazení, pokud neexistuje.
boolean. Nepovinný parametr. Použijte, když Action = Deploy && UseStagingDeployment = false. Výchozí hodnota: false.

Pokud je nastavená hodnota truea nasazení zadané parametrem DeploymentName neexistuje v době spuštění, vytvoří se. Pokud je parametr vynechán, DeploymentName musí být nastaven.

DeploymentName - Nasazení
string. Nepovinný parametr. Použijte, když UseStagingDeployment = false && Action != Delete Staging Deployment.

Nasazení, na které se bude tato úloha vztahovat. Pokud nepoužíváte modrozelená nasazení, nastavte toto pole na default. Hodnota musí začínat písmenem a skládat se pouze z malých písmen a číslic.

Package - Balíček nebo složka
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = Artifacts. Výchozí hodnota: $(System.DefaultWorkingDirectory)/**/*.jar.

Cesta k souboru balíčku nebo složky obsahující obsah aplikace Azure Spring Apps (.jar soubor pro Javu, .zip pro .NET Core).
Podporují se proměnné (verze buildu | ) a zástupné é kóty.
Například $(System.DefaultWorkingDirectory)/**/*.jar.

Package - Balíček nebo složka
string. Nepovinný parametr. Použijte, když Action = Deploy. Výchozí hodnota: $(System.DefaultWorkingDirectory)/**/*.jar.

Builder - Tvůrce
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = Artifacts.

Vyberte tvůrce služby VMware Tanzu® Build Service™, který se dá použít na podnikové úrovni.
Podrobný popis najdete v tématu Použití služby sestavení Tanzu.

RegistryServer - Server registru
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer. Výchozí hodnota: docker.io.

Registr image kontejneru. Výchozí: docker.io.

RegistryUsername - Uživatelské jméno registru
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer.

Uživatelské jméno registru kontejneru.

RegistryPassword - Heslo registru
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer.

Heslo registru kontejneru.

ImageName - Název a značka obrázku
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer. Výchozí hodnota: hello-world:v1.

Značka image kontejneru

ImageCommand - Příkaz Image
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer.

Příkaz image kontejneru.

ImageArgs - Argumenty obrázku
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer.

Argumenty image kontejneru.

ImageLanguageFramework - Language Framework
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = CustomContainer. Povolené hodnoty: springboot.

EnvironmentVariables - Proměnné prostředí
string. Nepovinný parametr. Použijte, když Action = Deploy.

Proměnné prostředí, které se mají zadat pomocí syntaxe -key value (například: -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Hodnoty obsahující mezery by měly být uzavřeny do dvojitých uvozovek (například: "Eastern Standard Time").

JvmOptions - Možnosti prostředí JVM
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = Artifacts.

Upraví možnosti prostředí JVM aplikace. Řetězec obsahující možnosti JVM, například -Xms1024m -Xmx2048m.

JvmOptions - Možnosti prostředí JVM
string. Nepovinný parametr. Použijte, když Action = Deploy.

Upraví možnosti prostředí JVM aplikace. Řetězec obsahující možnosti JVM, například -Xms1024m -Xmx2048m.

RuntimeVersion - Verze modulu runtime
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = Artifacts. Povolené hodnoty: Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Výchozí hodnota: Java_11.

Verze modulu runtime, ve které bude aplikace běžet.

RuntimeVersion - Verze modulu runtime
string. Nepovinný parametr. Použijte, když Action = Deploy && DeploymentType = Artifacts. Povolené hodnoty: Java_8 (Java 8), Java_11 (Java 11), NetCore_31 (.Net Core 3.1). Výchozí hodnota: Java_11.

Verze modulu runtime, ve které bude aplikace běžet.

RuntimeVersion - Verze modulu runtime
string. Nepovinný parametr. Použijte, když Action = Deploy. Povolené hodnoty: Java_8 (Java 8), Java_11 (Java 11), NetCore_31 (.Net Core 3.1). Výchozí hodnota: Java_11.

Verze modulu runtime, ve které bude aplikace běžet.

DotNetCoreMainEntryPath - Hlavní vstupní cesta
string. Nepovinný parametr. Použijte, když RuntimeVersion = NetCore_31.

Cesta ke spustitelnému souboru .NET vzhledem ke kořenovému souboru zip.

Version - Verze
string. Nepovinný parametr. Použijte, když Action = Deploy.

Verze nasazení. Pokud není nastavená, ponechá se verze beze změny.

Možnosti ovládání úloh

Všechny úlohy mají kromě vstupů také možnosti ovládání. Další informace najdete v tématu Možnosti ovládacího prvku a běžné vlastnosti úlohy.

Výstupní proměnné

Tato úloha definuje následující výstupní proměnné, které můžete využívat v podřízených krocích, úlohách a fázích.

testEndpoint
Pouze po akci Nasadit. Obsahuje privátní adresu URL pro přístup k aktualizovanému nasazení.

Poznámky

Tuto úlohu použijte k nasazení aplikací do Azure Spring Apps a ke správě nasazení Azure Spring Cloud.

Důležité

Tato úloha se podporuje v plánech Azure Spring Apps Basic/Standard a Enterprise. Další informace najdete v tématu Automatizace nasazení aplikací do Azure Spring Apps.

Příklady

Následující příklady ukazují běžné scénáře použití. Další informace najdete v tématu Automatizace nasazení aplikací do Azure Spring Apps.

Odstranění přípravného nasazení

Akce Odstranit pracovní nasazení umožňuje odstranit nasazení, které nepřijímá produkční provoz. Tím se uvolní prostředky používané tímto nasazením a uvolní se místo pro nové přípravné nasazení:

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

Nasazení

Do produkčního prostředí

Následující příklad se nasadí do výchozího produkčního nasazení v Azure Spring Apps. Toto je jediný možný scénář nasazení při použití skladové položky Basic:

Poznámka

Vzor vyhledávání balíčků by měl vrátit pouze jeden balíček. Pokud úloha sestavení vytvoří více balíčků JAR, jako jsou sources.jar a javadoc.jar, je potřeba model vyhledávání upřesnit tak, aby odpovídal pouze binárnímu artefaktu aplikace.

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'

Modrozelená

Následující příklad nasadí do již existujícího přípravného nasazení. Toto nasazení nebude přijímat provozní provoz, dokud nebude nastaveno jako produkční nasazení.

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'

Další informace o modrozelených nasazeních, včetně alternativního přístupu, najdete v tématu Strategie nasazení modrozelené.

Nastavení produkčního nasazení

Následující příklad nastaví aktuální pracovní nasazení jako produkční a efektivně prohodí, které nasazení přijímá produkční provoz.

variables:
  azureSubscription: Contoso

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

Požadavky

Požadavek	Popis
Typy kanálů	YAML, classic build, verze Classic
Spustí se	Agent, DeploymentGroup
Požadavky	Žádné
Možnosti	Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze.
Omezení příkazů	Všechny
Nastavitelné proměnné	Všechny
Verze agenta	2.104.1 nebo vyšší
Kategorie úloh	Nasazení

Sdílet prostřednictvím

AzureSpringCloud@0 – úloha Azure Spring Apps v0

Syntax

Vstupy

Možnosti ovládání úloh

Výstupní proměnné

Poznámky

Příklady

Odstranění přípravného nasazení

Nasazení

Do produkčního prostředí

Modrozelená

Nastavení produkčního nasazení

Požadavky

Váš názor

Další materiály