Freigeben über

Referenz zu Azure Functions Core Tools

  • Artikel

Dieser Artikel enthält Referenzdokumentation für die Azure Functions Core Tools, mit denen Sie Azure Functions-Projekte auf Ihrem lokalen Computer entwickeln, verwalten und bereitstellen können. Weitere Informationen zur Verwendung der Core Tools finden Sie unter Arbeiten mit Azure Functions Core Tools.

Core Tools-Befehle sind in den folgenden Kontexten organisiert, die jeweils einen eindeutigen Satz von Aktionen bereitstellen.

Befehlskontext BESCHREIBUNG
func Befehle, die zum Erstellen und Ausführen von Funktionen auf Ihrem lokalen Computer verwendet werden.
func azure Befehle zum Arbeiten mit Azure-Ressourcen, einschließlich Veröffentlichung.
func azurecontainerapps Stellen Sie eine containerisierte Funktions-App in Azure Container Apps bereit.
func durable Befehle zum Arbeiten mit Durable Functions.
func extensions Befehle zum Installieren und Verwalten von Erweiterungen.
func kubernetes Befehle zum Arbeiten mit Kubernetes und Azure Functions.
func settings Befehle zum Verwalten von Umgebungseinstellungen für den lokalen Functions-Host.
func templates Befehle zum Auflisten verfügbarer Funktionsvorlagen.

Bevor Sie die Befehle in diesem Artikel verwenden, müssen Sie die Core Tools installieren.

func init

Erstellt ein neues Functions-Projekt in einer bestimmten Sprache.

func init <PROJECT_FOLDER>

Wenn Sie <PROJECT_FOLDER> angeben, wird das Projekt in einem neuen Ordner mit diesem Namen erstellt. Andernfalls wird der aktuelle Ordner verwendet.

func init unterstützt die folgenden Optionen, die Version 1.x nicht unterstützen, sofern nicht anders angegeben:

Option BESCHREIBUNG
--csx Erstellt .NET-Funktionen als C#-Skript, dies entspricht dem Verhalten in Version 1.x. Nur mit --worker-runtime dotnet gültig.
--docker Erstellt ein Dockerfile für einen Container mithilfe eines Basisimages, das auf dem ausgewählten Wert für --worker-runtime basiert. Verwenden Sie diese Option, wenn Sie die Bereitstellung einer containerisierten Funktions-App planen.
--docker-only Fügt einem vorhandenen Projekt eine Dockerfile hinzu. Fordert die Worker-Runtime an, wenn sie nicht angegeben oder in „local.settings.json“ festgelegt wurde. Verwenden Sie diese Option, wenn Sie planen, eine containerisierte Funktions-App bereitzustellen und das Projekt bereits vorhanden ist.
--force Initialisiert das Projekt, auch wenn es bereits Dateien enthält. Diese Einstellung überschreibt vorhandene Dateien mit dem gleichen Namen. Andere Dateien im Projektordner sind nicht betroffen.
--language Initialisiert ein sprachspezifisches Projekt. Wird derzeit unterstützt, wenn --worker-runtime auf node festgelegt ist. Die Optionen sind typescript und javascript. Sie können auch --worker-runtime javascript oder --worker-runtime typescript verwenden.
--managed-dependencies Installiert verwaltete Abhängigkeiten. Derzeit unterstützt nur die PowerShell-Workerruntime diese Funktion.
--model Legt das gewünschte Programmiermodell für eine Zielsprache fest, wenn mehr als ein Modell verfügbar ist. Unterstützte Optionen sind V1 und V2 für Python und V3 und V4 für Node.js. Weitere Informationen finden Sie im Python-Entwicklerhandbuch respektive im Node.js Entwicklerhandbuch.
--source-control Steuert, ob ein Git-Repository erstellt wird. Standardmäßig wird kein Repository erstellt. Im Fall von true wird ein Repository erstellt.
--worker-runtime Legt die Runtime der Sprache für das Projekt fest. Unterstützte Werte sind: csharp, dotnet, dotnet-isolated, javascript, node (JavaScript), powershell, python und typescript. Verwenden Sie Maven für Java. Verwenden Sie custom, um ein sprachunabhängiges Projekt nur mit den Projektdateien zu generieren. Wird kein Wert festgelegt, werden Sie während der Initialisierung zur Auswahl der Runtime aufgefordert.
--target-framework Legt das Zielframework für das Funktions-App-Projekt fest. Nur mit --worker-runtime dotnet-isolated gültig. Unterstützte Werte sind: net9.0 (Vorschau), net8.0 (Standard), net6.0und net48 (.NET Framework 4.8).

