Développer Azure Functions avec Visual Studio Code

L’extension Azure Functions pour Visual Studio Code vous permet de développer localement des fonctions, et de les déployer sur Azure. S’il s’agit de votre première expérience avec Azure Functions, vous pouvez en apprendre davantage dans l’article Présentation d’Azure Functions.

L’extension Azure Functions présente ces avantages :

• Modifier, générer et exécuter des fonctions sur votre ordinateur de développement local.
• Publier votre projet Azure Functions directement sur Azure.
• Écrire vos fonctions dans différents langages tout en bénéficiant des avantages du développement Visual Studio Code.

Prérequis

• Visual Studio Code doit être installé sur l’une des plateformes prises en charge.

• Extension Azure Functions Vous pouvez également installer le pack d’extension Azure Tools, qui est recommandé pour l’utilisation des ressources Azure.

• Un abonnement Azure actif. Si vous n’avez pas encore de compte, vous pouvez en créer une à partir de l’extension dans Visual Studio Code.

Vous avez également besoin de ces prérequis pour exécuter et déboguer vos fonctions localement. Ils ne sont pas obligés de simplement créer ou publier des projets sur Azure Functions.

• Azure Functions Core Tools, qui permet une expérience de débogage locale intégrée. Une fois l’extension Azure Functions installée, le moyen le plus simple d’installer ou de mettre à jour Core Tools consiste à exécuter la commande Azure Functions: Install or Update Azure Functions Core Tools à partir de la palette de commandes.

Créer un projet Azure Functions

L'extension Functions vous permet de créer le projet d'application de fonction requis en même temps que vous créez votre première fonction. Utilisez ces étapes pour créer une fonction déclenchée par HTTP dans un nouveau projet. Un déclencheur HTTP est le modèle de déclencheur de fonction le plus simple à démontrer.

1. Dans Visual Studio Code, appuyez sur F1 pour ouvrir la palette de commandes, puis recherchez et exécutez la commande Azure Functions: Create New Project.... Sélectionnez l'emplacement du répertoire pour votre espace de travail de projet, puis choisissez Sélectionner.

   Vous pouvez soit créer un nouveau dossier, soit choisir un dossier vide pour l'espace de travail du projet, mais ne choisissez pas un dossier de projet qui fait déjà partie d'un espace de travail.

   Vous pouvez à la place exécuter la commande Azure Functions: Create New Containerized Project... pour obtenir également un fichier Dockerfile généré pour le projet.

2. Lorsque vous y êtes invité, sélectionnez une langue pour votre projet. Si nécessaire, choisissez une version linguistique spécifique.

3. Sélectionnez le modèle de fonction Déclencheur HTTP, sinon vous pouvez sélectionner Ignorer pour le moment et créer un projet sans fonction. Vous pourrez toujours ajouter une fonction à votre projet ultérieurement.

   Conseil

   Vous pouvez afficher des modèles supplémentaires en sélectionnant l'option de filtre Modifier le modèle et en définissant la valeur sur Core ou Tous.

4. Pour le nom de la fonction, entrez HttpExample, sélectionnez Entrée, puis sélectionnez Autorisation de fonction.

   Ce niveau d'autorisation nécessite que vous fournissiez une clé de fonction lorsque vous appelez le point de terminaison de fonction.

5. Dans la liste déroulante, sélectionnez Ajouter à l’espace de travail.

6. Dans la zone Faites-vous confiance aux auteurs des fichiers de ce dossier ? fenêtre, sélectionnez Oui.

Visual Studio Code crée une fonction dans le langage de votre choix et dans le modèle pour une fonction déclenchée par HTTP.

Fichiers projet générés

Le modèle de projet crée un projet dans la langue de votre choix et installe les dépendances requises. Pour tous les langages, le nouveau projet comporte ces fichiers :

• host.json : vous permet de configurer l’hôte Functions. Ces paramètres s’appliquent lorsque vous exécutez des fonctions localement, et lorsque vous les exécutez dans Azure. Pour plus d’informations, consultez l’article de référence sur host.json.

• local.settings.json : Conserve les paramètres utilisés lorsque vous exécutez des fonctions localement. Ces paramètres sont utilisés uniquement lorsque vous exécutez des fonctions localement. Pour en savoir plus, voir Fichier de paramètres locaux.

  Important

  Étant donné que le fichier local.settings.json peut contenir des secrets, veillez à exclure le fichier du contrôle de code source de votre projet.

