Referenční informace k nástrojům Azure Functions Core Tools

Tento článek obsahuje referenční dokumentaci ke Azure Functions Core Tools, která umožňuje vyvíjet, spravovat a nasazovat projekty Azure Functions z místního počítače. Další informace o používání nástrojů Core Tools najdete v tématu Work with Azure Functions Core Tools.

Příkazy Core Tools jsou uspořádány do následujících kontextů, z nichž každá poskytuje jedinečnou sadu akcí.

Kontext příkazu	Popis
`func`	Příkazy pro vytváření a spouštění funkcí na místním počítači
`func azure`	Příkazy pro práci s Azure prostředky, včetně publikování.
`func azurecontainerapps`	Příkazy pro nasazení kontejnerizované aplikace funkcí do Azure Container Apps
`func bundles`	Příkazy pro správu sad rozšíření
`func durable`	Příkazy pro práci s Durable Functions
`func extensions`	Příkazy pro instalaci a správu rozšíření
`func kubernetes`	Příkazy pro práci s Kubernetes a Azure Functions
`func settings`	Příkazy pro správu nastavení prostředí pro místního hostitele Functions
`func templates`	Příkazy pro výpis dostupných šablon funkcí

Před použitím příkazů v tomto článku nainstalujte nástroje Core Tools.

`func init`

Vytvoří nový projekt Functions v určitém jazyce.

func init [<PROJECT_FOLDER>]

Po zadání <PROJECT_FOLDER>se projekt vytvoří v nové složce s tímto názvem. V opačném případě se použije aktuální složka.

Příkaz func init podporuje tyto možnosti, které nejsou podporované ve verzi 1.x, pokud není uvedeno jinak:

Možnost	Popis
`--bundles-channel`, `-c`	Kanál verze sady rozšíření Podporované hodnoty jsou: `GA` (výchozí) `Preview`a `Experimental`. Platí pouze pro projekty, které nejsou .NET.
`--configuration-profile`	Inicializuje projekt s konfiguračním profilem hostitele. Možnost `--configuration-profile` je aktuálně ve verzi Preview. Další informace naleznete v tématu Konfigurační profily.
`--csx`	Vytvoří .NET funkce jako skript jazyka C#, což je chování verze 1.x. Platné pouze s `--worker-runtime dotnet`.
`--docker`	Vytvoří soubor Dockerfile pro kontejner pomocí základní image založené na zvoleném `--worker-runtime`souboru . Tuto možnost použijte, když plánujete nasadit kontejnerizovanou aplikaci funkcí.
`--docker-only`	Přidá do existujícího projektu soubor Dockerfile. Pokud není zadaný nebo nastavený v local.settings.json, zobrazí se výzva k zadání modulu worker-runtime. Tuto možnost použijte, když plánujete nasadit kontejnerizovanou aplikaci funkcí a projekt již existuje.
`--force`	Inicializace projektu i v případě, že jsou v projektu existující soubory. Toto nastavení přepíše existující soubory se stejným názvem. Jiné soubory ve složce projektu nejsou ovlivněné.
`--language`, `-l`	Inicializuje projekt specifický pro jazyk. Aktuálně se podporuje, pokud `--worker-runtime` je nastavená hodnota `node`. Možnosti jsou `typescript` a `javascript`. Můžete také použít `--worker-runtime javascript` nebo `--worker-runtime typescript`.
`--managed-dependencies`	Nainstaluje spravované závislosti. V současné době tuto funkci podporuje pouze modul runtime pracovního procesu PowerShellu.
`--model`, `-m`	Nastaví programovací model pro cílový jazyk, pokud je k dispozici více než jeden model. Podporované možnosti jsou `V1` a `V2` pro Python a `V3` a `V4` pro Node.js. Další informace najdete v Python příručce pro vývojáře a v Node.js příručce pro vývojáře.
`--no-bundle`	Nenakonfigurujte sadu rozšíření v host.json. Platí pouze pro projekty, které nejsou .NET.
`--no-docs`	Přeskočí generování souborů dokumentace Začínáme. Platí pro Python projekty.
`--skip-npm-install`	Přeskočte spuštění `npm install` po vytvoření projektu. Platí pro Node.js projekty.
`--source-control`	Určuje, jestli se vytvoří úložiště Git. Ve výchozím nastavení se úložiště nevytvořilo. Když `true`se vytvoří úložiště.
`--worker-runtime`	Nastaví modul runtime jazyka pro projekt. Podporované hodnoty jsou: `csharp`, `dotnet`, , `dotnet-isolated`, `javascript`( `node` JavaScript), `powershell`, `python`a `typescript`. Pro Java použijte Maven. Pokud chcete vygenerovat projekt nezávislý na jazyce pouze se soubory projektu, použijte `custom`. Pokud není nastavené, zobrazí se výzva k výběru modulu runtime během inicializace.
`--target-framework`	Nastaví cílovou architekturu pro projekt aplikace funkcí. Platné pouze s `--worker-runtime dotnet-isolated`. Podporované hodnoty jsou: `net10.0` (Preview), `net9.0`, `net8.0` (výchozí), `net6.0` a `net48` (.NET Framework 4.8).

