Lokale Entwicklung von Azure Functions mithilfe von Core Tools

Mit Azure Functions Core Tools können Sie Ihre Funktionen auf dem lokalen Computer entwickeln und testen. Wenn Sie bereit sind, können Sie auch Core Tools verwenden, um Ihr Codeprojekt in Azure bereitzustellen und mit Anwendungseinstellungen zu arbeiten.

Installieren von Azure Functions Core Tools

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

Hilfe zu versionsbezogenen Problemen finden Sie unter Core Tools-Versionen.

Erstellen Ihres lokalen Projekts

Führen Sie im Terminalfenster oder an einer Eingabeaufforderung den folgenden Befehl aus, um ein Projekt im Ordner MyProjFolder zu erstellen:

func init MyProjFolder --worker-runtime dotnet-isolated 

func init MyProjFolder --worker-runtime dotnet 

func init MyProjFolder --worker-runtime javascript --model V4

func init MyProjFolder --worker-runtime javascript --model V3

func init MyProjFolder --worker-runtime typescript --model V4

func init MyProjFolder --worker-runtime typescript --model V3

func init MyProjFolder --worker-runtime powershell

func init MyProjFolder --worker-runtime python --model V2

func init MyProjFolder --worker-runtime python

Wenn Sie func init ohne die Option --worker-runtime ausführen, werden Sie aufgefordert, Ihre Projektsprache auszuwählen. Weitere Informationen zu den verfügbaren Optionen für den Befehl func init finden Sie in der Referenz zu func init.

Erstellen einer Funktion

Um Ihrem Projekt eine Funktion hinzuzufügen, führen Sie den func new-Befehl mit der --template-Option aus, um Ihre Triggervorlage auszuwählen. Im folgenden Beispiel wird ein HTTP-Trigger mit Namen MyHttpTrigger erstellt:

func new --template "Http Trigger" --name MyHttpTrigger

In diesem Beispiel wird ein Queue Storage-Trigger mit dem Namen MyQueueTrigger erstellt:

func new --template "Azure Queue Storage Trigger" --name MyQueueTrigger

Die folgenden Überlegungen gelten beim Hinzufügen neuer Funktionen:

• Wenn Sie func new ohne die Option --template ausführen, werden Sie aufgefordert, eine Vorlage auszuwählen.

• Mit dem Befehl func templates list können Sie sich die vollständige Liste der verfügbaren Vorlagen für Ihre Programmiersprache anzeigen lassen.

• Wenn Sie einen Trigger hinzufügen, der eine Verbindung mit einem Dienst herstellt, müssen Sie auch eine Anwendungseinstellung hinzufügen, die auf eine Verbindungszeichenfolge oder eine verwaltete Identität in der Datei local.settings.json verweist. Die Verwendung der App-Einstellungen auf diese Weise verhindert, dass Sie Anmeldeinformationen in Ihren Code einbetten müssen. Weitere Informationen finden Sie unter Lokales Arbeiten mit App-Einstellungen.

Weitere Informationen zu den verfügbaren Optionen für den Befehl func new finden Sie in der Referenz zu func new.

Hinzufügen einer Bindung zu Ihrer Funktion

Functions bietet eine Reihe dienstspezifischer Eingabe- und Ausgabebindungen, die es Ihrer Funktion erleichtern, eine Verbindung mit anderen Azure-Diensten herzustellen, ohne die dienstspezifischen Client-SDKs verwenden zu müssen. Weitere Informationen finden Sie unter Konzepte für Azure Functions-Trigger und -Bindungen.

Um einer vorhandenen Funktion Eingabe- oder Ausgabebindungen hinzuzufügen, müssen Sie die Funktionsdefinition manuell aktualisieren.

Das folgende Beispiel zeigt die Funktionsdefinition nach dem Hinzufügen einer Queue Storage-Ausgabebindung zu einer von HTTP ausgelösten Funktion:

[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"
    }
  ]
}

Die folgenden Überlegungen gelten beim Hinzufügen von Bindungen zu einer Funktion:

• Wenn Sie Bindungen hinzufügen, die eine Verbindung mit einem Dienst herstellen, müssen Sie auch eine Anwendungseinstellung hinzufügen, die auf eine Verbindungszeichenfolge oder eine verwaltete Identität in der Datei local.settings.json verweist. Weitere Informationen finden Sie unter Lokales Arbeiten mit App-Einstellungen.