Hinweis

Wenn Sie eine der Optionen --docker oder --docker-only verwenden, erstellen die Core Tools automatisch die Dockerfile-Datei für C#-, JavaScript-, Python- und PowerShell-Funktionen. Für Java-Funktionen müssen Sie die Dockerfile-Datei manuell erstellen. Weitere Informationen finden Sie unter Erstellen von containerisierten Funktions-Apps.

func logs

Ruft Protokolle für Funktionen ab, die in einem Kubernetes-Cluster ausgeführt werden.

func logs --platform kubernetes --name <APP_NAME>

Die func logs-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--platform Hostingplattform für die Funktions-App Unterstützte Optionen: kubernetes.
--name Funktions-App-Name in Azure.

Weitere Informationen finden Sie unter Azure Functions in Kubernetes mit KEDA.

func new

Erstellt eine neue Funktion im aktuellen Projekt basierend auf einer Vorlage.

func new

Wenn Sie func new ohne die Option --template ausführen, werden Sie aufgefordert, eine Vorlage auszuwählen. Auch in Version 1.x müssen Sie auch die Sprache auswählen.

Die func new-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--authlevel Hiermit können Sie die Autorisierungsebene für einen HTTP-Trigger festlegen. Folgende Werte werden unterstützt: function, anonymous, admin. Autorisierung wird bei lokaler Ausführung nicht erzwungen. Weitere Informationen finden Sie unter Autorisierungsebene.
--csx (Version 2.x und höher) Generiert dieselben C#-Skriptvorlagen (.csx), die in Version 1.x und im Portal verwendet wurden.
--language, -l Die Vorlagenprogrammiersprache, z.B. C#, F# oder JavaScript. Diese Option ist in Version 1.x erforderlich. In Version 2.x und höher verwenden Sie diese Option nicht, da die Sprache von der Workerruntime definiert wird.
--name, -n Der Funktionsname.
--template, -t Mit dem Befehl func templates list können Sie sich die vollständige Liste der verfügbaren Vorlagen für jede unterstützte Sprache anzeigen lassen.

Weitere Informationen finden Sie unter Erstellen einer Funktion.

func run

Nur Version 1.x.

Ermöglicht es Ihnen, eine Funktion direkt aufzurufen, ähnlich wie bei der Ausführung einer Funktion über die Registerkarte Test im Azure-Portal. Diese Aktion wird nur in Version 1.x unterstützt. Verwenden Sie für spätere Versionen func start, und rufen Sie den Funktionsendpunkt direkt auf.

func run

Die func run-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--content Inlineinhalt, der an die Funktion übergeben wird.
--debug Anfügen eines Debuggers an den Hostprozess vor dem Ausführen der Funktion.
--file Der als Inhalt zu verwendende Dateiname.
--no-interactive Fordert keine Eingabe an, was für Automatisierungsszenarien nützlich ist.
--timeout Wartezeit (in Sekunden), bis der lokale Functions-Host bereit ist.

Um z.B. eine HTTP-ausgelöste Funktion aufzurufen und Inhaltstext zu übergeben, führen Sie folgenden Befehl aus:

func run MyHttpTrigger --content '{\"name\": \"Azure\"}'

func start

Startet den lokalen Laufzeithost und lädt das Funktionsprojekt in den aktuellen Ordner.

Der jeweilige Befehl hängt von der Laufzeitversion ab.

func start

func start unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--cert Der Pfad zu einer PFX-Datei, die einen privaten Schlüssel enthält. Wird nur mit --useHttps unterstützt.
--cors Eine durch Trennzeichen getrennte Liste der CORS-Ursprünge ohne Leerzeichen.
--cors-credentials Ursprungsübergreifende authentifizierte Anforderungen mit Cookies und dem Authentifizierungsheader.
--dotnet-isolated-debug Wenn auf true festgelegt, wird der .NET-Workerprozess angehalten, bis ein Debugger aus dem isolierten .NET-Projekt angefügt wird, das debuggt wird.
--enable-json-output Gibt Konsolenprotokolle nach Möglichkeit im JSON-Format aus.
--enableAuth Aktivieren Sie die Pipeline für die vollständige Authentifizierungsbehandlung mit Autorisierungsanforderungen.
--functions Eine durch Leerzeichen getrennte Liste der zu ladenden Funktionen.
--language-worker Argumente zum Konfigurieren des Spracharbeitsthreads. Beispielsweise können Sie das Debuggen für den Sprachworker aktivieren, indem Sie den Debugport und andere erforderliche Argumente bereitstellen.
--no-build Das aktuelle Projekt wird vor der Ausführung nicht erstellt. Nur für .NET-Klassenprojekte. Der Standardwert lautet false.
--password Entweder das Kennwort oder eine Datei, die das Kennwort für eine PFX-Datei enthält. Nur mit --cert verwendet.
--port Der lokale Port, auf dem gelauscht werden soll. Standardwert: 7071.
--timeout Das Timeout für den zu startenden Functions-Host in Sekunden. Standardwert: 20 Sekunden.
--useHttps Erstellen Sie eine Bindung an https://localhost:{port} statt an http://localhost:{port}. Standardmäßig erstellt diese Option ein vertrauenswürdiges Zertifikat auf Ihrem Computer.

