AzureFunctionApp@2 - Azure Functions tâche Déployer v2

Syntax

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # 'DOTNET|6.0' | 'DOTNET-ISOLATED|6.0' | 'DOTNET-ISOLATED|7.0' | 'DOTNET-ISOLATED|8.0' | 'JAVA|8' | 'JAVA|11' | 'JAVA|17' | 'JAVA|21' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'NODE|20' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10' | 'PYTHON|3.11'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # 'DOTNET|2.2' | 'DOTNET|3.1' | 'DOTNET|6.0' | 'DOTNET-ISOLATED|7.0' | 'JAVA|8' | 'JAVA|11' | 'NODE|8' | 'NODE|10' | 'NODE|12' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'PYTHON|3.6' | 'PYTHON|3.7' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

Entrées

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

Remarques

La tâche de déploiement de fonction Azure est utilisée pour mettre à jour Azure Functions déployer Functions sur Azure. La tâche fonctionne sur les agents Azure Pipelines multiplateformes exécutant Windows, Linux ou Mac et utilise les technologies de déploiement sous-jacentes des API RUNFromPackage, Zip Deploy et REST Kudu.

La tâche fonctionne pour le Azure Functions langues prises en charge.

Prérequis pour la tâche

Les prérequis suivants doivent être configurés sur les ordinateurs cibles pour que la tâche fonctionne correctement.

Fonction Azure

La tâche est utilisée pour déployer un projet Azure Functions sur une fonction Azure existante. L’application de fonction Azure doit exister avant l’exécution de la tâche. L’application de fonction Azure peut être créée à partir du Portail Azure. Vous pouvez également utiliser la tâche Azure PowerShell pour exécuter des scripts AzureRM PowerShell afin de provisionner et de configurer l’application de fonction Azure.

La tâche peut être utilisée pour déployer Azure Functions (Windows/Linux).

Abonnement Azure

Pour effectuer un déploiement sur Azure, un abonnement Azure doit être lié à Azure Pipelines à l’aide de l’onglet Services de la section Administration de compte. Ajoutez l’abonnement Azure à utiliser dans la définition Générer ou Release Management en ouvrant l’écran Administration de compte (icône d’engrenage en haut à droite de l’écran), puis cliquez sur l’onglet Services.

Create le point de terminaison de service ARM et utilisez le type de point de terminaison Azure Resource Manager. Pour plus d’informations, suivez les étapes répertoriées dans le lien ici.

La tâche ne fonctionne pas avec le point de terminaison de service Azure Classic et elle ne répertorie pas ces connexions dans les paramètres de la tâche.

Méthodes de déploiement

Plusieurs méthodes de déploiement sont disponibles dans cette tâche.

Pour modifier l’option de déploiement basé sur un package dans une tâche de concepteur, développez Options de déploiement supplémentaires et activez Sélectionner une méthode de déploiement.

Selon le type de l’agent Azure App Service et Azure Pipelines, la tâche utilise une technologie de déploiement appropriée. Les technologies de déploiement utilisées par les tâches sont les suivantes :

• API REST Kudu
• Déploiement zip
• Exécution à partir d’un package

Par défaut, la tâche tente de sélectionner la technologie de déploiement appropriée en fonction du package d’entrée, du type d’App Service et du système d’exploitation de l’agent.

• Si un script post-déploiement est fourni, utilisez Zip Deploy.
• Si le type App Service est Web App sur Linux, utilisez Zip Deploy.
• Si un fichier .war est fourni, utilisez War Deploy.
• Si un fichier .jar est fourni, utilisez Run-From-Zip.
• Pour toutes les autres tâches, utilisez Exécution à partir d’un package (via Zip Deploy).

Sur un agent non Windows (pour n’importe quel type d’App Service), la tâche s’appuie sur l’API REST Kudu pour déployer l’application web.

API REST Kudu

L’API REST Kudu fonctionne sur les agents d’automatisation Windows et Linux lorsque la cible est une application web sur Windows, une application web sur Linux (source intégrée) ou une application de fonction. La tâche utilise Kudu pour copier des fichiers dans Azure App Service.

Zip Deploy

Zip Deploy crée un package de déploiement .zip à partir du package ou du dossier choisi. Il déploie ensuite le contenu du fichier dans le dossier wwwroot de l’application de fonction de nom App Service dans Azure. Cette option remplace tout le contenu existant dans le dossier wwwroot. Pour plus d’informations, consultez Déploiement Zip pour Azure Functions.

Exécution à partir du package

Exécuter à partir du package crée le même package de déploiement que Zip Deploy. Au lieu de déployer des fichiers dans le dossier wwwroot, le runtime Functions monte l’intégralité du package. Lorsque vous utilisez cette option, les fichiers du dossier wwwroot passent en lecture seule. Pour plus d’informations, consultez l’article Run your Azure Functions from a package file (Exécuter vos fonctions Azure à partir d’un fichier de package).

Dépannage

Erreur : impossible de récupérer le jeton d’accès pour Azure. Vérifiez que le principal de service utilisé est valide et n’a pas expiré.

La tâche utilise le principal de service dans la connexion de service pour s’authentifier auprès d’Azure. Si le principal de service a expiré ou n’a pas d’autorisations sur App Service, la tâche échoue avec cette erreur. Vérifiez la validité du principal de service utilisé et s’il est présent dans l’inscription de l’application. Pour plus d’informations, consultez Utiliser le contrôle d’accès en fonction du rôle pour gérer l’accès aux ressources de votre abonnement Azure. Ce billet de blog contient également plus d’informations sur l’utilisation de l’authentification du principal de service.

Erreur SSL

