Freigeben über

Referenz zu Azure Functions Core Tools

Dieser Artikel enthält Referenzdokumentation für die Azure Functions Core Tools, mit der Sie Azure Functions Projekte auf Ihrem lokalen Computer entwickeln, verwalten und bereitstellen können. Weitere Informationen zur Verwendung von Core Tools finden Sie unter Work with 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 zum Erstellen und Ausführen von Funktionen auf dem lokalen Computer.
func azure Befehle zum Arbeiten mit Azure Ressourcen, einschließlich der Veröffentlichung.
func azurecontainerapps Befehle zum Bereitstellen einer containerisierten Funktions-App zum Azure Container Apps.
func bundles Befehle zum Verwalten von Erweiterungspaketen.
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 Funktionenhost.
func templates Befehle zum Auflisten verfügbarer Funktionsvorlagen.

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

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.

Der func init Befehl unterstützt diese Optionen, die in Version 1.x nicht unterstützt werden, sofern nicht anders angegeben:

Auswahlmöglichkeit BESCHREIBUNG
--bundles-channel, -c Veröffentlichungskanal des Erweiterungspakets. Unterstützte Werte sind: GA (Standard), Previewund Experimental. Gilt nur für Nicht-.NET Projekte.
--configuration-profile Initialisiert ein Projekt mit einem Hostkonfigurationsprofil. Die --configuration-profile Option befindet sich derzeit in der Vorschau. Weitere Informationen finden Sie unter Konfigurationsprofile.
--csx Erstellt .NET Funktionen als C#-Skript, bei dem es sich um das Verhalten der Version 1.x handelt. Nur mit --worker-runtime dotnet gültig.
--docker Erstellt eine Dockerfile-Datei für einen Container mithilfe eines Basisimages basierend auf der ausgewählten --worker-runtime. 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 auf, wenn sie in local.settings.jsonnicht angegeben oder festgelegt ist. 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, -l Initialisiert ein sprachspezifisches Projekt. Wird derzeit unterstützt, wenn --worker-runtime sie auf node. 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-Workerlaufzeit dieses Feature.
--model, -m Legt das Programmiermodell für eine Zielsprache fest, wenn mehrere Modelle verfügbar sind. Unterstützte Optionen sind V1 und V2 für Python, und V3 und V4 für Node.js. Weitere Informationen finden Sie im Entwicklerhandbuch Python und im Node.js Entwicklerhandbuch.
--no-bundle Konfigurieren Sie das Erweiterungspaket nicht in host.json. Gilt nur für Nicht-.NET Projekte.
--no-docs Überspringt das Generieren der Dokumentationsdateien "Erste Schritte". Gilt für Python Projekte.
--skip-npm-install Überspringen Sie die Ausführung npm install nach der Projekterstellung. Gilt für Node.js Projekte.
--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, pythonund typescript. Verwenden Sie für Java Maven. 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: net10.0 (Vorschau), net9.0, net8.0 (Standard), net6.0 und net48 (.NET Framework 4.8).

Hinweis

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

Konfigurationsprofile

Wichtig

Die Unterstützung für Konfigurationsprofile befindet sich derzeit in der Vorschau.

Wenn Sie die --configuration-profile Option verwenden, wird ein vordefinierter Satz von Projektkonfigurationen und -einstellungen erstellt. Wenn Sie ein Konfigurationsprofil angeben, überspringt die Initialisierung möglicherweise alle anderen Initialisierungsschritte.

Profilwert BESCHREIBUNG Bestimmte Aktionen
mcp-custom-handler Erstellt ein Projekt, das benutzerdefinierte Handler verwendet, um einen MCP-Server (Model Context Protocol) zu hosten, mit dem KI-Agents und andere MCP-Clients eine Verbindung herstellen können. • Konfiguriert das "configurationProfile": "mcp-custom-handler" Element in der host.json Datei mit bestimmten benutzerdefinierten Handlereinstellungen.
• Legt in MCP_EXTENSION_ENABLEDlocal.settings.jsonfesttrue.

func logs

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

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

Der func logs Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--platform Hostingplattform für die Funktions-App Gültige Optionen: kubernetes.
--name Funktions-App-Name in Azure.

Weitere Informationen finden Sie unter Azure Functions auf 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. In Version 1.x müssen Sie auch die Sprache auswählen.