• Dockerfile (facultatif) : vous permet de créer une application de fonction conteneurisée à partir de votre projet à l’aide d’une image de base approuvée pour votre projet. Vous obtenez ce fichier uniquement lorsque vous exécutez la commande Azure Functions: Create New Containerized Project.... Vous pouvez ajouter un fichier Dockerfile à un projet existant à l’aide de la commande func init --docker-only dans Core Tools.

Selon votre langage de programmation, ces autres fichiers sont créés :

À ce stade, vous pouvez exécuter votre fonction de déclenchement HTTP localement.

Ajouter une fonction à votre projet

Vous pouvez ajouter une nouvelle fonction à un projet existant en vous basant sur l’un des modèles de déclencheur Functions prédéfinis. Pour ajouter un nouveau déclencheur de fonction, sélectionnez F1 pour ouvrir la palette de commandes, puis recherchez et exécutez la commande Azure Functions : Create Function. Suivez les invites pour choisir le type de déclencheur et définir les attributs requis de ce dernier. Si votre déclencheur nécessite une clé d'accès ou une chaîne de connexion pour vous connecter à un service, préparez cet élément avant de créer le déclencheur de fonction.

Se connecter à des services

Vous pouvez connecter votre fonction à d’autres services Azure en utilisant des liaisons d’entrée et de sortie. Les liaisons connectent votre fonction à d’autres services sans avoir à écrire le code de connexion.

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

{
    "type": "queue",
    "direction": "out",
    "name": "msg",
    "queueName": "outqueue",
    "connection": "MyStorageConnection"
}

L’exemple suivant montre la définition de la fonction après l’ajout d’une liaison de sortie de Stockage File d’attente à une fonction déclenchée par HTTP :

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req,
    FunctionContext executionContext)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

Connexion à Azure

Avant de pouvoir créer des ressources Azure ou de publier votre application, vous devez vous connecter à Azure.

1. Si vous n’êtes pas encore connecté, dans la Barre d’activité, sélectionnez l’icône Azure. Ensuite, sous Ressources, sélectionnez Se connecter à Azure.

   

   Si vous êtes déjà connecté et que vous pouvez voir vos abonnements existants, accédez à la section suivante. Si vous n’avez pas encore de compte Azure, Créez un compte Azure. Les étudiants peuvent sélectionner Créer un compte Azure for Students.

2. Quand vous y êtes invité dans le navigateur, sélectionnez votre compte Azure et connectez-vous avec vos informations d’identification de compte Azure. Si vous créez un compte, vous pouvez vous connecter une fois votre compte créé.

3. Une fois la connexion réussie, vous pouvez fermer la nouvelle fenêtre de navigateur. Les abonnements qui appartiennent à votre compte Azure sont affichés dans la barre latérale.

Créer des ressources Azure

Avant de pouvoir publier votre projet Functions sur Azure, vous devez disposer d’une application de fonction et de ressources associées dans votre abonnement Azure pour exécuter votre code. L’application de fonction fournit un contexte d'exécution pour vos fonctions. Lorsque vous publiez à partir de Visual Studio Code vers une application de fonction dans Azure, le projet est empaqueté et déployé sur l'application de fonction sélectionnée dans votre abonnement Azure.

Lorsque vous créez une application de fonction dans Azure, vous pouvez choisir un chemin de création d’application de fonction rapide à l’aide de valeurs par défaut ou d’un chemin d’accès qui vous offre des options avancées, telles que l’utilisation de ressources Azure existantes. De cette façon, vous avez plus de contrôle sur la création des ressources distantes.

Créer un déploiement Azure Container Apps

Vous utilisez Visual Studio Code pour créer des ressources Azure pour un projet de code conteneurisé. Lorsque l’extension détecte la présence d’un fichier Dockerfile lors de la création de la ressource, elle vous demande si vous souhaitez déployer l’image conteneur au lieu du code uniquement. Visual Studio Code crée un environnement Azure Container Apps pour votre projet de code conteneurisé intégré à Azure Functions. Pour plus d’informations, consultez Hébergement Azure Container Apps d’Azure Functions.