Poznámka:

Pokud použijete možnost --docker nebo --docker-only, nástroje Core Tools automaticky vytvoří soubor Dockerfile pro funkce C#, JavaScript, Python a PowerShell. Pro Java funkce musíte soubor Dockerfile vytvořit ručně. Další informace najdete v tématu Vytváření kontejnerizovaných aplikací funkcí.

Konfigurační profily

Důležité

Podpora konfiguračních profilů je aktuálně ve verzi Preview.

Při použití --configuration-profile této možnosti se vytvoří předdefinovaná sada konfigurací a nastavení projektu. Při zadávání konfiguračního profilu může inicializace přeskočit všechny ostatní kroky inicializace.

Hodnota profilu	Popis	Konkrétní akce
`mcp-custom-handler`	Vytvoří projekt, který používá vlastní obslužné rutiny k hostování serveru MCP (Model Context Protocol), ke kterému se můžou připojit agenti AI a další klienti MCP.	• Nakonfiguruje `"configurationProfile": "mcp-custom-handler"` prvek v souboruhost.json s konkrétním nastavením vlastní obslužné rutiny. • Nastaví `MCP_EXTENSION_ENABLED`local.settings.json`true` .

`func logs`

Získá protokoly pro funkce spuštěné v clusteru Kubernetes.

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

Příkaz func logs podporuje tyto možnosti:

Možnost	Popis
`--platform`	Hostování platformy pro aplikaci funkcí Platné možnosti: `kubernetes`.
`--name`	Název aplikace funkcí v Azure

Další informace najdete v tématu Azure Functions v Kubernetes s KEDA.

`func new`

Vytvoří novou funkci v aktuálním projektu na základě šablony.

func new

Když spustíte func new bez --template možnosti, zobrazí se výzva k výběru šablony. Ve verzi 1.x musíte také zvolit jazyk.

Příkaz func new podporuje tyto možnosti:

Možnost	Popis
`--authlevel`, `-a`	Nastaví úroveň autorizace pro trigger HTTP. Podporované hodnoty jsou: `function`, `anonymous`, `admin`. Autorizace se nevynucuje při místním spuštění. Další informace najdete v tématu Úroveň autorizace.
`--csx`	(Verze 2.x a novější verze.) Vygeneruje stejné šablony skriptu C# (.csx) používané ve verzi 1.x a na portálu.
`--file`, `-f`	Cílový soubor nové funkce. U projektů Python v2 určuje soubor, do které se má funkce přidat (výchozí hodnota je function_app.py). Pro projekty Node.js v4 určuje název výstupního `src/functions` souboru ve složce. Nelze použít pro kompilované projekty .NET.
`--language`, `-l`	Programovací jazyk šablony, například C# nebo JavaScript. Tato možnost je vyžadována ve verzi 1.x. Ve verzi 2.x a novějších verzích tuto možnost nepoužívejte, protože jazyk je definován modulem runtime pracovního procesu.
`--name`, `-n`	Název funkce.
`--template`, `-t`	`func templates list` Pomocí příkazu zobrazíte úplný seznam dostupných šablon pro každý podporovaný jazyk.