Starten der Functions-Runtime

Bevor Sie die Funktionen in Ihrem Projekt ausführen oder debuggen können, müssen Sie den Functions-Host aus dem Stammverzeichnis Ihres Projekts starten. Der Host aktiviert Trigger für alle Funktionen im Projekt. Verwenden Sie diesen Befehl, um die lokale Runtime zu starten:

mvn clean package 
mvn azure-functions:run

func start

func start

func start

npm install
npm start     

Bei seinem Start gibt der Functions-Host eine Liste von Funktionen im Projekt aus, einschließlich der URLs aller von HTTP ausgelösten Funktionen, wie in diesem Beispiel:

Found the following functions:
Host.Functions.MyHttpTrigger

Job host started
Http Function MyHttpTrigger: http://localhost:7071/api/MyHttpTrigger

Beachten Sie die folgenden Überlegungen, wenn Sie Ihre Funktionen lokal ausführen:

• Standardmäßig wird Autorisierung für HTTP-Endpunkte lokal nicht erzwungen. Das bedeutet, dass alle lokalen HTTP-Anforderungen wie authLevel = "anonymous" behandelt werden. Weitere Informationen finden Sie unter Autorisierungsebene. Sie können die --enableAuth-Option verwenden, um eine Autorisierung zu erfordern, wenn Sie lokal ausgeführt wird. Weitere Informationen finden Sie unter func start.

• Sie können den lokalen Azurite-Emulator verwenden, um Funktionen, die Zugriff auf Azure Storage-Dienste (Queue Storage, Blob Storage und Table Storage) benötigen, lokal auszuführen, ohne eine Verbindung mit diesen Diensten in Azure herstellen zu müssen. Achten Sie bei der Verwendung der lokalen Emulation darauf, dass Sie Azurite starten, bevor Sie den lokalen Host (func.exe) starten. Weitere Informationen finden Sie unter Emulation für lokalen Speicher.

• Sie können Nicht-HTTP-Funktionen lokal auslösen, ohne eine Verbindung mit einem Livedienst herzustellen. Weitere Informationen finden Sie unter Ausführen einer lokalen Funktion.

• Wenn Sie Ihre Application Insights-Verbindungsinformationen in die Datei „local.settings.json“ einschließen, werden lokale Protokolldaten in die spezifische Application Insights-Instanz geschrieben. Um lokale Telemetriedaten von Produktionsdaten getrennt zu halten, sollten Sie eine separate Application Insights-Instanz für die Entwicklung und Tests verwenden.

Ausführen einer lokalen Funktion

Wenn Ihr lokaler Functions-Host (func.exe) ausgeführt wird, können Sie jetzt einzelne Funktionen auslösen, um Ihren Funktionscode auszuführen und zu debuggen. Wie Sie eine einzelne Funktion ausführen, hängt vom zugehörigen Triggertyp ab.

http://localhost:<PORT>/api/<FUNCTION_NAME>

curl --get http://localhost:7071/api/MyHttpTrigger?name=Azure%20Rocks

curl --request POST http://localhost:7071/api/MyHttpTrigger --data '{"name":"Azure Rocks"}'

curl --request POST http://localhost:7071/api/MyHttpTrigger --data "{'name':'Azure Rocks'}"

http://localhost:<PORT>/admin/functions/<FUNCTION_NAME>

{
    "input": "<TRIGGER_INPUT>"
}

curl --request POST -H "Content-Type:application/json" --data '{"input":"sample queue data"}' http://localhost:7071/admin/functions/QueueTrigger

curl --request POST -H "Content-Type:application/json" --data "{'input':'sample queue data'}" http://localhost:7071/admin/functions/QueueTrigger

Veröffentlichen in Azure

Die Azure Functions Core Tools unterstützen drei Bereitstellungstypen:

Sie müssen entweder die Azure-Befehlszeilenschnittstelle oder die Azure PowerShell lokal installiert haben, um von Core Tools aus in Azure veröffentlichen zu können. Standardmäßig verwendet Core Tools diese Tools zur Authentifizierung mit Ihrem Azure-Konto.

