Schnellstart: Erstellen einer C#-Funktion über die Befehlszeile in Azure

In diesem Artikel erstellen Sie mithilfe von Befehlszeilentools eine C#-Funktion, die auf HTTP-Anforderungen antwortet. Der Code wird lokal getestet und anschließend in der serverlosen Umgebung von Azure Functions bereitgestellt.

In diesem Artikel wird eine durch HTTP ausgelöste Funktion erstellt, die auf .NET 8 in einem isolierten Workerprozess ausgeführt wird. Informationen zu .NET-Versionen, die für C#-Funktionen unterstützt werden, finden Sie unter Unterstützte Versionen. Es gibt auch eine Visual Studio Code-basierte Version dieses Artikels.

Im Rahmen dieser Schnellstartanleitung fallen in Ihrem Azure-Konto ggf. geringfügige Kosten im Centbereich an.

Konfigurieren Ihrer lokalen Umgebung

Bevor Sie mit diesem Lernprogramm beginnen können, benötigen Sie Folgendes:

• .NET 8.0-SDK.

• Eines der folgenden Tools zum Erstellen von Azure-Ressourcen:

  • Azure CLI, Version 2.4 oder höher

  • Das Az PowerShell-Modul Version 5.9.0 oder höher.

Sie benötigen außerdem ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.

Installieren von Azure Functions Core Tools

Die empfohlene Methode zum Installieren von Core Tools hängt vom Betriebssystem Ihres lokalen Entwicklungscomputers ab.

Erstellen eines lokalen Funktionsprojekts

In Azure Functions handelt es sich bei einem Funktionsprojekt um einen Container für eine oder mehrere individuelle Funktionen, die jeweils auf einen bestimmten Trigger reagieren. Für alle Funktionen eines Projekts werden die gleichen lokalen Konfigurationen und Hostkonfigurationen gemeinsam genutzt. In diesem Abschnitt erstellen Sie ein Funktionsprojekt, das nur eine Funktion enthält.

1. Führen Sie den Befehl func init wie folgt aus, um in einem Ordner mit dem Namen LocalFunctionProj ein Funktionsprojekt mit der angegebenen Runtime zu erstellen:

   func init LocalFunctionProj --worker-runtime dotnet-isolated --target-framework net8.0
   

2. Navigieren Sie zum Projektordner:

   cd LocalFunctionProj
   

   Dieser Ordner enthält verschiedene Dateien für das Projekt, z. B. die Konfigurationsdateien local.settings.json und host.json. Da local.settings.json aus Azure heruntergeladene Geheimnisse enthalten kann, wird die Datei in der GITIGNORE-Datei standardmäßig aus der Quellcodeverwaltung ausgeschlossen.

3. Fügen Sie dem Projekt über den unten gezeigten Befehl eine Funktion hinzu. Hierbei ist das --name-Argument der eindeutige Name Ihrer Funktion (HttpExample), mit dem --template-Argument wird der Trigger der Funktion (HTTP) angegeben.

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

   func new erstellt die Codedatei „HttpExample.cs“.

(Optional) Untersuchen des Dateiinhalts

Bei Bedarf können Sie Lokales Ausführen der Funktion überspringen und den Dateiinhalt später untersuchen.

HttpExample.cs

HttpExample.cs enthält eine Run-Methode, die Anforderungsdaten in der req-Variable als HttpRequest-Objekt empfängt. Dieser Parameter ist mit dem HttpTriggerAttribute versehen, um das Triggerverhalten zu definieren.

using System.Net;
using Microsoft.Azure.Functions.Worker;
using Microsoft.Extensions.Logging;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;

namespace Company.Function
{
    public class HttpExample
    {
        private readonly ILogger<HttpExample> _logger;

        public HttpExample(ILogger<HttpExample> logger)
        {
            _logger = logger;
        }

        [Function("HttpExample")]
        public IActionResult Run([HttpTrigger(AuthorizationLevel.AuthLevelValue, "get", "post")] HttpRequest req)
        {            
            _logger.LogInformation("C# HTTP trigger function processed a request.");

            return new OkObjectResult("Welcome to Azure Functions!");
        }
    }
}

Das Rückgabeobjekt ist ein IActionResult-Objekt, das die Daten enthält, die an die HTTP-Antwort zurückgegeben werden.

Weitere Informationen finden Sie unter HTTP-Trigger und -Bindungen in Azure Functions.

Lokales Ausführen der Funktion

1. Führen Sie Ihre Funktion aus, indem Sie den lokalen Azure Functions-Runtimehost im Ordner LocalFunctionProj starten:

   func start
   

   Gegen Ende der Ausgabe sollten die folgenden Zeilen angezeigt werden:

    ...
   
    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
    ...
   
    

   Hinweis

   Sollte „HttpExample“ nicht wie oben dargestellt angezeigt werden, haben Sie den Host wahrscheinlich außerhalb des Stammordners des Projekts gestartet. Drücken Sie in diesem Fall STRG+C, um den Host zu beenden. Navigieren Sie anschließend zum Stammordner des Projekts, und führen Sie den vorherigen Befehl erneut aus.

2. Kopieren Sie die URL Ihrer HttpExample-Funktion aus dieser Ausgabe in einen Browser, und navigieren Sie zur Funktions-URL. Sie sollten eine Nachricht Willkommen bei Azure Functions erhalten.

3. Wenn Sie fertig sind, drücken Sie STRG+C, und wählen Sie y aus, um den Funktionshost zu beenden.

Erstellen von unterstützenden Azure-Ressourcen für Ihre Funktion

Zum Bereitstellen Ihres Funktionscodes in Azure müssen Sie drei Ressourcen erstellen:

• Eine Ressourcengruppe, bei der es sich um einen logischen Container für verwandte Ressourcen handelt.
• Ein Speicherkonto, das verwendet wird, um den Status und andere Informationen zu Ihren Funktionen zu verwalten.
• Eine Funktions-App, die als Umgebung zum Ausführen Ihres Funktionscodes dient. Eine Funktions-App ist Ihrem lokalen Funktionsprojekt zugeordnet und ermöglicht Ihnen das Gruppieren von Funktionen als logische Einheit, um die Verwaltung, Bereitstellung und Freigabe von Ressourcen zu vereinfachen.

Verwenden Sie die folgenden Befehle, um diese Elemente zu erstellen. Sowohl die Azure CLI als auch PowerShell werden unterstützt.

1. Melden Sie sich bei Azure an, falls dies noch nicht geschehen ist:

   • Azure-Befehlszeilenschnittstelle
   • Azure PowerShell

   az login
   

   Mit dem Befehl az login werden Sie bei Ihrem Azure-Konto angemeldet.

2. Erstellen Sie eine Ressourcengruppe mit dem Namen AzureFunctionsQuickstart-rg in der ausgewählten Region:

   • Azure-Befehlszeilenschnittstelle
   • Azure PowerShell

   az group create --name AzureFunctionsQuickstart-rg --location <REGION>
   

   Mit dem Befehl az group create wird eine Ressourcengruppe erstellt. Ersetzen Sie im Befehl oben <REGION> durch eine Region in Ihrer Nähe, indem Sie einen verfügbaren Regionscode verwenden, der mit dem Befehl <REGION> zurückgegeben wird.

3. Erstellen Sie in Ihrer Ressourcengruppe und Region ein universelles Speicherkonto:

   • Azure-Befehlszeilenschnittstelle
   • Azure PowerShell

   az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false
   

   Der Befehl az storage account create erstellt ein Speicherkonto.

   Ersetzen Sie im vorherigen Beispiel <STORAGE_NAME> durch einen Namen, der für Sie geeignet und eindeutig in Azure Storage ist. Namen dürfen nur 3 bis 24 Zeichen und ausschließlich Kleinbuchstaben enthalten. Mit Standard_LRS wird ein universelles Konto angegeben, das von Functions unterstützt wird.

4. Erstellen Sie die Funktions-App in Azure:

   • Azure-Befehlszeilenschnittstelle
   • Azure PowerShell

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

   Der Befehl az functionapp create erstellt die Funktions-App in Azure.

   Ersetzen Sie im vorherigen Beispiel <STORAGE_NAME> durch den Namen des Kontos, das Sie im vorherigen Schritt verwendet haben, und <APP_NAME> durch einen global eindeutigen Namen, der für Sie geeignet ist. <APP_NAME> ist gleichzeitig die DNS-Standarddomäne für die Funktions-App.

   Mit diesem Befehl wird eine Funktions-App erstellt, für die die von Ihnen angegebene Language Runtime unter dem Azure Functions-Verbrauchstarif ausgeführt wird. Dies ist für die Nutzungsmenge, die in diesem Fall anfällt, kostenlos. Der Befehl erstellt in derselben Ressourcengruppe auch eine zugeordnete Azure Application Insights-Instanz, mit der Sie Ihre Funktions-App überwachen und Protokolle anzeigen können. Weitere Informationen finden Sie unter Überwachen von Azure Functions. Für die Instanz fallen erst Kosten an, wenn Sie sie aktivieren.

Bereitstellen des Funktionsprojekts in Azure

Nach erfolgreicher Erstellung Ihrer Funktions-App in Azure können Sie Ihr lokales Funktionsprojekt bereitstellen. Verwenden Sie dazu den func azure functionapp publish-Befehl.

Führen Sie im Stammordner des Projekts diesen func azure functionapp publish-Befehl aus:

func azure functionapp publish <APP_NAME>

Ersetzen Sie in diesem Beispiel <APP_NAME> durch den Namen Ihrer App. Bei einer erfolgreichen Bereitstellung werden Ergebnisse wie in der folgenden (gekürzten) Ausgabe angezeigt:

...

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

Aufrufen der Funktion in Azure

Da Ihre Funktion einen HTTP-Trigger verwendet und GET-Anforderungen unterstützt, rufen Sie sie auf, indem Sie eine HTTP-Anforderung an die zugehörige URL senden. Am einfachsten erreichen Sie dies über einen Browser.

Kopieren Sie die vollständige Aufruf-URL, die in der Ausgabe des publish-Befehls angezeigt wird, in eine Browseradressleiste. Wenn Sie zu dieser URL navigieren, sollte der Browser eine ähnliche Ausgabe anzeigen wie bei der lokalen Ausführung der Funktion.

Führen Sie den folgenden Befehl aus, um Streamingprotokolle nahezu in Echtzeit anzuzeigen:

func azure functionapp logstream <APP_NAME> 

In einem separaten Terminalfenster oder im Browser rufen Sie die Remotefunktion erneut auf. Ein ausführliches Protokoll der Funktionsausführung in Azure wird im Terminal angezeigt.

Bereinigen von Ressourcen

Gehen Sie wie folgt vor, falls Sie mit dem nächsten Schritt fortfahren möchten: Fügen Sie eine Ausgabebindung für die Azure Storage-Warteschlange hinzu, und behalten Sie alle Ressourcen bei, weil der nächste Schritt auf der bisherigen Arbeit aufbaut.

Verwenden Sie andernfalls den unten angegebenen Befehl, um die Ressourcengruppe und alle darin enthaltenen Ressourcen zu löschen, damit keine weiteren Kosten anfallen.

az group delete --name AzureFunctionsQuickstart-rg

Remove-AzResourceGroup -Name AzureFunctionsQuickstart-rg

Nächste Schritte