Další informace najdete v tématu Vytvoření funkce.

`func pack`

Vytvoří balíček pro nasazení, který obsahuje kód projektu ve spuštěném stavu. Tuto metodu použijte, když potřebujete ručně vytvořit balíček pro nasazení aplikace na místním počítači mimo func azure functionapp publish příkaz. Ve výchozím nastavení func pack projekt sestaví v případě potřeby.

func pack [<FOLDER_PATH>]

Ve výchozím nastavení func pack zabalí aktuální adresář a výstupní .zip soubor má stejný název jako kořenová složka projektu. Spusťte func pack v adresáři, který obsahuje váš soubor projektuhost.json . Pokud potřebujete spustit func pack v jiném adresáři, nastavte <FOLDER_PATH> ji jako cestu ke kořenovému adresáři projektu, například func pack ./myprojectroot. Pokud konkrétní soubor .zip již existuje, nejprve se odstraní a nahradí aktualizovanou verzí.

Příkaz func pack podporuje tyto možnosti:

Možnost	Popis
`--output`, `-o`	Nastaví cestu k umístění, kam se vytvoří soubor balíčku .zip nasazení.
`--no-build`	Project není před balením sestaven. Pro aplikace jazyka C# používejte pouze v případě, že jste už vygenerovali binární soubory. U Node.js aplikací se obě `npm install` aplikace `npm run build` přeskočí.
`--skip-install`	Při balení Node.jsaplikace funkcí se přeskočí `npm install` . Slouží k tomu, aby se zabránilo přepsání vlastních modulů npm.
`--build-native-deps`	Nainstaluje závislosti Python místně pomocí image, která odpovídá prostředí používanému v Azure. Pokud je tato možnost povolená, nástroje Core Tools spustí kontejner Dockeru, sestaví aplikaci uvnitř daného kontejneru a vytvoří soubor .zip se všemi obnovenými závislostmi.`.python_packages` Tuto možnost použijte při spuštění na Windows, abyste se vyhnuli potenciálním problémům s knihovnou při nasazování do Linuxu v Azure.

`func run`

Pouze verze 1.x.

Umožňuje vyvolat funkci přímo, která se podobá spuštění funkce pomocí karty Test na portálu Azure. Tato akce je podporována pouze ve verzi 1.x. V případě novějších verzí použijte func start a volejte koncový bod funkce přímo.

func run

Příkaz func run podporuje tyto možnosti:

Možnost	Popis
`--content`	Vložený obsah předaný funkci.
`--debug`	Před spuštěním funkce připojte ladicí program k hostitelskému procesu.
`--file`	Název souboru, který se má použít jako obsah.
`--no-interactive`	Nezobrazuje výzvu k zadání vstupu, což je užitečné pro scénáře automatizace.
`--timeout`	Doba čekání (v sekundách) až do doby, než bude místní hostitel functions připravený.

Pokud chcete například volat funkci aktivovanou protokolem HTTP a předat text obsahu, spusťte tento příkaz:

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

`func start`

Spustí místního hostitele modulu runtime a načte projekt funkce v aktuální složce.

Konkrétní příkaz závisí na verzi modulu runtime.

v2.x+
v1.x

func start

Příkaz func start podporuje tyto možnosti:

Možnost	Popis
`--cert`	Cesta k souboru .pfx, který obsahuje privátní klíč. Podporováno pouze s `--useHttps`.
`--cors`	Čárkami oddělený seznam původů CORS bez mezer.
`--cors-credentials`	Umožňuje požadavky ověřené mezi zdroji, které používají soubory cookie a hlavičku Ověřování.
`--dotnet-isolated-debug`	Při nastavení na `true` pozastaví pracovní proces .NET, dokud není ladicí program připojen z .NET izolovaného projektu, který je laděný.
`--enable-json-output`	Vygeneruje protokoly konzoly jako JSON, pokud je to možné.
`--enableAuth`	Umožňuje úplný kanál pro zpracování ověřování s požadavky na autorizaci.
`--functions`	Seznam funkcí oddělených mezerami, které se mají načíst.
`--json-output-file`	Pokud je k dispozici, cesta k souboru použitému k zápisu výstupu při použití `--enable-json-output`.
`--language-worker`	Argumenty pro konfiguraci pracovního procesu jazyka Ladění pro pracovní proces jazyka můžete povolit například tak, že poskytnete port debug a další požadované argumenty.
`--no-build`	Než spustíte, nevystavujte aktuální projekt. Pouze pro .NET projekty tříd. Výchozí hodnota je `false`.
`--password`	Heslo nebo soubor, který obsahuje heslo pro soubor .pfx. Používá se pouze s `--cert`.
`--port`, `-p`	Místní port, na který se má naslouchat. Výchozí hodnota: 7071.
`--runtime`	Nastaví, která verze hostitele se má spustit. Povolené hodnoty jsou: `inproc6`, `inproc8`a `default` (které spouští hostitele mimo proces).
`--timeout`, `-t`	Časový limit pro spuštění hostitele služby Functions v sekundách Výchozí hodnota: 20 sekund.
`--useHttps`	Svázání s `https://localhost:{port}` výjimkou `http://localhost:{port}`. Ve výchozím nastavení tato možnost vytvoří v počítači důvěryhodný certifikát.
`--user-log-level`	Nastaví minimální úroveň protokolu pro protokoly uživatelů. Platné hodnoty jsou: `Trace`, `Debug`, `Information`, `WarningError`, , `Critical`, a `None`. Toto nastavení nemá vliv na systémové protokoly. U .NET izolovaných projektů také nastavte minimální úroveň v `Program.cs` pomocí `builder.Logging.SetMinimumLevel(LogLevel.Debug)`, aby se tato možnost projevila.

Se spuštěným projektem ověřte jednotlivé koncové body funkce.

func host start

Příkaz func host start podporuje tyto možnosti:

Možnost	Popis
`--cors`	Čárkami oddělený seznam původů CORS bez mezer.
`--port`	Místní port, na který se má naslouchat. Výchozí hodnota: 7071.
`--pause-on-error`	Pozastaví další vstup před ukončením procesu. Používá se pouze při spouštění nástrojů Core Tools z integrovaného vývojového prostředí (IDE).
`--script-root`	Určuje cestu ke kořenovému adresáři aplikace funkcí, která se má spustit nebo nasadit. Tato možnost se používá pro kompilované projekty, které generují soubory projektu do podsložky. Například při vytváření projektu knihovny tříd jazyka C# se soubory host.json, local.settings.json a function.json generují v kořenové podsložce s cestou jako `MyProject/bin/Debug/netstandard2.0`. V tomto případě nastavte předponu na `--script-root MyProject/bin/Debug/netstandard2.0`hodnotu . Tato cesta je kořenem aplikace funkcí při spuštění v Azure.
`--timeout`	Časový limit pro spuštění hostitele služby Functions v sekundách Výchozí hodnota: 20 sekund.
`--useHttps`	Svázání s `https://localhost:{port}` výjimkou `http://localhost:{port}`. Ve výchozím nastavení tato možnost vytvoří v počítači důvěryhodný certifikát.

Ve verzi 1.x použijte func run také příkaz ke spuštění konkrétní funkce a předání testovacích dat do ní.

`func azure functionapp`

Kontext func azure functionapp obsahuje následující příkazy:

func azure functionapp fetch-app-settings
func azure functionapp list-functions
func azure functionapp logstream
func azure functionapp publish

Všechny func azure functionapp příkazy podporují tyto možnosti:

Možnost	Popis
`--slot`	Pokud je nakonfigurovaný, cílí na konkrétní pojmenovaný slot nasazení.
`--access-token`	Poskytuje přístupový token kromě výchozího tokenu, který slouží k provádění ověřených akcí v Azure.
`--access-token-stdin`	Načte konkrétní přístupový token ze standardního vstupu. Tuto možnost použijte při čtení tokenu přímo z předchozího příkazu, například `az account get-access-token`.
`--management-url`	Nastaví adresu URL pro správu Azure cloudu, která ve výchozím nastavení `https://management.azure.com`. Tuto možnost použijte, když vaše aplikace funkcí běží v suverénním cloudu.
`--subscription`	Nastaví výchozí Azure předplatné.