Si vous voulez utiliser un certificat dans App Service, le certificat doit être signé par une autorité de certification approuvée. Si votre application web permet de voir les erreurs de validation de certificat, vous utilisez probablement un certificat auto-signé. Définissez une variable nommée VSTS_ARM_REST_IGNORE_SSL_ERRORS sur la valeur true dans le pipeline de build ou de mise en production pour résoudre l’erreur.

Une mise en production se bloque pendant une période prolongée, puis échoue

Ce problème peut être le résultat d’une capacité insuffisante dans votre plan App Service. Pour résoudre le problème, vous pouvez effectuer un scale-up de l’instance App Service afin d’augmenter le processeur, la RAM et l’espace disque disponibles, ou vous pouvez essayer un autre plan App Service.

Codes d’erreur 5xx

Si vous voyez une erreur 5xx, vérifiez l’état de votre service Azure.

La fonction Azure a soudainement cessé de fonctionner

Azure Functions peut cesser de fonctionner soudainement si plus d’un an s’est écoulé depuis le dernier déploiement. Si vous déployez avec « RunFromPackage » dans « deploymentMethod », une sap avec une date d’expiration de 1 an est générée et définie comme valeur « WEBSITE_RUN_FROM_PACKAGE » dans la configuration de l’application. Azure Functions utilise cette sap pour référencer le fichier de package pour l’exécution de la fonction. Par conséquent, si la sap a expiré, la fonction ne sera pas exécutée. Pour résoudre ce problème, déployez à nouveau pour générer une sap dont la date d’expiration est d’un an.

Erreur : package introuvable avec le modèle spécifié

Vérifiez si le package mentionné dans la tâche est publié en tant qu’artefact dans la build ou au cours d’une phase précédente, et s’il est téléchargé dans le travail actuel.

Erreur : La publication avec l’option zip deploy n’est pas prise en charge pour le type de package msBuild

Les packages web créés via la tâche MSBuild (avec les arguments par défaut) ont une structure de dossiers imbriqués qui peut être déployée correctement seulement par Web Deploy. L’option de déploiement publish-to-zip ne peut pas être utilisée pour déployer ces packages. Pour convertir la structure d’empaquetage, effectuez les étapes suivantes :

1. Dans la tâche Générer la solution, remplacez les arguments MSBuild par /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl="$(System.DefaultWorkingDirectory)\\WebAppContent" :

   

2. Ajoutez une tâche Archive et changez les valeurs de la façon suivante :

   1. Définissez le dossier racine ou fichier à archiver sur $(System.DefaultWorkingDirectory)\\WebAppContent.

   2. Décochez la case Ajouter le nom du dossier racine au début des chemins d’archive :

      

Le déploiement de l’application de fonction sur Windows réussit, mais l’application ne fonctionne pas

Ce problème peut se produire si un fichier web.config n’est pas présent dans votre application. Vous pouvez ajouter un fichier web.config à votre source ou en générer automatiquement un à l’aide des Paramètres d’application et de configuration de la tâche.

1. Sélectionnez la tâche et accédez à Générer les paramètres web.config pour les applications Python, Node.js, Go et Java :

   

2. Sélectionnez le bouton Plus (...) sous Générer des paramètres web.config pour Python, Node.js, Go et Java pour modifier les paramètres :

   

3. Sélectionnez votre type d’application dans la liste de l’infrastructure d’application.

4. Sélectionnez OK. Cela remplit les paramètres web.config requis pour générer le fichier web.config.

FAQ

Comment configurer ma connexion de service ?

Cette tâche nécessite une connexion de service Azure Resource Manager.

Comment configurer le déploiement de travaux web avec Application Insights ?

Quand vous déployez sur une instance App Service, si Application Insights est configuré et que vous avez activé Remove additional files at destination, vous devez également activer Exclude files from the App_Data folder. L’activation de cette option maintient l’extension Application Insights dans un état sécurisé. Cette étape est obligatoire, car le travail web Application Insights continu est installé dans le dossier App_Data.

Comment configurer mon agent s’il est derrière un proxy pendant le déploiement sur App Service ?

Si votre agent auto-hébergé nécessite un proxy web, vous pouvez indiquer le proxy à l’agent pendant la configuration. Cela permet à votre agent de se connecter à Azure Pipelines ou à Azure DevOps Server avec le proxy. En savoir plus sur l’exécution d’un agent auto-hébergé derrière un proxy web.

Je ne parviens pas à déployer sur un App Service Environment interne à l’aide d’une connexion de service Azure Resource Manager et d’un agent hébergé par Microsoft

Par conception, un agent hébergé par Microsoft ne fonctionnera pas avec un App Service Environment. Au lieu de cela, vous devez configurer un agent privé sur une machine virtuelle qui se trouve dans le même réseau virtuel que le App Service Environment. Définissez également une zone DNS privée pour activer la communication entre les ressources.

Exemples

Voici un exemple d’extrait de code YAML qui déploie des fonctions Azure sur Windows :

variables:
  azureSubscription: Contoso
  # To ignore SSL error, uncomment the below variable
  # VSTS_ARM_REST_IGNORE_SSL_ERRORS: true

steps:
- task: AzureFunctionApp@2
  displayName: Azure Function App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: samplefunctionapp
    appType: functionApp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

Pour déployer une fonction sur Linux, ajoutez le paramètre appType et définissez-le sur appType: functionAppLinux. Si vous ne spécifiez pas de valeur, la valeur par défaut est functionApp.

Pour spécifier explicitement la méthode de déploiement sur Zip Deploy, ajoutez le paramètre deploymentMethod: zipDeploy. Une autre valeur prise en charge pour ce paramètre est runFromPackage. Si vous ne spécifiez pas de valeur, la valeur par défaut est auto.

Pour une procédure pas à pas qui montre comment créer un pipeline CI/CD, consultez Générer et déployer Java sur Azure Functions.

Configuration requise