Wenn das Projekt ausgeführt wird, können Sie einzelne Funktionsendpunkte überprüfen.

func azure functionapp fetch-app-settings

Ruft Einstellungen aus einer bestimmten Funktions-App ab.

func azure functionapp fetch-app-settings <APP_NAME>

Weitere Informationen finden Sie unter Herunterladen von Anwendungseinstellungen.

Einstellungen werden in die Datei „local.settings.json“ für das Projekt heruntergeladen. Werte auf dem Bildschirm werden aus Sicherheitsgründen maskiert. Sie können die Einstellungen in der Datei „local.settings.json“ schützen, indem Sie lokale Verschlüsselung aktivieren.

func azure functionapp list-functions

Gibt eine Liste der Funktionen in der angegebenen Funktions-App zurück.

func azure functionapp list-functions <APP_NAME>

func azure functionapp logstream

Verbindet die lokale Eingabeaufforderung mit Streamingprotokollen für die Funktions-App in Azure.

func azure functionapp logstream <APP_NAME>

Das Standardtimeout für die Verbindung beträgt 2 Stunden. Sie können das Timeout ändern, indem Sie eine App-Einstellung mit dem Namen SCM_LOGSTREAM_TIMEOUT mit einem Timeoutwert in Sekunden hinzufügen. Noch nicht unterstützt für Linux-Apps im Verbrauchsplan. Verwenden Sie für diese Apps die Option --browser, um Protokolle im Portal anzuzeigen.

Die deploy-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--browser Öffnen des Azure Application Insights-Livestreams für die Funktions-App im Standardbrowser.

Weitere Informationen finden Sie unter Aktivieren des Streamings von Ausführungsprotokollen in Azure Functions.

func azure functionapp publish

Stellt ein Functions-Projekt für eine vorhandene Funktions-App-Ressource in Azure bereit.

func azure functionapp publish <APP_NAME>

Weitere Informationen finden Sie unter Bereitstellen von Projektdateien.

Die folgenden Veröffentlichungsoptionen gelten basierend auf der Version:

Option Beschreibung
--access-token Hiermit können Sie ein bestimmtes Zugriffstoken verwenden, wenn authentifizierte azure Aktionen ausgeführt werden.
--access-token-stdin Liest ein bestimmtes Zugriffstoken wird aus einer Standardeingabe aus. Verwenden Sie diese Option, wenn Sie das Token direkt aus einem vorherigen Befehl wie az account get-access-token lesen.
--additional-packages Liste der zu installierenden Pakete beim Erstellen nativer Abhängigkeiten. Beispiel: python3-dev libevent-dev.
--build, -b Führt beim Bereitstellen in einer Linux-Funktions-App eine Buildaktion durch. Akzeptiert: remote und local.
--build-native-deps Überspringt das Generieren des Ordners .wheels beim Veröffentlichen von Python-Funktions-Apps.
--csx Veröffentlicht ein C#-Skriptprojekt (.csx).
--dotnet-cli-params Beim Veröffentlichen kompilierter C#-Funktionen (CSPROJ-Dateien) rufen die Core Tools dotnet build --output bin/publish auf. Alle daran übergebenen Parameter werden an die Befehlszeile angefügt.
--force In bestimmten Szenarien wird die Überprüfung vor der Veröffentlichung ignoriert.
--list-ignored-files Zeigt eine Liste mit Dateien an, die bei der Veröffentlichung ignoriert werden (basierend auf der .funcignore-Datei).
--list-included-files Zeigt eine Liste mit Dateien an, die veröffentlicht werden (basierend auf der .funcignore-Datei).
--management-url Legt die Verwaltungs-URL für Ihre Cloud fest. Verwenden Sie diese Option, wenn Sie in einer souveränen Cloud ausgeführt werden.
--no-build Das Projekt wird während der Veröffentlichung nicht erstellt. Für Python wird pip install nicht ausgeführt.
--nozip Deaktiviert den Standardmodus Run-From-Package.
--overwrite-settings -y Unterdrückt die Aufforderung zum Überschreiben von App-Einstellungen bei Verwendung von --publish-local-settings -i.
--publish-local-settings -i Einstellungen zur Veröffentlichung in Azure in „local.settings.json“. Wenn die Einstellung bereits vorhanden ist, werden Sie gefragt, ob sie überschrieben werden soll. Wenn Sie einen lokalen Speicheremulator verwenden, ändern Sie zunächst die App-Einstellung in eine tatsächliche Speicherverbindung.
--publish-settings-only, -o Veröffentlicht nur die Einstellungen, der Inhalt wird übersprungen. Standard ist die Eingabeaufforderung.
--slot Optionaler Name eines bestimmten Slots, in dem veröffentlicht werden soll.
--subscription Legt das zu verwendende Standardabonnement fest.