`func azure functionapp fetch-app-settings`

Získá nastavení z konkrétní aplikace funkcí.

func azure functionapp fetch-app-settings <APP_NAME>

Další informace najdete v tématu Stažení nastavení aplikace.

Nastavení se stáhne do souborulocal.settings.json projektu. Hodnoty na obrazovce jsou maskované pro zabezpečení. Nastavení v souboru local.settings.json můžete chránit povolením místního šifrování.

`func azure functionapp list-functions`

Zobrazí seznam funkcí v zadané aplikaci funkcí.

func azure functionapp list-functions <APP_NAME>

Příkaz func azure functionapp list-functions podporuje tuto možnost:

Možnost	Popis
`--show-keys`	Do vrácených adres URL koncových bodů funkce uveďte hodnoty přístupového klíče na úrovni funkce.

`func azure functionapp logstream`

Připojí místní příkazový řádek k protokolům streamování aplikace funkcí v Azure.

func azure functionapp logstream <APP_NAME>

Výchozí časový limit připojení je 2 hodiny. Časový limit můžete změnit přidáním nastavení aplikace s názvem SCM_LOGSTREAM_TIMEOUT s hodnotou časového limitu v sekundách. Zatím není podporováno pro Linux v plánu Flex Consumption nebo Consumption . U těchto aplikací použijte --browser možnost zobrazit protokoly na portálu.

Příkaz func azure functionapp logstream podporuje tuto možnost:

Možnost	Popis
`--browser`	Ve výchozím prohlížeči otevřete live stream Azure Application Insights pro aplikaci funkcí.

Další informace najdete v tématu Enable protokolů spouštění streamování v Azure Functions.

`func azure functionapp publish`

Nasadí projekt Functions do existujícího prostředku aplikace funkcí v Azure.

func azure functionapp publish <APP_NAME>

Další informace naleznete v tématu Nasazení souborů projektu.

Na základě verze platí následující možnosti publikování:

v2.x+
v1.x

Možnost	Popis
`--additional-packages`	Seznam balíčků, které se mají nainstalovat při sestavování nativních závislostí Například: `python3-dev libevent-dev`.
`--build`, `-b`	Provede akci sestavení při nasazování do aplikace funkcí Pro Linux. Přijímá: `remote` a `local`.
`--build-native-deps`	Při publikování Python aplikací funkcí přeskočí generování složky `.wheels`.
`--csx`	Publikujte projekt skriptu jazyka C# (.csx).
`--dotnet-cli-params`	Při publikování zkompilovaných funkcí jazyka C# (.csproj) volají `dotnet build --output bin/publish`základní nástroje . Všechny parametry předané této možnosti se připojí k příkazovému řádku.
`--dotnet-version`	Pro aplikace `dotnet-isolated` určuje cílovou verzi .NET (například `8.0`).
`--force`	Ignoruje předběžné publikování ověření v určitých scénářích.
`--list-ignored-files`	Zobrazí seznam souborů, které se při publikování ignorují, na základě souboru .funcignore .
`--list-included-files`	Zobrazí seznam publikovaných souborů, které jsou založené na souboru .funcignore .
`--no-build`	Project se během publikování nestaví. V případě Python se `pip install` nespustí.
`--nozip`	Vypne výchozí `Run-From-Package` režim. Extrahuje soubory do `wwwroot` složky na serveru místo jejich spuštění přímo z balíčku pro nasazení.
`--overwrite-settings`, `-y`	Potlačí výzvu k přepsání nastavení aplikace při použití `--publish-local-settings -i`.
`--publish-local-settings`, `-i`	Publikuje nastavení v local.settings.json do Azure a zobrazí výzvu k přepsání, pokud nastavení již existuje. Pokud používáte emulátor místního úložiště, nejprve změňte nastavení aplikace na skutečné připojení k úložišti.
`--publish-settings-only`, `-o`	Publikuje jenom nastavení a přeskočí obsah. Výchozí hodnota je výzva.
`--show-keys`	Přidá funkční klíče k adresám URL zobrazeným v protokolech.