Der func new Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--authlevel, -a Legt die Autorisierungsstufe für einen HTTP-Trigger fest. 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.
--file, -f Die Zieldatei für die neue Funktion. Gibt für Python v2-Projekte die Datei an, der die Funktion hinzugefügt werden soll (Standardwert ist function_app.py). Gibt für Node.js v4-Projekte den Namen der Ausgabedatei im src/functions Ordner an. Gilt nicht für kompilierte .NET Projekte.
--language, -l Die Programmiersprache der Vorlage, z. B. C# oder JavaScript. Diese Option ist in Version 1.x erforderlich. Verwenden Sie in Version 2.x und höheren Versionen diese Option nicht, da die Sprache von der Arbeitslaufzeit 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 pack

Erstellt ein Bereitstellungspaket, das Den Projektcode in einem runnablen Zustand enthält. Verwenden Sie diese Methode, wenn Sie ein Bereitstellungspaket für Ihre App auf Ihrem lokalen Computer außerhalb des func azure functionapp publish Befehls manuell erstellen müssen. Erstellt ihr Projekt standardmäßig func pack bei Bedarf.

func pack [<FOLDER_PATH>]

Paketiert standardmäßig func pack das aktuelle Verzeichnis, und die Ausgabe .zip Datei hat denselben Namen wie der Stammordner Ihres Projekts. Führen Sie func pack das Verzeichnis aus, das Ihre host.json Projektdatei enthält. Wenn Sie in einem anderen Verzeichnis ausgeführt func pack werden müssen, legen Sie <FOLDER_PATH> den Pfad zum Projektstamm fest, z func pack ./myprojectroot. B. . Wenn die spezifische .zip Datei bereits vorhanden ist, wird sie zuerst gelöscht und dann durch eine aktualisierte Version ersetzt.

Der func pack Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--output, -o Legt den Pfad zum Speicherort fest, an dem die Bereitstellung .zip Paketdatei erstellt wird.
--no-build Project wird nicht vor dem Packen erstellt. Verwenden Sie für C#-Apps nur dann, wenn Sie ihre Binärdateien bereits generiert haben. Bei Node.js Apps werden beide npm install übersprungen und npm run build übersprungen.
--skip-install Wird beim Packen Node.js-basierten Funktions-App übersprungen npm install . Wird verwendet, um zu vermeiden, benutzerdefinierte npm-Module zu überschreiben.
--build-native-deps Installiert Python Abhängigkeiten lokal mithilfe eines Images, das der in Azure verwendeten Umgebung entspricht. Wenn diese Option aktiviert ist, startet Core Tools einen Docker-Container, erstellt die App innerhalb dieses Containers und erstellt eine .zip Datei, in .python_packagesder alle Abhängigkeiten wiederhergestellt wurden. Verwenden Sie diese Option, wenn sie auf Windows ausgeführt wird, um potenzielle Bibliotheksprobleme zu vermeiden, wenn Sie in Azure auf Linux bereitstellen.

func run

Nur Version 1.x.

Ermöglicht das direkte Aufrufen einer Funktion, die dem Ausführen einer Funktion mithilfe der Registerkarte Test im Azure Portal ähnelt. 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

Der func run Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit 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 beispielsweise eine HTTP-ausgelöste Funktion aufzurufen und den Inhaltstext zu übergeben, führen Sie den 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