func azure storage fetch-connection-string

Ruft die Verbindungszeichenfolge für das angegebene Azure-Speicherkonto ab.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Weitere Informationen finden Sie unter Herunterladen einer Speicherverbindungszeichenfolge.

func azurecontainerapps deploy

Stellt eine containerisierte Funktions-App in einer Azure Container Apps-Umgebung bereit. Sowohl das von der Funktions-App verwendete Speicherkonto als auch die Umgebung müssen bereits vorhanden sein. Weitere Informationen finden Sie unter Azure Container Apps-Hosting von Azure Functions.

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

Die folgenden Bereitstellungsoptionen gelten:

Option Beschreibung
--access-token Hiermit können Sie ein bestimmtes Zugriffstoken verwenden, wenn authentifizierte azure Aktionen ausgeführt werden.
--access-token-stdin Liest ein bestimmtes Zugriffstoken wird aus einer Standardeingabe aus. Verwenden Sie diese Option, wenn Sie das Token direkt aus einem vorherigen Befehl wie az account get-access-token lesen.
--environment Der Name einer vorhandenen Container Apps-Umgebung.
--image-build Wenn true festgelegt ist, wird das lokale Docker-Build übersprungen.
--image-name Der Imagename eines vorhandenen Containers in einer Containerregistrierung. Der Imagename enthält den Tagnamen.
--location Region für die Bereitstellung. Im Idealfall ist dies dieselbe Region wie die Ressourcen der Umgebung und des Speicherkontos.
--management-url Legt die Verwaltungs-URL für Ihre Cloud fest. Verwenden Sie diese Option, wenn Sie in einer souveränen Cloud ausgeführt werden.
--name Der Name, der für die Funktions-App-Bereitstellung in der Container Apps-Umgebung verwendet wird. Dieser Name wird auch beim Verwalten der Funktions-App im Portal verwendet. Der Name sollte in der Umgebung eindeutig sein.
--registry Wenn festgelegt, wird ein Docker-Build ausgeführt, und das Image wird in eine Registrierung gepusht, die in --registry festgelegt wurde. Sie können --registry nicht mit --image-name verwenden. Verwenden Sie für Docker Hub auch --registry-username.
--registry-password Das Kennwort oder Token, das zum Abrufen des Images aus einer privaten Registrierung verwendet wird.
--registry-username Der Benutzername, der zum Abrufen des Images aus einer privaten Registrierung verwendet wird.
--resource-group Die Ressourcengruppe, in der die funktionsbezogenen Ressourcen erstellt werden sollen.
--storage-account Die Verbindungszeichenfolge für das Speicherkonto, das von der Funktions-App verwendet werden soll.
--subscription Legt das zu verwendende Standardabonnement fest.
--worker-runtime Legt die Laufzeitsprache der Funktions-App fest. Dieser Parameter wird nur mit --image-name und --image-build verwendet, andernfalls wird die Sprache während des lokalen Builds bestimmt. Unterstützte Werte sind : dotnet, dotnetIsolated, node, python, powershell und custom (für Kundenhandler).

Wichtig

Speicherverbindungszeichenfolgen und andere Dienstanmeldeinformationen sind wichtige Geheimnisse. Stellen Sie sicher, dass Sie Skriptdateien mit func azurecontainerapps deploy sicher und nicht in einer öffentlich zugänglichen Quellcodeverwaltung speichern.