Možnost	Popis
`--overwrite-settings`, `-y`	Potlačí výzvu k přepsání nastavení aplikace při použití `--publish-local-settings -i`.
`--publish-local-settings`, `-i`	Publikuje nastavení v local.settings.json do Azure a zobrazí výzvu k přepsání, pokud nastavení již existuje. Pokud používáte emulátor microsoftu Azure Storage, změňte nejprve nastavení aplikace na actual storage connection.

`func azure storage fetch-connection-string`

Získá connection string pro zadaný účet Azure Storage.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Další informace najdete v tématu download a storage connection string.

`func azurecontainerapps deploy`

Nasadí kontejnerizovanou aplikaci funkcí do Azure Container Apps prostředí. Účet úložiště používaný aplikací funkcí a prostředí už musí existovat. Další informace najdete v tématu Azure Container Apps hostování 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>

Platí následující možnosti nasazení:

Možnost	Popis
`--environment`	Název existujícího prostředí Container Apps.
`--image-build`	Nastavte na `true` vynechání místního sestavení Dockeru.
`--image-name`	Název existující image kontejneru v registru kontejneru, včetně názvu značky.
`--location`	Oblast pro nasazení V ideálním případě je tato oblast stejná jako prostředky prostředí a účtu úložiště.
`--name`	Název použitý pro nasazení aplikace funkcí v prostředí Container Apps. Tento název se také zobrazí při správě aplikace funkcí na portálu. Název musí být v prostředí jedinečný.
`--registry`	Při nastavení se spustí sestavení Dockeru a image se odešle do registru nastaveného v `--registry`. Nemůžete použít `--registry` s `--image-name`. Pro Docker Hub použijte také `--registry-username`.
`--registry-password`	Heslo nebo token použitý k načtení image z privátního registru.
`--registry-username`	Uživatelské jméno použité k načtení image z privátního registru.
`--resource-group`	Skupina prostředků, ve které chcete vytvořit prostředky související s funkcemi.
`--storage-account`	Connection string pro účet úložiště, který bude aplikace funkcí používat.
`--worker-runtime`	Nastaví jazyk modulu runtime aplikace funkcí. Tento parametr se používá pouze s `--image-name` a `--image-build`; jinak se jazyk určuje během místního sestavení. Podporované hodnoty jsou: `dotnet`, , `dotnetIsolatednode`, `python`, `powershell`a `custom` (pro vlastní obslužné rutiny).

Důležité

Důležité tajné kódy jsou připojovací řetězec úložiště a další přihlašovací údaje služby. Bezpečně uložte všechny soubory skriptu, které používají func azurecontainerapps deploy , a neukládají je do žádné veřejně přístupné správy zdrojového kódu.

`func deploy`

Příkaz func deploy je zastaralý. Místo toho použijte func kubernetes deploy.

`func bundles add`

Přidá konfiguraci sady rozšíření do souboruhost.json .

func bundles add

Příkaz func bundles add podporuje tyto možnosti:

Možnost	Popis
`--force`, `-f`	Přepíše existující konfiguraci sady rozšíření, pokud je k dispozici.
`--channel`, `-c`	Kanál verze sady rozšíření Podporované hodnoty jsou: `GA` (výchozí) `Preview`a `Experimental`.

`func bundles download`

Stáhne sadu rozšíření nakonfigurovanou v host.json.

func bundles download

Příkaz func bundles download podporuje tyto možnosti:

Možnost	Popis
`--force`, `-f`	Vynutí opětovné stažení sady rozšíření, i když už existuje.

`func bundles list`

Obsahuje seznamy stažených sad rozšíření.

func bundles list

`func bundles path`

Získá cestu ke stažené sadě rozšíření.

func bundles path

`func durable delete-task-hub`

Odstraní všechny artefakty úložiště v centru úloh Durable Functions.

func durable delete-task-hub

Příkaz func durable delete-task-hub podporuje tyto možnosti:

Možnost	Popis
`--connection-string-setting`	Název nastavení, které obsahuje connection string úložiště, které se má použít.
`--task-hub-name`	Název centra úloh Durable, které se má použít.