AzureSpringCloud@0 - Tâche Azure Spring Apps v0

Article
07/02/2024

Cette tâche déploie des applications dans Azure Spring Apps et gère ces déploiements.

Important

Cette tâche est prise en charge sur les plans Azure Spring Apps Basic/Standard et Enterprise. Pour plus d’informations, consultez Automatiser les déploiements d’applications sur 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.

Entrées

azureSubscription - Abonnement Azure
Alias d’entrée : ConnectedServiceName. string. Obligatoire.

Spécifie l’abonnement Azure Resource Manager pour le déploiement.

Action - Action
string. Obligatoire. Valeurs autorisées : Deploy, Set Production (Définir le déploiement de production), Delete Staging Deployment. Valeur par défaut : Deploy.

Action à effectuer sur Azure Spring Apps.

AzureSpringCloud - Nom d’Azure Spring Apps
string. Obligatoire.

Nom ou ID de ressource du instance Azure Spring Apps à déployer.

AppName - Application
string. Obligatoire.

Nom de l’application Azure Spring Apps à déployer. L’application doit exister avant l’exécution de la tâche.

DeploymentType - Type de déploiement
string. facultatif. Utilisez quand Action = Deploy. Valeurs autorisées : Artifacts, CustomContainer (Conteneur personnalisé). Valeur par défaut : Artifacts.

Pour déployer avec du code source ou un package Java, choisissez « Artefacts » ; Pour déployer avec l’image conteneur, choisissez « Conteneur personnalisé ».

UseStagingDeployment - Utiliser le déploiement intermédiaire
boolean. facultatif. Utilisez quand Action = Deploy || Action = Set Production. Valeur par défaut : true.

Au moment de l’exécution de la tâche, cette entrée sélectionne automatiquement le déploiement défini comme staging.

Si la valeur trueest définie sur , appliquez la tâche au déploiement défini comme déploiement intermédiaire au moment de l’exécution. S’il est omis, le paramètre DeploymentName doit être défini.

CreateNewDeployment - Créez un déploiement intermédiaire s’il n’en existe pas.
boolean. facultatif. Utilisez quand Action = Deploy && UseStagingDeployment = false. Valeur par défaut : false.

Si la valeur est définie truesur et que le déploiement spécifié par DeploymentName n’existe pas au moment de l’exécution, il est créé. S’il est omis, le paramètre DeploymentName doit être défini.

DeploymentName - Déploiement
string. facultatif. Utilisez quand UseStagingDeployment = false && Action != Delete Staging Deployment.

Déploiement auquel cette tâche s’applique. Si vous n’utilisez pas de déploiements bleu-vert, définissez ce champ sur default. La valeur doit commencer par une lettre et se composer de lettres minuscules et de chiffres uniquement.

Package - Package ou dossier
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = Artifacts. Valeur par défaut : $(System.DefaultWorkingDirectory)/**/*.jar.

Chemin du fichier du package ou dossier contenant le contenu de l’application Azure Spring Apps (.jar fichier pour Java, .zip pour .NET Core).
Les variables ( Build | Release) et les caractères génériques sont pris en charge.
Par exemple : $(System.DefaultWorkingDirectory)/**/*.jar

Package - Package ou dossier
string. facultatif. Utilisez quand Action = Deploy. Valeur par défaut : $(System.DefaultWorkingDirectory)/**/*.jar.

Builder - Constructeur
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = Artifacts.

Sélectionnez un générateur de VMware Tanzu® Build Service™. Vous pouvez l’utiliser au niveau Entreprise.
Pour obtenir une description détaillée, veuillez case activée Utiliser le service de build Tanzu.

RegistryServer - Serveur du Registre
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer. Valeur par défaut : docker.io.

Registre de l’image conteneur. Valeur par défaut : docker.io.

RegistryUsername - Nom d’utilisateur du Registre
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer.

Nom d’utilisateur du registre de conteneurs.

RegistryPassword - Mot de passe du Registre
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer.

Mot de passe du registre de conteneurs.

ImageName - Nom de l’image et balise
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer. Valeur par défaut : hello-world:v1.

Balise d’image conteneur.

ImageCommand - Commande Image
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer.

Commande de l’image conteneur.

ImageArgs - Arguments d’image
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer.

Arguments de l’image conteneur.

ImageLanguageFramework - Framework de langage
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = CustomContainer. Valeurs autorisées : springboot.

EnvironmentVariables - Variables d’environnement
string. facultatif. Utilisez quand Action = Deploy.

