Démarrage rapide : Créer une fonction C# dans Azure à partir de la ligne de commandeQuickstart: Create a C# function in Azure from the command line

Dans cet article, vous allez utiliser des outils en ligne de commande pour créer une fonction basée sur une bibliothèque de classes C# qui répond aux requêtes HTTP.In this article, you use command-line tools to create a C# class library-based function that responds to HTTP requests. Après avoir testé le code localement, vous le déployez dans l’environnement serverless d’Azure Functions.After testing the code locally, you deploy it to the serverless environment of Azure Functions.

Le fait de suivre ce guide de démarrage rapide entraîne une faible dépense de quelques cents USD tout au plus dans votre compte Azure.Completing this quickstart incurs a small cost of a few USD cents or less in your Azure account.

Si vous souhaitez consulter une version de cet article adaptée à Visual Studio Code, cliquez ici.There is also a Visual Studio Code-based version of this article.

Configurer votre environnement localConfigure your local environment

Avant de commencer la lecture cet article, vous devez disposer des éléments suivants :Before you begin, you must have the following:

Vérification du prérequisPrerequisite check

Vérifiez vos prérequis, selon que vous utilisez Azure CLI ou Azure PowerShell pour la création de ressources Azure :Verify your prerequisites, which depend on whether you are using Azure CLI or Azure PowerShell for creating Azure resources:

  • Dans une fenêtre de terminal ou de commande, exécutez func --version pour vérifier que vous disposez d’Azure Functions Core Tools version 3.x.In a terminal or command window, run func --version to check that the Azure Functions Core Tools are version 3.x.

  • Exécutez az --version pour vérifier que vous disposez d’Azure CLI version 2.4 ou ultérieure.Run az --version to check that the Azure CLI version is 2.4 or later.

  • Exécutez az login pour vous connecter à Azure et vérifier que l’abonnement est actif.Run az login to sign in to Azure and verify an active subscription.

  • Exécutez dotnet --list-sdks pour vérifier que le SDK .NET Core version 3.1.x est installé.Run dotnet --list-sdks to check that .NET Core SDK version 3.1.x is installed

Créer un projet de fonction localCreate a local function project

Dans Azure Functions, un projet de fonction est un conteneur pour une ou plusieurs fonctions qui répondent chacune à un déclencheur spécifique.In Azure Functions, a function project is a container for one or more individual functions that each responds to a specific trigger. Toutes les fonctions d’un projet partagent les mêmes configurations locale et d’hébergement.All functions in a project share the same local and hosting configurations. Dans cette section, vous créez un projet de fonction qui contient une seule fonction.In this section, you create a function project that contains a single function.

  1. Exécutez la commande func init, de la façon suivante, pour créer un projet Functions dans un dossier nommé LocalFunctionProj avec le runtime spécifié :Run the func init command, as follows, to create a functions project in a folder named LocalFunctionProj with the specified runtime:

    func init LocalFunctionProj --dotnet
    
  2. Accédez au dossier du projet :Navigate into the project folder:

    cd LocalFunctionProj
    

    Ce dossier contient divers fichiers pour le projet, notamment des fichiers config nommés local.settings.json et host.json.This folder contains various files for the project, including configurations files named local.settings.json and host.json. Dans la mesure où local.settings.json peut contenir des secrets téléchargés à partir d’Azure, le fichier est exclu du contrôle de code source par défaut dans le fichier .gitignore.Because local.settings.json can contain secrets downloaded from Azure, the file is excluded from source control by default in the .gitignore file.

  3. Ajoutez une fonction à votre projet à l’aide de la commande suivante, où l’argument --name est le nom unique de votre fonction (HttpExample) et où l’argument --template spécifie le déclencheur de la fonction (HTTP).Add a function to your project by using the following command, where the --name argument is the unique name of your function (HttpExample) and the --template argument specifies the function's trigger (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"
    

    func new crée un fichier de code HttpExample.cs.func new creates a HttpExample.cs code file.

(Facultatif) Examiner le contenu du fichier(Optional) Examine the file contents

Si vous le souhaitez, vous pouvez passer à Exécuter la fonction localement et examiner le contenu du fichier plus tard.If desired, you can skip to Run the function locally and examine the file contents later.

HttpExample.csHttpExample.cs

HttpExample.cs contient une méthode Run qui reçoit des données de requête dans la variable req de type HttpRequest, décorée avec HttpTriggerAttribute qui définit le comportement du déclencheur.HttpExample.cs contains a Run method that receives request data in the req variable is an HttpRequest that's decorated with the HttpTriggerAttribute, which defines the trigger behavior.

using System;
using System.IO;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;

namespace LocalFunctionProj
{
    public static class HttpExample
    {
        [FunctionName("HttpExample")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            log.LogInformation("C# HTTP trigger function processed a request.");

            string name = req.Query["name"];

            string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
            dynamic data = JsonConvert.DeserializeObject(requestBody);
            name = name ?? data?.name;

            return name != null
                ? (ActionResult)new OkObjectResult($"Hello, {name}")
                : new BadRequestObjectResult("Please pass a name on the query string or in the request body");
        }
    }
}