func deploy

Der func deploy-Befehl ist veraltet. Verwenden Sie stattdessen func kubernetes deploy.

func durable delete-task-hub

Löscht alle Speicherartefakte im Durable Functions-Aufgabenhub.

func durable delete-task-hub

Die delete-task-hub-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--task-hub-name Optionaler Name des zu verwendenden Hubs für die dauerhafte Aufgabe.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable get-history

Gibt den Verlauf der angegebenen Orchestrierungsinstanz zurück.

func durable get-history --id <INSTANCE_ID>

Die get-history-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--task-hub-name Optionaler Name des zu verwendenden Hubs für die dauerhafte Aufgabe.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable get-instances

Gibt den Status aller Orchestrierungsinstanzen zurück. Unterstützt Paging mit dem Parameter top.

func durable get-instances

Die get-instances-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--continuation-token Optionales Token, das eine bestimmte Seite bzw. einen bestimmten Abschnitt der zurückzugebenden Anforderungen angibt.
--connection-string-setting Optionaler Name der App-Einstellung, die die zu verwendende Speicherverbindungszeichenfolge enthält.
--created-after Ruft optional die nach diesem Datum bzw. dieser Uhrzeit (UTC) erstellten Instanzen ab. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--created-before Ruft optional die vor einem bestimmten Datum bzw. einer bestimmten Uhrzeit (UTC) erstellten Instanzen ab. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--runtime-status Ruft optional die Instanzen ab, deren Status mit einem bestimmten Status übereinstimmt, einschließlich running, completed und failed. Sie können ein oder mehrere durch Leerzeichen getrennte Status angeben.
--top Begrenzen Sie optional die Anzahl von Datensätzen, die in einer bestimmten Anforderung zurückgegeben werden.
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable get-runtime-status

Gibt den Status der angegebenen Orchestrierungsinstanz zurück.

func durable get-runtime-status --id <INSTANCE_ID>

Die get-runtime-status-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--show-input Wenn festgelegt, enthält die Antwort die Eingabe der Funktion.
--show-output Wenn festgelegt, enthält die Antwort den Ausführungsverlauf.
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable purge-history

Bereinigt den Zustand der Orchestrierungsinstanz, den Verlauf und den Blobspeicher für Orchestrierungen, die älter als der angegebene Schwellenwert sind.

func durable purge-history

Die purge-history-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--created-after Löscht optional den Verlauf der nach diesem Datum bzw. dieser Uhrzeit (UTC) erstellten Instanzen. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--created-before Löscht optional den Verlauf der vor diesem Datum bzw. dieser Uhrzeit (UTC) erstellten Instanzen. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--runtime-status Löscht optional den Verlauf der Instanzen, deren Status mit einem bestimmten Status übereinstimmt, einschließlich completd, terminated, canceled und failed. Sie können ein oder mehrere durch Leerzeichen getrennte Status angeben. Wenn Sie --runtime-status nicht einschließen, wird der Instanzverlauf unabhängig vom Status gelöscht.
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable raise-event

Löst ein Ereignis für die angegebene Orchestrierungsinstanz aus.

func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>

Die raise-event-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--event-data Daten, die an das Ereignis übergeben werden sollen, entweder inline oder aus einer JSON-Datei (erforderlich). Bei Dateien stellen Sie dem Pfad zur Datei ein kaufmännisches Und (@) als Präfix voran, z. B. @path/to/file.json.
--event-name Der Name des auszulösenden Ereignisses (erforderlich).
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable rewind

Spult die angegebene Orchestrierungsinstanz zurück.

func durable rewind --id <INSTANCE_ID> --reason <REASON>

Die rewind-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--reason Der Grund für das Zurückspulen der Orchestrierungsinstanz (erforderlich).
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable start-new

Startet eine neue Instanz der angegebenen Orchestratorfunktion.

func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>

Die start-new-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--function-name Der Name der zu startenden Orchestratorfunktion (erforderlich).
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--input Eingabe für die Orchestratorfunktion, entweder inline oder aus einer JSON-Datei (erforderlich). Bei Dateien stellen Sie dem Pfad zur Datei ein kaufmännisches Und (@) als Präfix voran, z. B. @path/to/file.json.
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func durable terminate

Beendet die angegebene Orchestrierungsinstanz.

func durable terminate --id <INSTANCE_ID> --reason <REASON>