Der func start Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit 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 Ermöglicht ursprungsübergreifende authentifizierte Anforderungen, die Cookies und den Authentifizierungsheader verwenden.
--dotnet-isolated-debug Wenn dieser Wert auf true festgelegt ist, wird der .NET Arbeitsprozess angehalten, bis ein Debugger aus dem .NET isolierten Projekts angefügt wird, das gedebuggt wird.
--enable-json-output Gibt Konsolenprotokolle nach Möglichkeit als JSON aus.
--enableAuth Aktiviert die vollständige Pipeline für die Authentifizierungsverarbeitung mit Autorisierungsanforderungen.
--functions Eine durch Leerzeichen getrennte Liste der zu ladenden Funktionen.
--json-output-file Wenn angegeben, ein Pfad zu der Datei, der zum Schreiben der Ausgabe bei Verwendung --enable-json-outputverwendet wird.
--language-worker Argumente zum Konfigurieren des Spracharbeitsthreads. Sie können z. B. das Debuggen für Sprachmitarbeiter aktivieren, indem Sie Debug-Port und andere erforderliche Argumente bereitstellen.
--no-build Das aktuelle Projekt wird vor der Ausführung nicht erstellt. Nur für .NET Klassenprojekte. Der Standardwert ist false.
--password Entweder das Kennwort oder eine Datei, die das Kennwort für eine PFX-Datei enthält. Nur mit --cert verwendet.
--port, -p Der lokale Port, auf dem gelauscht werden soll. Standardwert: 7071.
--runtime Legt fest, welche Version des Hosts gestartet werden soll. Zulässige Werte sind: inproc6, inproc8, und default (wodurch der Out-of-Process-Host ausgeführt wird).
--timeout, -t 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.
--user-log-level Legt die minimale Protokollebene für Benutzerprotokolle fest. Gültige Werte sind: Trace, , Debug, Information, Warning, Error, , Criticalund None. Diese Einstellung wirkt sich nicht auf Systemprotokolle aus. Legen Sie für .NET isolierte Projekte auch die Mindeststufe in Program.cs fest, indem Sie builder.Logging.SetMinimumLevel(LogLevel.Debug) verwenden, damit diese Option wirksam wird.

Überprüfen Sie beim Ausführen des Projekts einzelne Funktionsendpunkte.

func azure functionapp

Der func azure functionapp Kontext enthält die folgenden Befehle:

Alle func azure functionapp Befehle unterstützen diese Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--slot Zielt auf einen bestimmten benannten Bereitstellungsplatz ab, falls konfiguriert.
--access-token Stellt ein Zugriffstoken bereit, das nicht das Standardtoken ist, um authentifizierte Aktionen in Azure auszuführen.
--access-token-stdin Liest ein bestimmtes Zugriffstoken aus der Standardeingabe. Verwenden Sie diese Option, wenn Sie das Token direkt aus einem vorherigen Befehl lesen, z az account get-access-token. B. .
--management-url Legt die Verwaltungs-URL für die Azure Cloud fest, die standardmäßig auf https://management.azure.com festgelegt ist. Verwenden Sie diese Option, wenn Ihre Funktions-App in einer souveränen Cloud ausgeführt wird.
--subscription Legt das Standardabonnement Azure fest.

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 local.settings.json Datei 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

Listet die Funktionen in der angegebenen Funktions-App auf.

func azure functionapp list-functions <APP_NAME>

Der func azure functionapp list-functions Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--show-keys Schließen Sie Zugriffstastenwerte auf Funktionsebene in die zurückgegebenen Funktionsendpunkt-URLs ein.

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. Ändern Sie das Timeout, indem Sie eine App-Einstellung namens SCM_LOGSTREAM_TIMEOUT mit einem Timeoutwert in Sekunden hinzufügen. Für Linux in einem Flex-Verbrauch - oder Verbrauchsplan noch nicht unterstützt. Verwenden Sie für diese Apps die Option --browser, um Protokolle im Portal anzuzeigen.

Der func azure functionapp logstream Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--browser Öffnen Sie Azure-Anwendung Insights Live Stream für die Funktions-App im Standardbrowser.

Weitere Informationen finden Sie unter Enable Streaming-Ausführungsprotokolle in Azure Functions.

func azure functionapp publish

Stellt ein Functions-Projekt in einer vorhandenen 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:

Auswahlmöglichkeit BESCHREIBUNG
--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 aus. Akzeptiert: remote und local.
--build-native-deps Überspringt das Generieren des Ordners .wheels, wenn Sie Python Funktions-Apps veröffentlichen.
--csx Veröffentlicht ein C#-Skriptprojekt (.csx).
--dotnet-cli-params Wenn Sie kompilierte C#-Funktionen (CSPROJ) veröffentlichen, rufen die Kerntools auf dotnet build --output bin/publish. Alle parameter, die an diese Option übergeben werden, werden an die Befehlszeile angefügt.
--dotnet-version Gibt für dotnet-isolated-Anwendungen die Zielversion .NET an (z. B. 8.0).
--force Ignoriert die Überprüfung vor der Veröffentlichung in bestimmten Szenarien.
--list-ignored-files Zeigt eine Liste von Dateien an, die während der Veröffentlichung ignoriert werden, basierend auf der FUNCIGNORE-Datei .
--list-included-files Zeigt eine Liste der veröffentlichten Dateien an, die auf der FUNCIGNORE-Datei basieren.
--no-build Project wird während der Veröffentlichung nicht erstellt. Für Python wird pip install nicht ausgeführt.
--nozip Deaktiviert den Standardmodus Run-From-Package. Extrahiert Dateien in den Ordner auf dem wwwroot Server, anstatt sie direkt aus dem Bereitstellungspaket auszuführen.
--overwrite-settings, -y Unterdrückt die Eingabeaufforderung zum Überschreiben von App-Einstellungen bei Verwendung --publish-local-settings -i.
--publish-local-settings, -i Veröffentlicht Einstellungen in local.settings.json, um Azure, und fordert sie auf, zu überschreiben, wenn die Einstellung bereits vorhanden ist. 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 Einstellungen und überspringt den Inhalt. Standard ist die Eingabeaufforderung.
--show-keys Fügt den URLs, die in den Protokollen angezeigt werden, Funktionstasten hinzu.

func azure storage fetch-connection-string

Ruft die Verbindungszeichenfolge für das angegebene Azure Storage Konto ab.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Weitere Informationen finden Sie unter Download a storage Verbindungszeichenfolge.

func azurecontainerapps deploy

Stellt eine containerisierte Funktions-App in einer Azure Container Apps Umgebung bereit. Das von der Funktions-App und der Umgebung verwendete Speicherkonto muss 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:

Auswahlmöglichkeit BESCHREIBUNG
--environment Der Name einer vorhandenen Container Apps-Umgebung.
--image-build Legen Sie fest, true dass der lokale Docker-Build übersprungen werden soll.
--image-name Der Name eines vorhandenen Containerimages in einer Containerregistrierung, einschließlich des Tagnamens.
--location Region für die Bereitstellung. Im Idealfall ist diese Region mit den Ressourcen für Umgebung und Speicherkonto identisch.
--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 angezeigt. Der Name muss in der Umgebung eindeutig sein.
--registry Bei Festlegung wird ein Docker-Build ausgeführt, und das Image wird an den Registrierungssatz --registryin pushed. 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.
--worker-runtime Legt die Laufzeitsprache der Funktions-App fest. Dieser Parameter wird nur mit --image-name und --image-build; andernfalls wird die Sprache während des lokalen Builds bestimmt. Unterstützte Werte sind: dotnet, , dotnetIsolated, node, python, powershellund custom (für benutzerdefinierte Handler).

Wichtig

Speicherverbindungszeichenfolgen und andere Dienstanmeldeinformationen sind wichtige Geheimnisse. Speichern Sie alle Skriptdateien, die diese verwenden func azurecontainerapps deploy , und speichern Sie sie nicht in einer öffentlich zugänglichen Quellcodeverwaltung.

func deploy

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

func bundles add

Fügt der host.json Datei die Konfiguration des Erweiterungsbundle-Bündels hinzu.

func bundles add

Der func bundles add Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--force, -f Überschreibt die vorhandene Konfiguration des Erweiterungspakets, falls vorhanden.
--channel, -c Veröffentlichungskanal des Erweiterungspakets. Unterstützte Werte sind: GA (Standard), Previewund Experimental.

func bundles download

Lädt das Erweiterungspaket herunter, das in host.jsonkonfiguriert ist.

func bundles download

Der func bundles download Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--force, -f Erzwingt einen erneuten Download des Erweiterungspakets, auch wenn es bereits vorhanden ist.

func bundles list

Listet heruntergeladene Erweiterungspakete auf.

func bundles list

func bundles path

Ruft den Pfad zum heruntergeladenen Erweiterungsbundle ab.

func bundles path

func durable delete-task-hub

Löscht alle Speicherartefakte im Durable Functions Aufgabenhub.

func durable delete-task-hub

Der func durable delete-task-hub Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Der Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--task-hub-name Name des zu verwendenden Dauerhaften Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable get-history

Gibt den Verlauf einer angegebenen Orchestrierungsinstanz zurück.

func durable get-history --id <INSTANCE_ID>

Der func durable get-history Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--id ID einer Orchestrierungsinstanz. (Erforderlich)
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge.
--task-hub-name Name des zu verwendenden Dauerhaften Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable get-instances