Le processus de création varie selon que vous choisissez une création rapide ou si vous devez utiliser des options avancées :

Pour plus d’informations sur les ressources requises pour exécuter vos fonctions conteneurisées dans Container Apps, consultez Ressources requises.

Déployer des fichiers de projet

Nous vous recommandons de configurer un déploiement continu afin que votre application de fonction dans Azure soit mise à jour lorsque vous mettez à jour les fichiers source dans l'emplacement source connecté. Vous pouvez également déployer vos fichiers projet à partir de Visual Studio Code. Lorsque vous publiez à partir de Visual Studio Code, vous pouvez profiter de la technologie de déploiement Zip.

1. Dans la palette de commandes, entrez puis sélectionnez Azure Functions : Déployer sur une application de fonction.

2. Sélectionnez l’application de fonction que vous venez de créer. Quand vous êtes invité à remplacer les déploiements précédents, sélectionnez Déployer pour déployer le code de votre fonction sur la nouvelle ressource de l’application de fonction.

3. Une fois le déploiement terminé, sélectionnez Afficher la sortie pour voir les résultats de la création et du déploiement, y compris les ressources Azure que vous avez créées. Si vous manquez la notification, sélectionnez l’icône de cloche dans le coin inférieur droit pour la voir à nouveau.

   

Récupérer l’URL d’une fonction déclenchée via HTTP dans Azure

Pour appeler une fonction déclenchée par HTTP à partir d'un client, vous avez besoin de l'URL de la fonction, qui est disponible après le déploiement sur votre application de fonction. Cette URL inclut les clés de fonction requises. Vous pouvez utiliser l’extension pour obtenir les URL de vos fonctions déployées. Si vous souhaitez simplement exécuter la fonction distante dans Azure, utilisez la fonctionnalité « Exécuter la fonction maintenant » de l’extension.

1. Sélectionnez F1 pour ouvrir la palette de commandes, puis recherchez et exécutez la commande Azure Functions : Copier l'URL de la fonction.

2. Suivez les invites pour sélectionner votre application de fonction dans Azure, puis le déclencheur HTTP particulier que vous souhaitez appeler.

L’URL de la fonction est copiée dans le Presse-papiers, ainsi que les clés éventuelles exigées, transmises par le paramètre de requête code. Utilisez un outil HTTP pour soumettre des requêtes POST ou un navigateur pour soumettre des requêtes GET à la fonction distante.

Lorsque l'extension obtient l'URL d'une fonction dans Azure, l'extension utilise votre compte Azure pour récupérer automatiquement les clés nécessaires au démarrage de la fonction. En savoir plus sur les clés d’accès aux fonctions. Le démarrage de fonctions non déclenchées via HTTP requiert l’utilisation de la clé administrateur.

Exécuter des fonctions

L’extension Azure Functions vous permet d’exécuter des fonctions individuelles. Vous pouvez exécuter des fonctions dans votre projet sur votre ordinateur de développement local ou dans votre abonnement Azure.

Pour les fonctions déclenchées via HTTP, l’extension appelle le point de terminaison HTTP. Pour les autres types de déclencheurs, l'extension appelle les API de l'administrateur pour démarrer la fonction. Le corps du message de la requête envoyée à la fonction dépend du type de déclencheur. Lorsqu’un déclencheur requiert des données de test, vous êtes invité à entrer des données dans un format JSON spécifique.

Exécuter des fonctions dans Azure

Pour exécuter une fonction dans Azure à partir de Visual Studio Code, procédez comme suit :

1. Dans la palette de commandes, entrez Azure Functions : Exécuter la fonction maintenant et sélectionnez votre abonnement Azure.

2. Dans la liste, choisissez votre application de fonction dans Azure. Si vous ne voyez pas votre application de fonction, assurez-vous que vous êtes connecté au bon abonnement.

3. Dans la liste, choisissez la fonction que vous souhaitez exécuter. Dans Entrez le corps de la requête, tapez le corps du message de la demande et appuyez sur Entrée pour envoyer ce message de demande à votre fonction.

   Le texte par défaut dans Entrez le corps de la requête indique le format du corps. Si votre application de fonction n’a pas de fonctions, une notification d’erreur s’affiche avec cette erreur.

   Lorsque la fonction s'exécute dans Azure et renvoie une réponse, Visual Studio Code affiche une notification.