Die terminate-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--connection-string-setting Optionaler Name der Einstellung mit der zu verwendenden Speicherverbindungszeichenfolge.
--id Gibt die ID einer Orchestrierungsinstanz an (erforderlich).
--reason Der Grund für das Beenden der Orchestrierungsinstanz (erforderlich).
--task-hub-name Optionaler Name des zu verwendenden Durable Functions-Aufgabenhubs.

Weitere Informationen finden Sie in der Dokumentation zu Durable Functions.

func extensions install

Installiert die Functions-Erweiterungen manuell in einem Nicht-.NET-Projekt oder in einem C#-Skriptprojekt.

func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>

Die install-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--configPath Pfad des Verzeichnisses, das die Datei „extensions.csproj“ enthält.
--csx Unterstützt C#-Skriptprojekte (CSX-Dateien).
--force Aktualisiert die Versionen vorhandener Erweiterungen.
--output Ausgabepfad für die Erweiterungen.
--package Bezeichner für ein bestimmtes Erweiterungspaket. Wenn nicht angegeben, werden alle Erweiterungen, auf die verwiesen wird, wie bei func extensions sync installiert.
--source NuGet-Feedquelle, wenn nicht NuGet.org verwendet wird.
--version Version des Erweiterungspakets.

Im folgenden Beispiel wird die Version 5.0.1 der Event Hubs-Erweiterung im lokalen Projekt installiert:

func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1

Die folgenden Überlegungen gelten beim Verwenden von func extensions install:

  • Verwenden Sie für kompilierte C#-Projekte (sowohl prozessinterne als auch isolierte Workerprozesse) stattdessen standardmäßige NuGet-Paketinstallationsmethoden, z. B dotnet add package.

  • Um Erweiterungen mithilfe von Core Tools manuell zu installieren, muss das .NET 6.0-SDK installiert sein.

  • Wenn möglich, sollten Sie stattdessen Erweiterungspakete verwenden. Das folgende sind einige Gründe, aus denen Erweiterungen möglicherweise manuell installiert werden müssen:

    • Sie müssen auf eine bestimmte Version einer Erweiterung zugreifen, die nicht in einem Paket verfügbar ist.
    • Sie müssen auf eine benutzerdefinierte Erweiterung zugreifen, die nicht in einem Paket verfügbar ist.
    • Sie müssen auf eine bestimmte Kombination von Erweiterungen zugreifen, die nicht in einem einzelnen Paket verfügbar ist.

  • Bevor Sie Erweiterungen manuell installieren können, müssen Sie zuerst das extensionBundle-Objekt aus der Datei host.json entfernen, die das Paket definiert. Es erfolgt keine Aktion, wenn ein Erweiterungspaket in Ihrer Datei host.json bereits festgelegt ist.

  • Wenn Sie eine Erweiterung das erste Mal explizit installieren, wird die .NET-Projektdatei „extensions.csproj“ zum Stamm Ihres App-Projekts hinzugefügt. Diese Datei definiert die von Ihren Funktionen benötigten NuGet-Pakete. Sie können zwar mit den NuGet-Paketverweisen in dieser Datei arbeiten, mit Core Tools können Erweiterungen jedoch installiert werden, ohne diese C#-Projektdatei manuell bearbeiten zu müssen.

func extensions sync

Installiert alle Erweiterungen, die der Funktions-App hinzugefügt wurden.

Die sync-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--configPath Pfad des Verzeichnisses, das die Datei „extensions.csproj“ enthält.
--csx Unterstützt C#-Skriptprojekte (CSX-Dateien).
--output Ausgabepfad für die Erweiterungen.

Generiert eine fehlende Datei „extensions.csproj“ neu. Es erfolgt keine Aktion, wenn ein Erweiterungspaket in Ihrer Datei „host.json“ definiert ist.

func kubernetes deploy

Stellt ein Functions-Projekt als benutzerdefinierten Docker-Container in einem Kubernetes-Cluster bereit.

func kubernetes deploy

Dieser Befehl erstellt Ihr Projekt als benutzerdefinierten Container und veröffentlicht es in einem Kubernetes-Cluster. Benutzerdefinierte Container müssen ein Dockerfile enthalten. Um eine App mit einer Dockerfile-Datei zu erstellen, verwenden Sie die Option --dockerfile mit dem func init-Befehl.

Die folgenden Kubernetes-Bereitstellungsoptionen sind verfügbar:

Option BESCHREIBUNG
--dry-run Zeigt optional die Bereitstellungsvorlage ohne Ausführung an.
--config-map-name Optionaler Name einer vorhandenen Konfigurationszuordnung mit Funktions-App-Einstellungen, die bei der Bereitstellung verwendet werden sollen. Erfordert --use-config-map. Das Standardverhalten ist das Erstellen von Einstellungen auf der Grundlage des Values-Objekts in der Datei local.settings.json.
--cooldown-period Der Abkühlungszeitraum (in Sekunden), nach dem alle Trigger nicht mehr aktiv sind, bevor die Bereitstellung wieder auf 0 (null) herunterskaliert wird ( Standardwert: 300 s).
--ignore-errors Setzt die Bereitstellung fort, nachdem eine Ressource einen Fehler zurückgegeben hat. Das Standardverhalten ist, dass bei einem Fehler angehalten wird.
--image-name Der Name des Images, das für die Podbereitstellung verwendet werden soll und aus dem Funktionen gelesen werden.
--keda-version Legt die zu installierende KEDA-Version fest. Gültige Optionen sind v1 und v2 (Standard).
--keys-secret-name Der Name einer Kubernetes Secrets-Sammlung, die zum Speichern von Zugriffstasten verwendet werden soll.
--max-replicas Legt die maximale Anzahl von Replikaten fest, auf die HPA (Horizontal Pod Autoscaler) skaliert wird.
--min-replicas Legt die minimale Replikatanzahl fest, unter die HPA nicht skaliert wird.
--mount-funckeys-as-containervolume Stellt die Zugriffstasten als Containervolume fest.
--name Der Name, der für die Bereitstellung und andere Artefakte in Kubernetes verwendet wird.
--namespace Legt den Kubernetes-Namespace fest, indem die Bereitstellung erfolgen soll. Standardmäßig wird der Standardnamespace verwendet.
--no-docker Funktionen werden aus dem aktuellen Verzeichnis anstatt aus einem Image gelesen. Erfordert das Einbinden des Imagedateisystems.
--registry Wenn festgelegt, wird ein Docker-Build ausgeführt, und das Image wird in eine Registrierung mit diesem Namen gepusht. Sie können --registry nicht mit --image-name verwenden. Verwenden Sie für Docker Ihren Benutzernamen.
--polling-interval Das Abrufintervall (in Sekunden) zum Überprüfen von Nicht-HTTP-Triggern mit einem Standardwert von 30 Sekunden.
--pull-secret Das Geheimnis, das für den Zugriff auf private Registrierungsanmeldeinformationen verwendet wird.
--secret-name Der Name einer vorhandenen Kubernetes-Geheimnissammlung, die Funktions-App-Einstellungen enthält, die in der Bereitstellung verwendet werden sollen. Das Standardverhalten ist das Erstellen von Einstellungen auf der Grundlage des Values-Objekts in der Datei local.settings.json.
--show-service-fqdn Zeigt die URLs von HTTP-Triggern mit dem Kubernetes-FQDN anstelle des Standardverhaltens der Verwendung einer IP-Adresse an.
--service-type Legt den Typ von Kubernetes Service fest. Unterstützte Werte sind ClusterIP, NodePort und LoadBalancer (Standardwert).
--use-config-map Verwenden Sie ein ConfigMap-Objekt (v1) anstelle eines Secret-Objekts (v1), um die Funktions-App-Einstellungen zu konfigurieren. Der Zuordnungsname wird mithilfe von --config-map-name festgelegt.

Die Core Tools verwenden die lokale Docker-Befehlszeilenschnittstelle, um das Image zu erstellen und zu veröffentlichen. Stellen Sie sicher, dass Docker bereits lokal installiert ist. Führen Sie den Befehl docker login aus, um eine Verbindung mit Ihrem Konto herzustellen.

Azure Functions unterstützt das Hosten Ihrer containerisierten Funktionen entweder in Azure-Container-Apps oder in Azure-Funktionen. Das direkte Ausführen Ihrer Container in einem Kubernetes-Cluster oder in Azure Kubernetes Service (AKS) wird von Azure Functions nicht offiziell unterstützt. Weitere Informationen finden Sie unter Linux-Containerunterstützung in Azure Functions.

func kubernetes install

Installiert KEDA in einem Kubernetes-Cluster.

func kubernetes install

Installiert KEDA in dem Cluster, der in der kubectl-Konfigurationsdatei definiert ist.