Gibt den Status aller Orchestrierungsinstanzen zurück. Dieser Befehl unterstützt das Paging mit dem top Parameter.

func durable get-instances

Der func durable get-instances Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--continuation-token Token, das eine bestimmte Seite oder einen bestimmten Abschnitt der zurückzugebenden Anforderungen angibt.
--connection-string-setting Name der Zu verwendenden App-Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--created-after Rufen Sie die Instanzen ab, die nach diesem Datum und dieser Uhrzeit (UTC) erstellt wurden. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--created-before Rufen Sie die Instanzen ab, die vor einem bestimmten Datum und einer bestimmten Uhrzeit (UTC) erstellt wurden. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--runtime-status Rufen Sie die Instanzen ab, deren Status einem bestimmten Status entspricht, einschließlich running, completedund failed. Sie können einen oder mehrere durch Leerzeichen getrennte Status bereitstellen.
--top Beschränken Sie die Anzahl der in einer bestimmten Anforderung zurückgegebenen Datensätze.
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable get-runtime-status

Gibt den Status einer angegebenen Orchestrierungsinstanz zurück.

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

Der func durable get-runtime-status Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--id ID einer Orchestrierungsinstanz. (Erforderlich)
--show-input Bei Festlegung enthält die Antwort die Eingabe der Funktion.
--show-output Bei Festlegung enthält die Antwort den Ausführungsverlauf.
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable purge-history

Löscht den Instanzstatus, den Verlauf und den BLOB-Speicher für Orchestrierungen, die älter als der angegebene Schwellenwert sind.

func durable purge-history

Der func durable purge-history Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--created-after Löschen Sie den Verlauf der Instanzen, die nach diesem Datum/dieser Uhrzeit (UTC) erstellt wurden. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--created-before Löschen Sie den Verlauf der Instanzen, die vor diesem Datum/dieser Uhrzeit (UTC) erstellt wurden. Alle nach ISO 8601 formatierten datetime-Werte werden akzeptiert.
--runtime-status Löschen Des Verlaufs von Instanzen, deren Status einem bestimmten Status entspricht, einschließlich completed, , terminated, canceledund failed. Stellen Sie einen oder mehrere durch Leerzeichen getrennte Status bereit. Wenn Sie --runtime-status nicht einschließen, wird der Instanzverlauf unabhängig vom Status gelöscht.
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation 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>

Der func durable raise-event Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--event-data Daten, die an das Ereignis übergeben werden, entweder inline oder aus einer JSON-Datei. Präfix für Dateien, präfixen Sie den Pfad zur Datei mit einem At-Zeichen (@), z @path/to/file.json. B. . (Erforderlich)
--event-name Der Name des ereignisses, das ausgelöst werden soll. (Erforderlich)
--id ID einer Orchestrierungsinstanz. (Erforderlich)
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable rewind

Spult die angegebene Orchestrierungsinstanz zurück.

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

Der func durable rewind Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--id ID einer Orchestrierungsinstanz. (Erforderlich)
--reason Grund für das Zurückspulen der Orchestrierung. (Erforderlich)
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation 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>

Der func durable start-new Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--function-name Name der orchestrator-Funktion, die gestartet werden soll. (Erforderlich)
--id Gibt die ID einer Orchestrierungsinstanz an. (Erforderlich)
--input Eingaben an die Orchestratorfunktion, entweder inline oder aus einer JSON-Datei. Präfix für Dateien, präfixen Sie den Pfad zu der Datei mit einem kaufmännischen Und-Zeichen (@), z. B @path/to/file.json. . (Erforderlich)
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func durable terminate

Beendet die angegebene Orchestrierungsinstanz.

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

Der func durable terminate Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--connection-string-setting Name der Einstellung, die den zu verwendenden Speicher Verbindungszeichenfolge enthält.
--id Gibt die ID einer Orchestrierungsinstanz an. (Erforderlich)
--reason Grund für das Beenden der Orchestrierung. (Erforderlich)
--task-hub-name Name des zu verwendenden Durable Functions Aufgabenhubs.

Weitere Informationen finden Sie in der dokumentation Durable Functions.

func extensions install

Installiert Funktionenerweiterungen manuell in einem Nicht-.NET-Projekt oder einem C#-Skriptprojekt.

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