Vous pouvez également exécuter votre fonction à partir de la zone Azure : Fonctions en ouvrant le menu contextuel de la fonction que vous souhaitez exécuter à partir de votre application de fonction dans votre abonnement Azure, puis en sélectionnant Exécuter la fonction maintenant....

Lorsque vous exécutez vos fonctions dans Azure à partir de Visual Studio Code, l'extension utilise votre compte Azure pour récupérer automatiquement les clés nécessaires au démarrage de la fonction. En savoir plus sur les clés d’accès aux fonctions. Le démarrage de fonctions non déclenchées via HTTP requiert l’utilisation de la clé administrateur.

Exécuter des fonctions localement

Le runtime local est le même runtime que celui qui héberge votre application de fonction dans Azure. Les paramètres locaux sont lus à partir du fichier local.settings.json. Pour exécuter votre projet Functions localement, vous devez vous conformer à des exigences supplémentaires.

Configurer le projet pour une exécution locale

Le runtime Functions utilise un compte de stockage Azure en interne pour tous les types de déclencheurs autres que HTTP et webhooks. Autrement dit, vous devez définir la clé Values.AzureWebJobsStorage sur une chaîne de connexion de compte de stockage Azure valide.

Cette section utilise l’extension Stockage Azure pour Visual Studio Code avec l’Explorateur Stockage Azure pour vous connecter à la chaîne de connexion de stockage et la récupérer.

Pour définir la chaîne de connexion de compte de stockage :

1. Dans Visual Studio, ouvrez Cloud Explorer, développez Compte de stockage>Votre compte de stockage, puis sélectionnez Propriétés et copiez la valeur de Chaîne de connexion principale.

2. Dans votre projet, ouvrez le fichier local.settings.json et définissez la valeur de la clé AzureWebJobsStorage sur la chaîne de connexion que vous avez copiée.

3. Répétez l’étape précédente pour ajouter des clés uniques au tableau Valeurs pour les autres connexions requises par vos fonctions.

Pour en savoir plus, voir Fichier de paramètres locaux.

Déboguer les fonctions localement

Pour déboguer vos fonctions, sélectionnez F5. Si Core Tools n’est pas disponible, vous êtes invité à l’installer. Lorsque Core Tools est installé et en cours d’exécution, la sortie est affichée dans le terminal. Cette étape revient à exécuter la commande Core Tools func start dans le terminal, mais avec des tâches de génération supplémentaires et un débogueur attaché.

Lorsque le projet est en cours d’exécution, vous pouvez utiliser la fonctionnalité Exécuter la fonction maintenant… de l’extension pour déclencher vos fonctions comme vous le feriez dans le projet déployé sur Azure. Lorsque le projet s’exécute en mode débogage, les points d’arrêt sont atteints dans Visual Studio Code comme prévu.

1. Dans la palette de commandes, entrez Azure Functions : exécuter la fonction maintenant et choisissez Projet local.

2. Choisissez la fonction que vous souhaitez exécuter dans votre projet et saisissez le corps du message de la demande dans Entrez le corps de la demande. Appuyez sur Entrée pour envoyer ce message de demande à votre fonction. Le texte par défaut dans Entrez le corps de la demande doit indiquer le format du corps. Si votre application de fonction n’a pas de fonctions, une notification d’erreur s’affiche avec cette erreur.

3. Lorsque la fonction s’exécute localement et après la réception de la réponse, une notification est générée dans Visual Studio Code. Les informations relatives à l’exécution de la fonction s’affichent dans le panneau Terminal.

Les clés ne sont pas requises dans le cadre d’une exécution locale, ce qui vaut pour les clés de fonction et les clés de niveau administrateur.

Utiliser les paramètres d’application localement

Lors de l’exécution dans une application de fonction dans Azure, les paramètres requis par vos fonctions sont stockés de manière sécurisée dans les paramètres de l’application. Lors du développement local, ces paramètres sont, à la place, ajoutés à la collection Values dans le fichier local.settings.json. Le fichier local.settings.json stocke également les paramètres utilisés par les outils de développement locaux.

Les éléments de la collection Values dans le fichier local.settings.json de votre projet sont destinés à refléter des éléments des paramètres d’application de votre application de fonction dans Azure.