Wenn Sie diese Tools nicht installiert haben, müssen Sie stattdessen ein gültiges Zugriffstoken abrufen, das Sie während der Bereitstellung verwenden können. Sie können ein Zugriffstoken mit der Option --access-token in den Bereitstellungsbefehlen angeben.

Bereitstellen von Projektdateien

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

Container bereitstellen

Mit Core Tools können Sie Ihre containerisierte Funktions-App sowohl in verwalteten Azure Container Apps-Umgebungen als auch in Kubernetes-Clustern bereitstellen, die Sie verwalten.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> [--registry-password] [--registry-server] [--registry-username]

func kubernetes deploy --name <DEPLOYMENT_NAME> --registry <REGISTRY_USERNAME> 

Lokales Arbeiten mit App-Einstellungen

Bei der Ausführung in einer Funktions-App in Azure werden die von Ihren Funktionen benötigten Einstellungen sicher in den App-Einstellungen gespeichert. Bei der lokalen Entwicklung werden diese Einstellungen stattdessen zur Values-Sammlung in der Datei local.settings.json hinzugefügt. Die Datei „local.settings.json“ speichert auch Einstellungen, die von lokalen Entwicklungstools verwendet werden.

Elemente in der Values-Sammlung in der Datei local.settings.json Ihres Projekts sollen Elemente in den Anwendungseinstellungen Ihrer Funktions-App in Azure widerspiegeln.

Die folgenden Überlegungen gelten beim Arbeiten mit der lokalen Einstellungsdatei:

• Da die Datei „local.settings.json“ möglicherweise Geheimnisse wie Verbindungszeichenfolgen enthält, sollten Sie sie niemals in einem Remoterepository speichern. Core Tools unterstützt Sie bei der Verschlüsselung dieser lokalen Einstellungsdatei, um die Sicherheit zu verbessern. Weitere Informationen finden Sie unter Datei für lokale Einstellungen. Sie können für zusätzliche Sicherheit auch die Datei local.settings.json verschlüsseln.

• Standardmäßig werden lokale Einstellungen nicht automatisch migriert, wenn das Projekt in Azure veröffentlicht wird. Verwenden Sie die --publish-local-settings-Option, wenn Sie Ihre Projektdateien veröffentlichen, um sicherzustellen, dass diese Einstellungen zur Funktions-App in Azure hinzugefügt werden. Werte im Abschnitt ConnectionStrings werden nie veröffentlicht. Sie können auch jederzeit Einstellungen aus der Datei local.settings.json hochladen.

• Sie können Einstellungen in Ihrer Datei local.settings.json herunterladen und mit Einstellungen aus Ihrer Funktions-App in Azure überschreiben. Weitere Informationen finden Sie unter Herunterladen von Anwendungseinstellungen.

• Wenn keine gültige Speicherverbindungszeichenfolge für AzureWebJobsStorage festgelegt ist und der lokale Speicheremulator nicht verwendet wird, wird ein Fehler angezeigt. Sie können Core Tools für das Herunterladen einer bestimmten Verbindungszeichenfolge aus einem Ihrer Azure Storage-Konten verwenden.

Herunterladen von Anwendungseinstellungen

Verwenden Sie im Projektstamm den folgenden Befehl, um alle Anwendungseinstellungen aus der myfunctionapp12345-App in Azure herunterzuladen:

func azure functionapp fetch-app-settings myfunctionapp12345

Dieser Befehl überschreibt alle vorhandenen Einstellungen in der Datei local.settings.json mit Werten aus Azure. Wenn sie noch nicht vorhanden sind, werden neue Elemente der Sammlung hinzugefügt. Weitere Informationen finden Sie im Abschnitt zum func azure functionapp fetch-app-settings-Befehl.

Herunterladen einer Speicherverbindungszeichenfolge

Core Tools erleichtern außerdem das Abrufen der Verbindungszeichenfolge jedes Speicherkontos, auf das Sie Zugriff haben. Verwenden Sie im Projektstamm den folgenden Befehl, um die Verbindungszeichenfolge aus einem Speicherkonto mit Namen mystorage12345 herunterzuladen.

func azure storage fetch-connection-string mystorage12345

Dieser Befehl fügt der Datei local.settings.json eine Einstellung mit dem Namen mystorage12345_STORAGE hinzu, welche die Verbindungszeichenfolge für das mystorage12345-Konto enthält. Weitere Informationen finden Sie im Abschnitt zum func azure storage fetch-connection-string-Befehl.