Der func extensions install Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--configPath, -c Pfad des Verzeichnisses, das die Datei "extensions.csproj" enthält.
--csx Unterstützen Sie C#-Skriptingprojekte (CSX).
--force, -f Aktualisiert die Versionen vorhandener Erweiterungen.
--output, -o Ausgabepfad für die Erweiterungen.
--package, -p Bezeichner für ein bestimmtes Erweiterungspaket. Wenn nicht angegeben, werden alle Erweiterungen, auf die verwiesen wird, wie bei func extensions sync installiert.
--source, -s NuGet-Feedquelle, wenn nicht NuGet.org verwendet wird.
--version, -v 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

Diese Überlegungen gelten bei der Verwendung von func extensions install:

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

  • Um Erweiterungen mithilfe von Core Tools manuell zu installieren, müssen Sie das .NET SDK installiert haben.

  • Wenn möglich, sollten Sie stattdessen Erweiterungspakete verwenden. Hier sind einige Gründe, warum Sie Erweiterungen möglicherweise manuell installieren 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 host.json-Datei entfernen, die das Bundle definiert. Es wird keine Aktion ausgeführt, wenn ein Erweiterungspaket bereits in Ihrer host.json Datei festgelegt ist.

  • Wenn Sie eine Erweiterung zum ersten Mal explizit installieren, wird eine .NET Projektdatei mit dem Namen extensions.csproj zum Stammverzeichnis Des 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.

Der func extensions sync Befehl unterstützt die folgenden Optionen:

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

Generiert eine fehlende Datei „extensions.csproj“ neu. Führt keine Aktion aus, wenn ein Erweiterungspaket in ihrer host.json Datei 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.

Der func kubernetes deploy Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--dry-run Zeigt die Bereitstellungsvorlage ohne Ausführung an.
--config-map-name Name einer vorhandenen Konfigurationszuordnung mit Funktions-App-Einstellungen , die in der Bereitstellung verwendet werden sollen. Erfordert --use-config-map. Das Standardverhalten besteht darin, Einstellungen basierend auf dem Values Objekt in der local.settings.json Datei zu erstellen.
--cooldown-period Der Cooldownzeitraum (in Sekunden), nachdem alle Trigger nicht mehr aktiv sind, bevor die Bereitstellung auf Null skaliert wird, mit einem Standardwert von 300 s.
--ignore-errors Setzen Sie 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 Legen Sie die zu installierende Version von KEDA 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 Legen Sie die maximale Replikatanzahl fest, auf die der horizontale Pod Autoscaler (HPA) skaliert wird.
--min-replicas Legen Sie die minimale Replikatanzahl fest, unter der HPA nicht skaliert wird.
--mount-funckeys-as-containervolume Stellen Sie die Zugriffstasten als Containervolume fest.
--name Der Name, der für die Bereitstellung und andere Artefakte in Kubernetes verwendet wird.
--namespace Legen Sie den Kubernetes-Namespace fest, für den sie bereitgestellt werden soll. Standardmäßig wird der Standardnamespace verwendet.
--no-docker Lesen von Funktionen aus dem aktuellen Verzeichnis anstelle eines Bilds. Erfordert das Einbinden des Imagedateisystems.
--registry Bei Festlegung wird ein Docker-Build ausgeführt, und das Image wird an eine Registrierung dieses Namens übertragen. 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 Secrets-Auflistung mit Funktions-App-Einstellungen , die in der Bereitstellung verwendet werden sollen. Das Standardverhalten besteht darin, Einstellungen basierend auf dem Values Objekt in der local.settings.json Datei zu erstellen.
--show-service-fqdn Zeigen Sie die URLs von HTTP-Triggern mit dem Kubernetes-FQDN anstelle des Standardverhaltens der Verwendung einer IP-Adresse an.
--service-type Legen Sie den Typ des Kubernetes-Diensts 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.
--use-git-hash-version Verwenden Sie den Git-Hash als Version für das Containerimage.
--write-configs Geben Sie die Kubernetes-Konfigurationen als YAML-Dateien aus, anstatt sie bereitzustellen.
--config-file Ausgabedateipfad bei Verwendung von --write-configs. Standard: functions.yaml.
--hash-files Dateien zum Hashen, um die Bildversion zu bestimmen.
--image-build Bei Festlegung auf false" überspringt der Docker-Build.
--key-secret-annotations Anmerkungen, die dem Schlüsselschlüssel im key1=val1,key2=val2 Format hinzugefügt werden sollen.

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 Functions. Azure Functions unterstützt die Ausführung Ihrer Container nicht offiziell direkt in einem Kubernetes-Cluster oder in Azure Kubernetes Service (AKS). Weitere Informationen finden Sie unter Linux-Containerunterstützung in Azure Functions.

