AzureSpringCloud@0 — zadanie usługi Azure Spring Apps w wersji 0

To zadanie wdraża aplikacje w usłudze Azure Spring Apps i zarządza tymi wdrożeniami.

Ważne

To zadanie jest obsługiwane w planach Usługi Azure Spring Apps w warstwie Podstawowa/Standardowa i Enterprise. Aby uzyskać więcej informacji, zobacz Automatyzowanie wdrożeń aplikacji w usłudze Azure Spring Apps.

Składnia

# 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.

Dane wejściowe

azureSubscription - Subskrypcja platformy Azure
Alias wejściowy: ConnectedServiceName. string. Wymagane.

Określa subskrypcję usługi Azure Resource Manager dla wdrożenia.

Action - Działania
string. Wymagane. Dozwolone wartości: Deploy, Set Production (Ustaw wdrożenie produkcyjne), Delete Staging Deployment. Wartość domyślna: Deploy.

Akcja do wykonania w usłudze Azure Spring Apps.

AzureSpringCloud - Nazwa usługi Azure Spring Apps
string. Wymagane.

Nazwa lub identyfikator zasobu wystąpienia usługi Azure Spring Apps do wdrożenia.

AppName - App
string. Wymagane.

Nazwa aplikacji Azure Spring Apps do wdrożenia. Aplikacja musi istnieć przed wykonaniem zadania.

DeploymentType - Typ wdrożenia
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy. Dozwolone wartości: Artifacts, CustomContainer (Kontener niestandardowy). Wartość domyślna: Artifacts.

Aby wdrożyć za pomocą kodu źródłowego lub pakietu Java, wybierz pozycję "Artefakty"; Aby wdrożyć za pomocą obrazu kontenera, wybierz pozycję "Kontener niestandardowy".

UseStagingDeployment - Korzystanie z wdrożenia przejściowego
boolean. Opcjonalny. Użyj polecenia , gdy Action = Deploy || Action = Set Production. Wartość domyślna: true.

W momencie uruchomienia zadania te dane wejściowe automatycznie wybierają wdrożenie ustawione jako staging.

Jeśli ustawiono wartość true, zastosuj zadanie do wdrożenia ustawionego jako wdrożenie przejściowe w czasie wykonywania. Jeśli pominięto, DeploymentName należy ustawić parametr .

CreateNewDeployment - Utwórz nowe wdrożenie przejściowe, jeśli nie istnieje.
boolean. Opcjonalny. Użyj polecenia , gdy Action = Deploy && UseStagingDeployment = false. Wartość domyślna: false.

Jeśli ustawiono wartość true, a wdrożenie określone przez DeploymentName nie istnieje w czasie wykonywania, zostanie utworzone. Jeśli pominięto, DeploymentName należy ustawić parametr .

DeploymentName - Wdrażania
string. Opcjonalny. Użyj polecenia , gdy UseStagingDeployment = false && Action != Delete Staging Deployment.

Wdrożenie, do którego zostanie zastosowane to zadanie. Jeśli nie używasz wdrożeń niebieski-zielony, ustaw to pole na default. Wartość musi zaczynać się literą i składać się tylko z małych liter i cyfr.

Package - Pakiet lub folder
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = Artifacts. Wartość domyślna: $(System.DefaultWorkingDirectory)/**/*.jar.

Ścieżka pliku do pakietu lub folderu zawierającego zawartość aplikacji Azure Spring Apps (.jar plik dla języka Java, .zip dla platformy .NET Core).
Obsługiwane są zmienne (wersjakompilacji | ) i symbole wieloznaczne.
Na przykład $(System.DefaultWorkingDirectory)/**/*.jar

Builder - Program report builder
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = Artifacts.

Wybierz konstruktora usługi VMware Tanzu® Build Service™. Może to być używane w warstwie przedsiębiorstwa.
Aby uzyskać szczegółowy opis, zobacz Korzystanie z usługi Tanzu Build Service.

RegistryServer - Serwer rejestru
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer. Wartość domyślna: docker.io.

Rejestr obrazu kontenera. Ustawienie domyślne: docker.io.

RegistryUsername - Nazwa użytkownika rejestru
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer.

Nazwa użytkownika rejestru kontenerów.

RegistryPassword - Hasło rejestru
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer.

Hasło rejestru kontenerów.

ImageName - Nazwa obrazu i tag
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer. Wartość domyślna: hello-world:v1.

Tag obrazu kontenera.

ImageCommand - Polecenie obrazu
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer.

Polecenie obrazu kontenera.

ImageArgs - Argumenty obrazów
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer.

Argumenty obrazu kontenera.