L’objet retourné est un ActionResult qui retourne un message de réponse sous la forme d’un OkObjectResult (200) ou d’un BadRequestObjectResult (400).The return object is an ActionResult that returns a response message as either an OkObjectResult (200) or a BadRequestObjectResult (400). Pour en savoir plus, voir Déclencheurs et liaisons HTTP Azure Functions.To learn more, see Azure Functions HTTP triggers and bindings.

Exécuter la fonction localementRun the function locally

  1. Exécutez votre fonction en démarrant l’hôte du runtime d’Azure Functions local à partir du dossier LocalFunctionProj :Run your function by starting the local Azure Functions runtime host from the LocalFunctionProj folder:

    func start
    

    Vers la fin de la sortie, les lignes suivantes doivent s’afficher :Toward the end of the output, the following lines should appear:

     ...
    
     Now listening on: http://0.0.0.0:7071
     Application started. Press Ctrl+C to shut down.
    
     Http Functions:
    
             HttpExample: [GET,POST] http://localhost:7071/api/HttpExample
     ...
    
     

    Notes

    Si HttpExample n’apparaît pas comme indiqué ci-dessus, cela signifie probablement que vous avez démarré l’hôte à partir d’un emplacement autre que le dossier racine du projet.If HttpExample doesn't appear as shown above, you likely started the host from outside the root folder of the project. Dans ce cas, utilisez Ctrl+C pour arrêter l’hôte, accédez au dossier racine du projet, puis réexécutez la commande précédente.In that case, use Ctrl+C to stop the host, navigate to the project's root folder, and run the previous command again.

  2. Copiez dans un navigateur l’URL de votre fonction HttpExample à partir de cette sortie, puis ajoutez la chaîne de requête ?name=<YOUR_NAME> pour obtenir une URL complète semblable à http://localhost:7071/api/HttpExample?name=Functions.Copy the URL of your HttpExample function from this output to a browser and append the query string ?name=<YOUR_NAME>, making the full URL like http://localhost:7071/api/HttpExample?name=Functions. Le navigateur doit afficher un message de réponse qui renvoie la valeur de votre chaîne de requête.The browser should display a response message that echoes back your query string value. Le terminal dans lequel vous avez démarré votre projet affiche également une sortie de journal quand vous effectuez des requêtes.The terminal in which you started your project also shows log output as you make requests.

  3. Quand vous avez terminé, utilisez Ctrl+C, puis choisissez y pour arrêter l’hôte Functions.When you're done, use Ctrl+C and choose y to stop the functions host.

Créer des ressources Azure de prise en charge pour votre fonctionCreate supporting Azure resources for your function

Avant de déployer le code de votre fonction dans Azure, vous devez créer trois ressources :Before you can deploy your function code to Azure, you need to create three resources:

  • Un groupe de ressources, qui est un conteneur logique pour les ressources associées.A resource group, which is a logical container for related resources.
  • Un compte de stockage, qui sert à conserver l’état et d’autres informations sur vos fonctions.A Storage account, which is used to maintain state and other information about your functions.
  • Une application de fonction, qui fournit l’environnement d’exécution de votre code de fonction.A function app, which provides the environment for executing your function code. Une application de fonction est mappée à votre projet de fonction local. Elle vous permet de regrouper les fonctions en tant qu’unité logique pour faciliter la gestion, le déploiement et le partage des ressources.A function app maps to your local function project and lets you group functions as a logical unit for easier management, deployment, and sharing of resources.