func kubernetes delete

Löscht eine Funktionenbereitstellung aus einem Kubernetes-Cluster.

func kubernetes delete --name <APP_NAME>

Der func kubernetes delete Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit BESCHREIBUNG
--name Der Name für die Bereitstellung und andere Artefakte in Kubernetes. (Erforderlich)
--namespace Legen Sie den Kubernetes-Namespace fest. Standardmäßig wird der default Namespace verwendet.
--registry Der Name der Containerregistrierung.
--image-name Das Image, das für die Podbereitstellung verwendet werden soll.
--keda-version Legen Sie die Version von KEDA fest. Gültige Optionen sind v1 und v2 (Standard).

func kubernetes install

Installiert KEDA in einem Kubernetes-Cluster

func kubernetes install

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

Der func kubernetes install Befehl unterstützt die folgenden Optionen:

Auswahlmöglichkeit 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 Installiert einen 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 in der kubectl Konfigurationsdatei definierten Cluster.

Der func kubernetes remove Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--namespace Deinstalliert aus einem bestimmten Kubernetes-Namespace. Wenn nicht festgelegt, wird der Standardnamespace verwendet.

Weitere Informationen finden Sie unter Deinstallieren von KEDA von 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 den <SETTING_NAME> Namen der App-Einstellung.

Der func settings add Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--connectionString Fügt das Name-Wert-Paar der ConnectionStrings-Sammlung anstatt der Values-Sammlung hinzu. Verwenden Sie die ConnectionStrings Auflistung nur, wenn bestimmte Frameworks sie benötigen. Weitere Informationen finden Sie unter local.settings.json Datei.

func settings decrypt

Entschlüsselt verschlüsselte Werte in der Auflistung in der Values dateilocal.settings.json .

func settings decrypt

Mit diesem Befehl werden auch Verbindungszeichenfolge Werte in der ConnectionStringsauflistung 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.

Der func settings delete Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--connectionString Entfernt das Name-Wert-Paar aus der ConnectionStrings Auflistung anstelle der Values Auflistung.

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

Die Ausgabe enthält auch Verbindungszeichenfolgen aus der ConnectionStrings Auflistung. Standardmäßig werden Werte aus Sicherheitsgründen maskiert. Sie können die Option --showValue verwenden, um den tatsächlichen Wert anzuzeigen.

Der func settings list Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--showValue, -a Zeigen Sie die tatsächlichen nicht maskierten Werte in der Ausgabe an.

func templates list

Listet die verfügbaren Funktionsvorlagen (Trigger) auf.

Der func templates list Befehl unterstützt diese Option:

Auswahlmöglichkeit BESCHREIBUNG
--language, -l Die Sprache, nach der zurückgegebene Vorlagen gefiltert werden sollen. Gibt standardmäßig alle Sprachen zurück.

Globale Optionen

Diese Optionen sind für die meisten Core Tools-Befehle verfügbar:

Auswahlmöglichkeit BESCHREIBUNG
--script-root Legt das Stammverzeichnis der Funktions-App fest und ändert das Arbeitsverzeichnis für den Befehl.
--verbose Aktiviert ausführliche Ausgabe für die detaillierte Protokollierung. Nicht von allen Befehlen unterstützt.
--offline Wird im Offlinemodus ausgeführt, ohne externe Netzwerkanrufe zu tätigen. Unterstützt von func start, func initund func new. Kann auch über die FUNCTIONS_CORE_TOOLS_OFFLINE Umgebungsvariable festgelegt werden.
--version, -v Zeigt die Version von Azure Functions Core Tools an.
--help, -h Zeigt Hilfeinformationen an.
--pause-on-error Hält für zusätzliche Eingaben an, bevor der Prozess beendet wird. Hilfreich beim Starten von Core Tools aus einer integrierten Entwicklungsumgebung (IDE).
  • Last updated on