Variables d’environnement à entrer à l’aide de la syntaxe -key value (par exemple : -CUSTOMER_NAME Contoso-WEBSITE_TIME_ZONE). Les valeurs contenant des espaces doivent être placées entre guillemets doubles (par exemple : "Eastern Standard Time").

JvmOptions - JVM Options
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = Artifacts.

Modifie les options JVM de l’application. Chaîne contenant des options JVM, telles que -Xms1024m -Xmx2048m.

JvmOptions - JVM Options
string. facultatif. Utilisez quand Action = Deploy.

Modifie les options JVM de l’application. Chaîne contenant des options JVM, telles que -Xms1024m -Xmx2048m.

RuntimeVersion - Runtime Version
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = Artifacts. Valeurs autorisées : Java_8 (Java 8), Java_11 (Java 11), Java_17 (Java 17), Java_21 (Java 21), NetCore_31 (.Net Core 3.1). Valeur par défaut : Java_11.

Version du runtime sur laquelle l’application s’exécutera.

RuntimeVersion - Runtime Version
string. facultatif. Utilisez quand Action = Deploy && DeploymentType = Artifacts. Valeurs autorisées : Java_8 (Java 8), Java_11 (Java 11), NetCore_31 (.Net Core 3.1). Valeur par défaut : Java_11.

Version du runtime sur laquelle l’application s’exécutera.

RuntimeVersion - Runtime Version
string. facultatif. Utilisez quand Action = Deploy. Valeurs autorisées : Java_8 (Java 8), Java_11 (Java 11), NetCore_31 (.Net Core 3.1). Valeur par défaut : Java_11.

Version du runtime sur laquelle l’application s’exécutera.

DotNetCoreMainEntryPath - Chemin d’accès à l’entrée principale
string. facultatif. Utilisez quand RuntimeVersion = NetCore_31.

Chemin d’accès à l’exécutable .NET relatif à la racine zip.

Version - Version
string. facultatif. Utilisez quand Action = Deploy.

Version du déploiement. Si elle n’est pas définie, la version reste inchangée.

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Cette tâche définit les variables de sortie suivantes, que vous pouvez utiliser dans les étapes, les travaux et les étapes en aval.

testEndpoint
Après l’action « Déployer » uniquement. Contient une URL privée pour accéder au déploiement mis à jour.

Remarques

Utilisez cette tâche pour déployer des applications sur Azure Spring Apps et pour gérer les déploiements Azure Spring Cloud.

Important

Exemples

Les exemples suivants illustrent des scénarios d’utilisation courante. Pour plus d’informations, consultez Automatiser les déploiements d’applications sur Azure Spring Apps.

Supprimer un déploiement de préproduction

L’action « Supprimer le déploiement de préproduction » vous permet de supprimer le déploiement qui ne reçoit pas le trafic de production. Cela libère les ressources utilisées par ce déploiement et fait de la place pour un nouveau déploiement de préproduction :

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

Déploiement en cours

En production

L’exemple suivant est déployé dans le déploiement de production par défaut dans Azure Spring Apps. Il s’agit du seul scénario de déploiement possible avec la référence SKU de base :

Notes

Le modèle de recherche de package ne doit retourner qu’un seul package. Si la tâche de build produit plusieurs packages JAR tels que sources.jar et javadoc.jar, vous devez affiner le modèle de recherche afin qu’il corresponde uniquement à l’artefact binaire de l’application.

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'

Bleu-vert

L’exemple suivant se déploie sur un déploiement intermédiaire préexistant. Ce déploiement ne reçoit pas le trafic de production tant qu’il n’est pas défini comme déploiement de production.

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'

Pour en savoir plus sur les déploiements bleu-vert et la présentation d’une autre approche, consultez Stratégies de déploiement bleu-vert.

Définition du déploiement de production

L’exemple suivant définit le déploiement intermédiaire actuel en tant que production, en permutant efficacement le déploiement qui reçoit le trafic de production.

variables:
  azureSubscription: Contoso

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

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique, version classique
S’exécute sur	Agent, DeploymentGroup
Demandes	None
Capabilities	Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commandes	Quelconque
Variables settables	Quelconque
Version de l’agent	2.104.1 ou version ultérieure
Catégorie de la tâche	Déployer

Partager via

AzureSpringCloud@0 - Tâche Azure Spring Apps v0

Syntax

Entrées

Options de contrôle de la tâche

Variables de sortie

Remarques

Exemples

Supprimer un déploiement de préproduction

Déploiement en cours

En production

Bleu-vert

Définition du déploiement de production

Configuration requise

Commentaires

Ressources supplémentaires