Utilisez les commandes suivantes pour créer ces éléments.Use the following commands to create these items. Azure CLI et PowerShell sont pris en charge.Both Azure CLI and PowerShell are supported.

  1. Si vous ne l’avez pas déjà fait, connectez-vous à Azure :If you haven't done so already, sign in to Azure:

    az login
    

    La commande az login vous connecte à votre compte Azure.The az login command signs you into your Azure account.

  2. Créez un groupe de ressources nommé AzureFunctionsQuickstart-rg dans la région westeurope :Create a resource group named AzureFunctionsQuickstart-rg in the westeurope region:

    az group create --name AzureFunctionsQuickstart-rg --location westeurope
    

    La commande az group create crée un groupe de ressources.The az group create command creates a resource group. Vous créez généralement votre groupe de ressources et vos ressources dans une région près de chez vous, en utilisant une région disponible retournée par la commande az account list-locations.You generally create your resource group and resources in a region near you, using an available region returned from the az account list-locations command.

  3. Créez un compte de stockage universel dans votre groupe de ressources et votre région :Create a general-purpose storage account in your resource group and region:

    az storage account create --name <STORAGE_NAME> --location westeurope --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS
    

    La commande az storage account create crée le compte de stockage.The az storage account create command creates the storage account.

    Dans l’exemple précédent, remplacez <STORAGE_NAME> par un nom qui vous convient et qui est unique dans Stockage Azure.In the previous example, replace <STORAGE_NAME> with a name that is appropriate to you and unique in Azure Storage. Les noms doivent contenir entre 3 et 24 caractères, et comporter uniquement des lettres minuscules.Names must contain three to 24 characters numbers and lowercase letters only. Standard_LRS spécifie un compte universel, qui est pris en charge par Functions.Standard_LRS specifies a general-purpose account, which is supported by Functions.

  1. Créer l’application de fonction dans Azure :Create the function app in Azure:

    az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location westeurope --runtime dotnet --functions-version 3 --name <APP_NAME> --storage-account <STORAGE_NAME>
    

    La commande az functionapp create crée l’application de fonction dans Azure.The az functionapp create command creates the function app in Azure.

    Dans l’exemple précédent, remplacez <STORAGE_NAME> par le nom du compte que vous avez utilisé à l’étape précédente, puis remplacez <APP_NAME> par le nom global unique qui vous convient.In the previous example, replace <STORAGE_NAME> with the name of the account you used in the previous step, and replace <APP_NAME> with a globally unique name appropriate to you. <APP_NAME> représente également le domaine DNS par défaut pour l’application de fonction.The <APP_NAME> is also the default DNS domain for the function app.

    Cette commande crée une application de fonction qui s’exécute dans votre runtime de langage spécifié dans le Plan Consommation Azure Functions, qui est gratuit pour l’utilisation faite ici.This command creates a function app running in your specified language runtime under the Azure Functions Consumption Plan, which is free for the amount of usage you incur here. La commande provisionne également une instance d’Azure Application Insights associée dans le même groupe de ressources, avec laquelle vous pouvez superviser votre application de fonction et visualiser les journaux.The command also provisions an associated Azure Application Insights instance in the same resource group, with which you can monitor your function app and view logs. Pour plus d’informations, consultez Surveiller l’exécution des fonctions Azure.For more information, see Monitor Azure Functions. L’instance n’entraîne aucun coût tant que vous ne l’activez pas.The instance incurs no costs until you activate it.

Déployer le projet de fonction sur AzureDeploy the function project to Azure

Après avoir créé votre application de fonction dans Azure, vous êtes prêt à déployer votre projet Functions local à l’aide de la commande func azure functionapp publish.After you've successfully created your function app in Azure, you're now ready to deploy your local functions project by using the func azure functionapp publish command.

Dans l’exemple suivant, remplacez <APP_NAME> par le nom de votre application.In the following example, replace <APP_NAME> with the name of your app.

func azure functionapp publish <APP_NAME>

La commande de publication affiche des résultats similaires à la sortie suivante (tronquée par souci de simplicité) :The publish command shows results similar to the following output (truncated for simplicity):

...

Getting site publishing info...
Creating archive for current directory...
Performing remote build for functions project.

...

Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in msdocs-azurefunctions-qs:
    HttpExample - [httpTrigger]
        Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample

Appeler la fonction sur AzureInvoke the function on Azure

Dans la mesure où votre fonction utilise un déclencheur HTTP, vous l’appelez en adressant une requête HTTP à son URL dans le navigateur ou à l’aide d’un outil semblable à curl.Because your function uses an HTTP trigger, you invoke it by making an HTTP request to its URL in the browser or with a tool like curl.

Copiez l’URL d’appel complète affichée au sein de la sortie de la commande de publication dans la barre d’adresse d’un navigateur, en ajoutant le paramètre de requête &name=Functions.Copy the complete Invoke URL shown in the output of the publish command into a browser address bar, appending the query parameter &name=Functions. Le navigateur doit afficher une sortie similaire à celle générée au moment de l’exécution locale de la fonction.The browser should display similar output as when you ran the function locally.

Sortie de la fonction exécutée sur Azure dans un navigateur

Exécutez la commande suivante pour afficher les journaux de streaming en temps quasi-réel :Run the following command to view near real-time streaming logs:

func azure functionapp logstream <APP_NAME> 

Dans une fenêtre de terminal distincte ou dans le navigateur, appelez à nouveau la fonction distante.In a separate terminal window or in the browser, call the remote function again. Un journal détaillé de l’exécution de la fonction dans Azure est affiché dans le terminal.A verbose log of the function execution in Azure is shown in the terminal.

Nettoyer les ressourcesClean up resources

Si vous passez à l’étape suivante, qui consiste à ajouter une liaison de sortie de file d’attente Stockage Azure, gardez toutes vos ressources en place, car vous allez tirer parti de ce que vous avez déjà fait.If you continue to the next step and add an Azure Storage queue output binding, keep all your resources in place as you'll build on what you've already done.

Sinon, utilisez la commande suivante pour supprimer le groupe de ressources et toutes les ressources qu’il contient afin d’éviter les coûts supplémentaires.Otherwise, use the following command to delete the resource group and all its contained resources to avoid incurring further costs.

az group delete --name AzureFunctionsQuickstart-rg

Étapes suivantesNext steps