Um die Sicherheit während der Entwicklung zu verbessern, sollten Sie die Datei local.settings.json verschlüsseln.

Hochladen lokaler Einstellungen in Azure

Wenn Sie Ihre Projektdateien in Azure veröffentlichen, ohne die --publish-local-settings-Option zu verwenden, werden die Einstellungen in der Datei local.settings.json in Ihrer Funktions-App nicht festgelegt. Sie können die func azure functionapp publish mit der --publish-settings-only-Option immer wieder ausführen, um nur die Einstellungen hochzuladen, ohne die Projektdateien erneut zu veröffentlichen.

Im folgenden Beispiel werden nur Einstellungen aus der Values-Sammlung in der Datei local.settings.json in die Funktions-App in Azure mit dem Namen myfunctionapp12345 hochgeladen:

func azure functionapp publish myfunctionapp12345 --publish-settings-only

Verschlüsseln der lokalen Einstellungsdatei

Um die Sicherheit von Verbindungszeichenfolgen und anderen wertvollen Daten in Ihren lokalen Einstellungen zu verbessern, können Sie mit Core Tools die Datei local.settings.json verschlüsseln. Wenn diese Datei verschlüsselt ist, entschlüsselt die Runtime die Einstellungen bei Bedarf automatisch auf die gleiche Weise wie die Anwendungseinstellung in Azure. Sie können auch eine lokal verschlüsselte Datei entschlüsseln, um mit den Einstellungen zu arbeiten.

Verwenden Sie den folgenden Befehl, um die lokale Einstellungsdatei für das Projekt zu verschlüsseln:

func settings encrypt

Verwenden Sie den folgenden Befehl, um eine verschlüsselte lokale Einstellung zu entschlüsseln, damit Sie damit arbeiten können:

func settings decrypt

Wenn die Einstellungsdatei verschlüsselt und entschlüsselt wird, wird auch die IsEncrypted-Einstellung der Datei aktualisiert.

Konfigurieren von Bindungserweiterungen

Functions-Trigger und -Bindungen werden als .NET-Erweiterungspakete (NuGet) implementiert. Um eine bestimmte Bindungserweiterung verwenden zu können, muss diese Erweiterung im Projekt installiert sein.

Core Tools-Versionen

Hauptversionen von Azure Functions Core Tools sind mit bestimmten Hauptversionen der Azure Functions-Runtime verknüpft. Beispielsweise unterstützt Version 4.x von Core Tools Version 4.x der Functions-Runtime. Diese Version ist die empfohlene Hauptversion sowohl der Functions-Runtime als auch der Core Tools. Sie können die neueste Releaseversion von Core Tools im Azure Functions Core Tools-Repository ermitteln.

Führen Sie den folgenden Befehl aus, um die Version Ihrer aktuellen Core Tools-Installation zu ermitteln:

func --version

Sofern nicht anders angegeben, gelten die Beispiele in diesem Artikel für Version 4.x.

Die folgenden Überlegungen gelten für Core Tools-Installationen:

• Sie können auf einem Computer immer nur jeweils eine Version der Core Tools installieren.

• Wenn Sie ein Core Tools-Upgrade auf die neueste Version durchführen, sollten Sie für das Upgrade dieselbe Methode einsetzen, die Sie bei der ursprüngliche Installation verwendet haben. Wenn Sie beispielsweise eine MSI unter Windows verwendet haben, deinstallieren Sie die aktuelle MSI, und installieren Sie die neueste. Wenn Sie npm verwendet haben, führen Sie npm install command erneut aus.

• Version 2.x und 3.x der Core Tools wurden mit den Versionen 2.x und 3.x der Functions-Runtime verwendet, die das Supportende erreicht haben. Weitere Informationen finden Sie unter Einstellen von Runtimeversionen von Azure Functions als Ziel.

Nächste Schritte

Erfahren Sie, wie Sie entwickeln, testen und veröffentlichen von Azure-Funktionen mithilfe der Kerntools von Azure Functions. Azure Functions Core Tools ist ein Open Source-Programm und wird auf GitHub gehostet. Um einen Fehler zu melden oder ein Feature anzufordern, öffnen Sie ein GitHub-Problem.