Die install-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--dry-run Zeigt die Bereitstellungsvorlage ohne Ausführung an.
--keda-version Legt die zu installierende KEDA-Version fest. Gültige Optionen sind v1 und v2 (Standard).
--namespace Unterstützt die Installation in einem bestimmten Kubernetes-Namespace. Wenn nicht festgelegt, wird der Standardnamespace verwendet.

Weitere Informationen finden Sie unter Verwalten von KEDA und Funktionen in Kubernetes.

func kubernetes remove

Entfernt KEDA aus dem Kubernetes-Cluster, der in der kubectl-Konfigurationsdatei definiert ist.

func kubernetes remove

Entfernt KEDA aus dem Cluster, der in der kubectl-Konfigurationsdatei definiert ist.

Die remove-Aktion unterstützt die folgenden Optionen:

Option BESCHREIBUNG
--namespace Unterstützt die Deinstallation aus einem bestimmten Kubernetes-Namespace. Wenn nicht festgelegt, wird der Standardnamespace verwendet.

Weitere Informationen finden Sie unter Deinstallieren von KEDA aus Kubernetes.

func settings add

Fügt der Sammlung Values in der Datei local.settings.json eine neue Einstellung hinzu.

func settings add <SETTING_NAME> <VALUE>

Ersetzen Sie <SETTING_NAME> durch den Namen der App-Einstellung und <VALUE> durch den Wert der Einstellung.

Die add-Aktion unterstützt die folgende Option:

Option BESCHREIBUNG
--connectionString Fügt das Name-Wert-Paar der ConnectionStrings-Sammlung anstatt der Values-Sammlung hinzu. Verwenden Sie die ConnectionStrings-Sammlung nur, wenn bestimmte Frameworks dies erfordern. Weitere Informationen finden Sie unter Datei local.settings.json.

func settings decrypt

Entschlüsselt zuvor verschlüsselte Werte in der Values-Sammlung in der Datei local.settings.json.

func settings decrypt

Verbindungszeichenfolgenwerte in der ConnectionStrings-Sammlung werden ebenfalls entschlüsselt. In „local.settings.json“ ist IsEncrypted ebenfalls auf false festgelegt. Verschlüsseln Sie lokale Einstellungen, um die Gefahr des Verlusts von wertvollen Informationen aus „local.settings.json“ zu verringern. In Azure werden Anwendungseinstellungen immer verschlüsselt gespeichert.

func settings delete

Entfernt eine vorhandene Einstellung aus der Values-Sammlung in der Datei local.settings.json.

func settings delete <SETTING_NAME>

Ersetzen Sie <SETTING_NAME> durch den Namen der App-Einstellung und <VALUE> durch den Wert der Einstellung.

Die delete-Aktion unterstützt die folgende Option:

Option BESCHREIBUNG
--connectionString Entfernt das Name-Wert-Paar aus der ConnectionStrings-Sammlung anstatt aus der Values-Sammlung.

func settings encrypt

Verschlüsselt die Werte einzelner Elemente in der Values-Sammlung in der Datei local.settings.json.

func settings encrypt

Verbindungszeichenfolgenwerte in der ConnectionStrings-Sammlung werden ebenfalls verschlüsselt. In dieser Datei „local.settings.json“ wird außerdem IsEncrypted auf true festgelegt. Damit wird angegeben, dass die lokale Runtime Einstellungen entschlüsselt, bevor sie verwendet werden. Verschlüsseln Sie lokale Einstellungen, um die Gefahr des Verlusts von wertvollen Informationen aus „local.settings.json“ zu verringern. In Azure werden Anwendungseinstellungen immer verschlüsselt gespeichert.

func settings list

Gibt eine Liste mit Einstellungen in der Values-Sammlung in der Datei local.settings.json aus.

func settings list

Verbindungszeichenfolgen aus der ConnectionStrings-Sammlung werden ebenfalls ausgegeben. Standardmäßig werden Werte aus Sicherheitsgründen maskiert. Sie können die Option --showValue verwenden, um den tatsächlichen Wert anzuzeigen.

Die list-Aktion unterstützt die folgende Option:

Option BESCHREIBUNG
--showValue Zeigt die tatsächlichen nicht maskierten Werte in der Ausgabe an.

func templates list

Listet die verfügbaren Funktionsvorlagen (Trigger) auf.

Die list-Aktion unterstützt die folgende Option:

Option BESCHREIBUNG
--language Die Sprache, nach der zurückgegebene Vorlagen gefiltert werden sollen. Standardmäßig werden alle Sprachen zurückgeben.