ImageLanguageFramework - Struktura języka
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = CustomContainer. Dozwolone wartości: springboot.

EnvironmentVariables - Zmienne środowiskowe
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy.

Zmienne środowiskowe, które mają zostać wprowadzone przy użyciu składni -key value (na przykład : -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Wartości zawierające spacje powinny być ujęte w cudzysłowy podwójne (na przykład: "Eastern Standard Time").

JvmOptions - Opcje maszyny wirtualnej JVM
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = Artifacts.

Edytuje opcje JVM aplikacji. Ciąg zawierający opcje JVM, takie jak -Xms1024m -Xmx2048m.

RuntimeVersion - Wersja środowiska uruchomieniowego
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy && DeploymentType = Artifacts. Dozwolone wartości: Java_8 (Java 8), Java_11 (Java 11), (Java 17), Java_17Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Wartość domyślna: Java_11.

Wersja środowiska uruchomieniowego, w której będzie uruchamiana aplikacja.

DotNetCoreMainEntryPath - Ścieżka wpisu głównego
string. Opcjonalny. Użyj polecenia , gdy RuntimeVersion = NetCore_31.

Ścieżka do pliku wykonywalnego platformy .NET względem katalogu głównego zip.

Version - Wersja
string. Opcjonalny. Użyj polecenia , gdy Action = Deploy.

Wersja wdrożenia. Jeśli nie zostanie ustawiona, wersja pozostanie niezmieniona.

Opcje sterowania zadania

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań. Aby uzyskać więcej informacji, zobacz Opcje sterowania i typowe właściwości zadań.

Zmienne wyjściowe

To zadanie definiuje następujące zmienne wyjściowe, które można używać w krokach podrzędnych, zadaniach i etapach.

testEndpoint
Tylko po akcji "Wdróż". Zawiera prywatny adres URL umożliwiający uzyskanie dostępu do zaktualizowanego wdrożenia.

Uwagi

To zadanie służy do wdrażania aplikacji w usłudze Azure Spring Apps i zarządzania wdrożeniami usługi Azure Spring Cloud.

Ważne

To zadanie jest obsługiwane w planach Usługi Azure Spring Apps w warstwie Podstawowa/Standardowa i Enterprise. Aby uzyskać więcej informacji, zobacz Automatyzowanie wdrożeń aplikacji w usłudze Azure Spring Apps.

Przykłady

W poniższych przykładach przedstawiono typowe scenariusze użycia. Aby uzyskać więcej informacji, zobacz Automatyzowanie wdrożeń aplikacji w usłudze Azure Spring Apps.

Usuwanie wdrożenia przejściowego

Akcja "Usuń wdrożenie przejściowe" umożliwia usunięcie wdrożenia, które nie odbiera ruchu produkcyjnego. Spowoduje to zwolnienie zasobów używanych przez to wdrożenie i zapewnienie miejsca na nowe wdrożenie przejściowe:

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

Wdrażanie

Do środowiska produkcyjnego

Poniższy przykład jest wdrażany w domyślnym wdrożeniu produkcyjnym w usłudze Azure Spring Apps. Jest to jedyny możliwy scenariusz wdrażania w przypadku korzystania z jednostki SKU w warstwie Podstawowa:

Uwaga

Wzorzec wyszukiwania pakietów powinien zwracać tylko jeden pakiet. Jeśli zadanie kompilacji tworzy wiele pakietów JAR, takich jak sources.jar i javadoc.jar, należy uściślić wzorzec wyszukiwania, aby był zgodny tylko z artefaktem binarnym aplikacji.

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'

Niebieski-zielony

W poniższym przykładzie wdrożono wdrożenie wstępnie istniejące wdrożenie przejściowe. To wdrożenie nie będzie odbierać ruchu produkcyjnego, dopóki nie zostanie ustawione jako wdrożenie produkcyjne.

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'

Aby uzyskać więcej informacji na temat wdrożeń niebieskich zielonych, w tym alternatywnego podejścia, zobacz Strategie wdrażania Blue-green.

Ustawianie wdrożenia produkcyjnego

Poniższy przykład określa bieżące wdrożenie przejściowe jako produkcyjne, efektywnie zamieniając, który wdrożenie odbiera ruch produkcyjny.

variables:
  azureSubscription: Contoso

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

Wymagania

Wymaganie	Opis
Typy potoków	YAML, kompilacja klasyczna, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Brak
Możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
Ograniczenia poleceń	Dowolne
Zmienne w formie tabeli settable	Dowolne
Wersja agenta	2.104.1 lub nowsza
Kategoria zadania	Wdrażanie