Par défaut, ces paramètres ne sont pas migrés automatiquement lorsque le projet est publié dans Azure. Une fois la publication terminée, vous pouvez publier les paramètres du fichier local.settings.json sur votre application de fonction dans Azure. Pour plus d’informations, consultez Publier les paramètres de l’application.

Les valeurs dans ConnectionStrings ne sont jamais publiées.

Paramètres d’application dans Azure

Les paramètres du fichier local.settings.json de votre projet doivent être les mêmes que les paramètres de l’application de fonction dans Azure. Les paramètres que vous ajoutez au fichier local.settings.json doivent être également ajoutés à l’application de fonction dans Azure. Ces paramètres ne sont pas chargés automatiquement quand vous publiez le projet. De même, tous les paramètres que vous créez dans votre application de fonction dans le portail doivent être téléchargés dans votre projet local.

Publier les paramètres de l’application

Le moyen le plus simple de publier les paramètres obligatoires sur votre application de fonction dans Azure consiste à utiliser le lien Charger les paramètres qui apparaît une fois votre projet publié :

Vous pouvez également publier des paramètres au moyen de la commande Azure Functions : Upload Local Setting dans la palette de commandes. Vous pouvez ajouter des paramètres individuels aux paramètres de l’application dans Azure en utilisant la commande Azure Functions: Add New Setting.

Si le fichier local est chiffré, il est déchiffré, publié et chiffré à nouveau. Si des paramètres comportent des valeurs conflictuelles dans les deux emplacements, vous êtes invité à choisir la procédure à suivre.

Affichez les paramètres d’une application existante dans la zone Azure : Functions en développant votre abonnement, votre application de fonction et Paramètres de l’application.

Télécharger les paramètres depuis Azure

Si vous avez créé des paramètres d’application dans Azure, vous pouvez les télécharger dans votre fichier local.settings.json au moyen de la commande Azure Functions: Télécharger les paramètres distants.

Tout comme dans le cas du chargement, si le fichier local est chiffré, il est déchiffré, publié et chiffré à nouveau. Si des paramètres comportent des valeurs conflictuelles dans les deux emplacements, vous êtes invité à choisir la procédure à suivre.

Installer des extensions de liaison

À l’exception des déclencheurs HTTP et de minuteur, les liaisons sont implémentées dans des packages d’extension.

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

dotnet add package Microsoft.Azure.WebJobs.Extensions.<BINDING_TYPE_NAME> --version <TARGET_VERSION>

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.*, 4.0.0)"
    }
}

Surveillance des fonctions

En cas d’exécution locale de fonctions, les données de journal sont diffusées en continu vers la console de terminal. Vous pouvez également obtenir les données de journal lorsque votre projet Functions est en cours d’exécution dans une application de fonction sur Azure. Vous pouvez vous connecter aux journaux de diffusion en continu dans Azure pour voir les données de journal en quasi temps réel. Vous devez activer Application Insights pour une compréhension plus complète des comportements de votre application.

Application Insights

Nous vous conseillons de superviser l’exécution de vos fonctions en intégrant votre application de fonction à Application Insights. Lorsque vous créez une application de fonction dans le portail Azure, cette intégration s’effectue par défaut. Lorsque vous créez votre application de fonction pendant la publication de Visual Studio, vous devez intégrer Application Insights vous-même. Pour découvrir comment, consultez Activer l’intégration à Application Insights.

Pour en savoir plus sur la surveillance à l’aide d’Application Insights, consultez Surveiller l’exécution des fonctions Azure.

Référence pour la palette de commandes

L’extension Azure Functions fournit une interface graphique utile dans la zone pour interagir avec vos applications de fonction dans Azure. La même fonctionnalité est également disponible sous forme de commande dans la palette de commandes (F1). Ces commandes Azure Functions sont disponibles :

Étapes suivantes

Pour plus d’informations sur Azure Functions Core Tools, consultez Utiliser Azure Functions Core Tools.

Pour en savoir plus sur le développement de fonctions en tant que bibliothèques de classes, consultez Informations de référence pour les développeurs C# sur Azure Functions. Cet article fournit également des liens vers des exemples d’utilisation d’attributs pour déclarer les différents types de liaisons pris en charge par Azure Functions.