AzureRmWebAppDeployment@2 - tâche déployer Azure App Service v2

Article
01/27/2024

Mettez à jour Azure App Service à l’aide des API REST Web Deploy / Kudu.

Syntax

# Azure App Service Deploy v2
# Update Azure App Service using Web Deploy / Kudu REST APIs.
- task: AzureRmWebAppDeployment@2
  inputs:
    ConnectedServiceName: # string. Required. Azure Subscription. 
    WebAppName: # string. Required. App Service name. 
    #DeployToSlotFlag: false # boolean. Deploy to slot. Default: false.
    #ResourceGroupName: # string. Required when DeployToSlotFlag = true. Resource group. 
    #SlotName: # string. Required when DeployToSlotFlag = true. Slot. 
    #VirtualApplication: # string. Virtual Application. 
    Package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or Folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
  # Output
    #WebAppUri: # string. App Service URL. 
  # Additional Deployment Options
    #UseWebDeploy: true # boolean. Publish using Web Deploy. Default: true.
    #SetParametersFile: # string. Optional. Use when UseWebDeploy == true. SetParameters File. 
    #RemoveAdditionalFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true. Remove Additional Files at Destination. Default: false.
    #ExcludeFilesFromAppDataFlag: false # boolean. Optional. Use when UseWebDeploy == true. Exclude Files from the App_Data Folder. Default: false.
    #AdditionalArguments: # string. Optional. Use when UseWebDeploy == true. Additional Arguments. 
    #TakeAppOfflineFlag: false # boolean. Take App Offline. Default: false.

# YAML Syntax is not supported in TFS 2018.
# Use the classic designer to add and configure tasks.
# See the following Inputs section for details on the inputs that this task supports.

Entrées

ConnectedServiceName - Abonnement Azure
string. Obligatoire.

Sélectionnez l’abonnement Azure Resource Manager pour le déploiement.

WebAppName - nom de App Service
string. Obligatoire.

Entrez ou sélectionnez le nom d’une Azure App Service existante.

DeployToSlotFlag - Déployer sur un emplacement
boolean. Valeur par défaut : false.

Sélectionnez l’option à déployer sur un emplacement existant autre que l’emplacement de production.

ResourceGroupName - Groupe de ressources
string. Obligatoire lorsque DeployToSlotFlag = true.

Entrez ou sélectionnez le groupe de ressources Azure qui contient le Azure App Service spécifié ci-dessus.

SlotName - Fente
string. Obligatoire lorsque DeployToSlotFlag = true.

Entrez ou sélectionnez un emplacement existant autre que l’emplacement de production.

VirtualApplication - Application virtuelle
string.

Spécifiez le nom de l’application virtuelle qui a été configurée dans le Portail Azure. L’option n’est pas nécessaire pour les déploiements vers la racine App Service.

Package - Package ou dossier
string. Obligatoire. Valeur par défaut : $(System.DefaultWorkingDirectory)/**/*.zip.

Chemin d’accès au dossier ou au fichier App Service package ou dossier. Variables ( Build | Release), les caractères génériques sont pris en charge.
Par exemple, $(System.DefaultWorkingDirectory)/**/*.zip.

WebAppUri - URL de App Service
string.

Spécifiez un nom pour la variable de sortie générée pour l’URL du App Service. La variable peut être consommée dans les tâches suivantes.

UseWebDeploy - Publier à l’aide de Web Deploy
boolean. Valeur par défaut : true.

Les options de publication à l’aide du déploiement web sont prises en charge uniquement lors de l’utilisation de l’agent Windows. Sur d’autres plateformes, la tâche s’appuie sur les API REST Kudu pour déployer le App Service et les options suivantes ne sont pas prises en charge.

SetParametersFile - SetParameters File
string. facultatif. Utilisez quand UseWebDeploy == true.

Facultatif : emplacement du fichier SetParameters.xml à utiliser.

RemoveAdditionalFilesFlag - Supprimer des fichiers supplémentaires à la destination
boolean. facultatif. Utilisez quand UseWebDeploy == true. Valeur par défaut : false.

Sélectionnez l’option permettant de supprimer des fichiers sur le Azure App Service qui n’ont pas de fichiers correspondants dans le package ou le dossier App Service.

ExcludeFilesFromAppDataFlag - Exclure des fichiers du dossier App_Data
boolean. facultatif. Utilisez quand UseWebDeploy == true. Valeur par défaut : false.

Sélectionnez l’option permettant d’empêcher le déploiement des fichiers dans le dossier App_Data sur le Azure App Service.

AdditionalArguments - Arguments supplémentaires
string. facultatif. Utilisez quand UseWebDeploy == true.

Arguments Web Deploy supplémentaires qui suivent la syntaxe -key:value.
Celles-ci sont appliquées lors du déploiement du Azure App Service. Exemple : -disableLink:AppPoolExtension -disableLink:ContentExtension.
Pour obtenir d’autres exemples de paramètres d’opération Web Deploy, reportez-vous à ce sujet.

TakeAppOfflineFlag - Mettre l’application hors connexion
boolean. Valeur par défaut : false.

Sélectionnez l’option permettant de mettre le Azure App Service hors connexion en plaçant un fichier app_offline.htm dans le répertoire racine du App Service avant le début de l’opération de synchronisation. Le fichier est supprimé une fois l’opération de synchronisation terminée.

Options de contrôle de tâche

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

Variables de sortie

Aucun.

Configuration requise

Condition requise	Description
Types de pipelines	YAML, build classique, version classique
Exécutions sur	Agent
Demandes	Aucun
Capabilities	Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
Restrictions de commande	Quelconque
Variables settables	Quelconque
Version de l’agent	1.102.0 ou version ultérieure
Catégorie de la tâche	Déployer

Partager via