Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Tento článek poskytuje referenční dokumentaci pro lokální runtime a nástroje podporující Azure Functions. Použijte tyto nástroje k vývoji, správě a provozu Azure Functions projektů přímo z vašeho místního počítače. Binární název je func (nebo func.exe na Windows).
Dva lokální vývojové zážitky jsou uvedeny pod jménem func.exeAzure Functions Core Tools (GA) a Azure Functions CLI (preview). Použijte selector k výběru, který zážitek chcete sledovat.
Důležité
Azure Functions CLI (v5) je momentálně v náhledu. Tato verze Preview zatím nepodporuje Java a PowerShell. Pokud chcete pracovat s aktuálně nepodporovanými jazyky, pokračujte v používání nástrojů Azure Functions Core Tools verze 4.
Existují dva příkazové nástroje, které jsou dodávány stejně jako func.exe pro Azure Functions:
| Azure Functions Core Tools | rozhraní příkazového řádku Azure Functions | |
|---|---|---|
| func.exe verze | v4 | v5 |
| Úroveň podpory | Všeobecná dostupnost (GA) | Náhled |
| Nároky na instalaci | Úplný binární soubor, který obsahuje všechny příkazy a možnosti pro všechny nativní jazyky. | Malá základní instalace a úlohy podle jazyka a další funkce, které podle potřeby přidáte. Hostitel se dodává jako vlastní úloha, takže získáte nejnovější verzi hostitele bez opětovného stažení rozhraní příkazového řádku. |
| Použít, když... | Potřebujete plnou podporu ga pro všechny pracovní postupy vývoje. | Chcete jednoduché prostředí založené na úlohách s novými funkcemi, jako jsou šablony rychlý start a profily, které udržují vaše místní prostředí synchronizované s konfigurací plánu hostování Azure. |
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.
Důležité
Azure Functions CLI (v5) je momentálně v náhledu. Tato verze Preview zatím nepodporuje Java a PowerShell. Pokud chcete pracovat s aktuálně nepodporovanými jazyky, pokračujte v používání nástrojů Azure Functions Core Tools verze 4.
Chcete-li se dozvědět více o používání CLI, včetně instalace a pracovních zátěží, viz Develop Azure Functions lokálně pomocí Azure Functions CLI.
Následující vestavěné příkazy jsou dodávány s instalací základního CLI:
| Command | Popis |
|---|---|
func init |
Inicializace nového projektu Azure Functions. |
func new |
Vytvořte novou funkci ze šablony. |
func run |
Spusť Azure Functions hostitelský runtime lokálně.
func start je zpětně kompatibilní alias. |
func quickstart |
Prohlédněte si a podpořte kompletní aplikace z katalogu šablon rychlého startu. |
func profile |
Inspect and manage Azure Functions CLI profily. |
func setup |
Připravte lokální závislosti Azure Functions CLI (host runtime, language workers, extension bundles). |
func workload |
Spravujte nainstalované CLI zátěže. |
Pracovní zátěže mohou přispívat dalšími příkazy nejvyšší úrovně. Tyto příkazy se objeví až po instalaci přispívající pracovní zátěže.
func init
Vytvoří nový projekt Functions v určitém jazyce.
func init [<PROJECT_FOLDER>]
Když zadáte <PROJECT_FOLDER>, příkaz vytvoří projekt v nové složce s tímto názvem. Jinak používá aktuální složku.
Příkaz func init podporuje tyto možnosti, které závisí na verzi:
| Možnost | Popis |
|---|---|
--bundles-channel, -c |
Kanál verze sady rozšíření Podporované hodnoty jsou: GA (výchozí) Previewa 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 |
Vytváří .NET funkce jako C# skript. Platné pouze s --worker-runtime dotnet. |
--docker |
Vytváří Dockersoubor pro kontejner použitím základního obrazu založeného na zvoleném --worker-runtime. 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 |
Inicializuje projekt i tehdy, když jsou v projektu již 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ž truese vytvoří úložiště. |
--worker-runtime |
Nastaví modul runtime jazyka pro projekt. Podporované hodnoty jsou: csharp, dotnet, , dotnet-isolated, javascript( node JavaScript), powershell, pythona 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.
Když tuto --configuration-profile možnost použijete, vytvoříte předdefinovanou sadu 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_ENABLEDlocal.settings.jsontrue . |
func init [<PATH>] [options]
Když zadáte <PATH>, projekt se vytvoří v této složce. V opačném případě se použije aktuální složka.
Příkaz func init podporuje tyto vestavěné možnosti:
| Možnost | Popis |
|---|---|
--stack, -s |
Zásobník pro použití pro projekt (například python, node, , dotnet). go Běžte func workload list a podívejte se na stacky, které přispívají vaše nainstalované pracovní zátěže. |
--name, -n |
Název projektu function app. |
--language, -l |
Programovací jazyk (například C#, F#, JavaScript, TypeScript, Python). Používá se, když zásobník podporuje více než jeden jazyk. Podporované hodnoty se počítají z instalovaných zásobníkových zátěží. |
--force |
Znovu inicializujte i když cílová složka není prázdná. Složku (kromě .git) před lešením vyčistí. |
Pracovní zátěže přinášejí další možnosti, které jsou seskupeny pod názvem zátěže v .func init --help Podívejte se na možnosti specifické pro pracovní zátěž pro jednotlivé možnosti zásobníku.
Pokud žádný workload neposkytuje požadovaný zásobník, CLI vytiskne nápovědu ukazující na a func workload install ukončí s nenulovým výstupním kódem.
Možnosti specifické pro pracovní zátěž
Příkaz init se rozšiřuje, když nainstalujete jednu nebo více z těchto zátěží:
| Možnost | Popis |
|---|---|
--target-framework, -tfm |
Cílový .NET rámec projektu (například net10.0). Výchozí hodnota: net10.0. |
Inicializátor .NET nezapisuje blok rozšiřujícího balíčku, takže --no-bundles a --bundles-channel nejsou použitelné.
Když více než jedna nainstalovaná zátěž přispívá stejnou možností, možnost se objeví jednou v func init --help.
Sdílené možnosti
V současnosti jsou sdílené možnosti --no-bundles a .--bundles-channel Výchozí ID rozšíření balíčku, do kterého host.json zapisujete, závisí na zvoleném kanálu:
| Channel | ID balíčku |
|---|---|
GA (výchozí) |
Microsoft.Azure.Functions.ExtensionBundle |
Preview |
Microsoft.Azure.Functions.ExtensionBundle.Preview |
Experimental |
Microsoft.Azure.Functions.ExtensionBundle.Experimental |
Výchozí rozsah verzí je [4.*, 5.0.0).
func new
Vytvoří novou funkci v aktuálním projektu na základě šablony.
func new
Příkaz func new podporuje tyto možnosti, které závisí na verzi:
| 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 |
Generuje stejné šablony C# skriptů (.csx), které byly použity ve verzi 1 a v 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. |
--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 new [<PATH>] [options]
Důležité
func new je momentálně náhledový stub. Vytiskne nápovědu k instalaci zátěže a ukončí s nenulovým výstupním kódem, dokud není nainstalována a zapojena šablona. Možnosti specifické pro šablonu jsou dynamicky hydratovány z metadat šablony, takže přidání nové možnosti šablony nevyžaduje uvolnění CLI.
Příkaz func new podporuje tyto vestavěné možnosti:
| Možnost | Popis |
|---|---|
--name, -n |
Název funkce. |
--template, -t |
Název šablony funkce. Dostupné šablony pocházejí z nainstalované <stack>-templates pracovní zátěže pro zásobník projektu. |
--force |
Přepište existující soubory. |
Další možnosti jsou dynamicky přispívány vybranou šablonou. Běžte a podívejte func new --template <name> --help se na možnosti konkrétní šablony.
Pokud pro aktuální projekt není nainstalováno žádné workload šablon, CLI vytiskne nápovědu ukazující na func workload install.
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 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.
Pro aplikace s funkcí Go func pack sestaví linuxový x64 deployment package, který můžete nasadit pomocí příkazu Azure CLI az functionapp deployment source config-zip.
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čí. U aplikací Go používejte pouze tehdy, když bin/aplikace už obsahuje linuxový x64 binární soubor. |
--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 v1)
Poznámka:
Tento příkaz platí pouze pro verzi 1 Core Tools a je již zastaralý. Pro verzi 4 použijte func start a volejte přímo koncový bod funkce.
Přímo vyvolá funkci, podobně jako při spuštění funkce pomocí záložky Test v portálu Azure.
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.
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, inproc8a 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 run
Spustí runtime hostitele Functions a načte projekt do aktuální složky.
func run [<PATH>] [options]
func start je zachována jako zpětně kompatibilní alias a přijímá stejné argumenty a možnosti.
Příkaz func run podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--port, -p |
Místní port, na který se má naslouchat. Výchozí hodnota: 7071. |
--cors |
Čárkami oddělený seznam původů CORS bez mezer. |
--cors-credentials |
Povolit cross-origin autentizované požadavky, které používají cookies a hlavičku Authentication . |
--functions |
Seznam funkcí oddělených mezerami, které se mají načíst. |
--no-build |
Nebudujte projekt před spuštěním. |
--enable-auth |
Povolte kompletní pipeline zpracování autentizace včetně požadavků na autorizaci. |
--host-version, -v |
Hostitelská runtime verze pro použití (například 4.1049.0). |
--profile |
Profil Azure Functions se aplikuje při řešení verzí host, worker a bundle. Viz func profile. |
--offline |
Používejte pouze lokálně instalované pracovní zátěže a přeskočte síťové instalace. |
--output |
Výstupní režim: compact (interaktivní TUI), plain (CI / ne-TTY) nebo json (NDJSON pro programatických uživatelů a AI agenty). Ve výchozím nastavení je automatická detekce podle terminálu. |
--no-tui |
Alias pro --output=plain. Vypíná interaktivní TUI. |
--log-file |
Zrcadlite všechny události hostitele do zadaného logu. |
--no-azurite |
Vypněte spravovaný Azurite. Hostitel začíná bez sondování nebo spuštění lokálního emulátoru. |
Když projekt běží, volejte koncové body funkce přímo pro ověření chování.
Spravovaný azurit
Když váš projekt používá lokální úložiště (například ), AzureWebJobsStorage=UseDevelopmentStorage=truefunc run automaticky zkontroluje běžící emulátor Azurite a spustí ho, pokud ho nenajde. Emulátor se zastaví, když func run se ukončí. Přijdi na --no-azurite odhlášení a spravování Azuritu sám.
Výstupní režimy
func run Automaticky vybírá výstupní režim na základě terminálu:
| Podmínka | Režim |
|---|---|
| Interaktivní terminál (TTY) | compact |
Neinteraktivní stdout, přesměrovaný výstup nebo CI sada proměnných prostředí |
plain |
Explicitní --output=json |
json |
CLI nikdy automaticky nevybere json. Pokud compact je požadováno, ale stdout není TTY, CLI se degraduje na plain stderr a napíše jednořádkové oznámení. Režim json vysílá JSON (NDJSON) s novým řádkem (NDJSON), jeden objekt na řádek, s a schema_version .1
func quickstart
Browses and scaffolds dokončují funkční aplikace z katalogu šablon Azure Functions quickstart. Šablony rychlého startu jsou kompletní ukázkové aplikace, jako je HTTP API, worker spouštěný frontou nebo orchestrace Durable Functions. Stack workloady přispívají jazykově specifickými resolvery. Katalog je načítán při zavolání příkazu.
func quickstart [<PATH>] [options]
Když zadáte <PATH>, projekt se vytvoří v této složce. V opačném případě se použije aktuální složka.
Příkaz func quickstart podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--stack, -s |
Zásobník, který použijete, například python, node, nebo dotnet. |
--language, -l |
Programovací jazyk. Podporované hodnoty pocházejí z nainstalovaných poskytovatelů rychlého startu. |
--template, -t |
ID šablony z katalogu, například http-trigger-python-azd. Přeskočí všechny interaktivní výzvy. |
--resource, -r |
Filtrujte podle spouštěče nebo vazebného zdroje, například http, timer, blob, eventhubservicebus, cosmos, sql, mcp, , nebo durable. |
--iac |
Filtrujte podle typu infrastructure-as-code, například bicep, terraform, nebo none. |
--search |
Filtr podřetězců bez rozlišení písmen aplikovaný na názvy a popisy šablon. |
--fetch |
Strategie načítání katalogu: auto (výchozí), git, nebo http.
auto sondují a git vrací se k HTTP. |
--force |
Podporuj i když cílová složka není prázdná. Složku (kromě .git) před lešením vyčistí. |
Podpříkazy:
| Subcommand | Popis |
|---|---|
func quickstart list |
Uveďte dostupné šablony v katalogu. |
func quickstart info |
Ukázat podrobnosti o konkrétní šabloně. |
func quickstart list
Uvádí dostupné šablony z katalogu, volitelně filtrované.
func quickstart list [options]
| Možnost | Popis |
|---|---|
--stack, -s |
Zásobník, který použijete, například python, node, nebo dotnet. |
--language, -l |
Programovací jazyk. Podporované hodnoty pocházejí z nainstalovaných poskytovatelů rychlého startu. |
--resource, -r |
Filtrujte podle triggeru nebo zdroje vazby. |
--iac |
Filtrujte podle typu infrastructure-as-code. |
--search |
Shoda podřetězců bez rozlišení písmen s ID, názvy šablon, typem zdroje, typem Infrastructure as Code a popisy. |
--json |
Místo tabulky vysílejte strojově čitelný JSON. |
func quickstart info
Zobrazuje podrobné informace o konkrétní šabloně.
func quickstart info <ID> [options]
<ID> je šablonové ID z katalogu. Použijte func quickstart list k nalezení dostupných dokladů.
| Možnost | Popis |
|---|---|
--json |
Vysílejte strojově čitelný JSON místo formátovaného výstupu. |
func profile
Inspects and manages Azure Functions CLI profiles. Profily kódují omezení verzí, jako je rozsah verzí hostitele, rozsah verzí balíčku rozšíření a rozsah verzí pracovníka. Definují také dědičnost z jiných profilů. Zdroje profilů zahrnují projektově lokální (.func/profiles/), uživatelsko-globální (~/.azure-functions/profiles/) a vestavěné profily. Použijte func run --profile <name> možnost vybrat, které omezení profilu se při spuštění hostu vztahují.
func profile <subcommand>
Podpříkazy:
| Subcommand | Popis |
|---|---|
func profile list |
Profily jsou dostupné z projektů, uživatelů a vestavěných zdrojů. |
func profile show |
Zobrazit podrobnosti pro profil. |
func profile set |
Nastavte výchozí profil pro projekt. |
func profile list
Uvádí profily dostupné z projektů, uživatelů a vestavěných zdrojů. Vykresluje tabulku názvu, zdrojového kódu, verze hostitele, balíčku rozšíření a stavu.
func profile list [<PATH>] [options]
| Možnost | Popis |
|---|---|
--source |
Seznam zdrojů oddělených čárkou zahrnuje: project, user, built-in. Výchozí nastavení na všechny zdroje. |
--json |
Místo tabulky vysílejte strojově čitelný JSON. |
func profile show
Zobrazuje detaily pro jeden profil, buď vyřešení (s aplikovanými děděnými hodnotami), nebo surové (definice napsána bez rozšíření dědičnosti).
func profile show <NAME> [<PATH>] [options]
| Možnost | Popis |
|---|---|
--raw |
Zobrazit definici surového profilu bez dědičných hodnot. |
func profile set
Nastaví výchozí profil pro projekt Functions tak, že do projektu .func/config.jsonzapíše název profilu . Pokud profil ještě není v seznamu profilů projektu, přidej ho.
func profile set <NAME> [<PATH>]
func setup
Připravuje lokální stroj pro spouštění projektů Azure Functions. Instaluje nebo ověřuje hostitelský runtime, jazykové workery, balíčky rozšíření a šablony pro zásobníky, které specifikujete. Podporuje omezení verzí založená na profilu, výběr před vydáním, neinteraktivní režim CI a režim pouze kontrol.
func setup [<PATH>] [options]
--features Vybere, co nainstalovat nebo ověřit. Funkce a pracovní zátěže, které každý z nich řeší, jsou:
| funkce | Instalované pracovní zátěže |
|---|---|
node |
host, bundles, node, , node-workernode-templates |
python |
host, bundles, python, , python-workerpython-templates |
go |
host, bundles, , gogo-worker |
dotnet |
host, , dotnetdotnet-templates |
runtime |
host, bundles |
host |
host pouze |
--features je opakovatelný a přijímá hodnoty oddělené čárkou, takže můžete prvky kombinovat v jednom volání (například func setup --features node,python).
dotnet-isolated je přijímána jako alias pro dotnet.
| Možnost | Popis |
|---|---|
--features |
Komponenty k instalaci nebo ověření. Opakovatelné nebo oddělené čárkou. Viz tabulka výše pro pracovní zatížení, které každá funkce instaluje. |
--profile |
Azure Functions profil pro použití pro omezení verzí. Opakovatelný. Sloučeno s --profiles. |
--profiles |
Seznam profilů Azure Functions oddělený čárkou pro použití pro verzní omezení. |
--install-policy |
Instalační politika: latest-compatible (výchozí) nebo if-needed. |
--source |
NuGet balíček je zdroj pro řešení a instalaci zátěže. |
--prerelease |
Při řešení z katalogu povolte verze s předvydáním zátěže. Výchozí: zapnuto, zatímco pracovní zátěže jsou v náhledu. |
--non-interactive |
Nežádejte o vstup. |
--yes, -y |
Odpovězte ano na výzvy k nastavení. |
--check |
Ověřte, zda jsou vybrané závislosti nainstalovány, aniž byste museli měnit. |
--output |
Výstupní režim: plain (výchozí) nebo json (NDJSON). |
func workload
Spravuje workloady nainstalované pro Azure Functions CLI.
func workload <subcommand>
Podpříkazy:
| Subcommand | Popis |
|---|---|
func workload list |
Vypiš nainstalované pracovní zátěže. |
func workload search |
Prohledejte katalog pracovních zátěží. |
func workload install |
Zainstalujte pracovní zátěž. |
func workload update |
Aktualizujte nainstalovanou pracovní zátěž. |
func workload uninstall |
Odinstalujte pracovní zátěž. |
func workload prune |
Odstraňte neaktivní instalace zátěže vedle sebe. |
func workload list
Zobrazí seznam nainstalovaných úloh. Ve výchozím nastavení příkaz zobrazuje pouze načtenou verzi (nejvýše nainstalovaný semver) každého workloadu. Používal jsem --all-versions všechny instalace vedle sebe.
func workload list [options]
| Možnost | Popis |
|---|---|
--all-versions, -a |
Vyjmenujte všechny nainstalované verze každé pracovní zátěže. Výchozí: pouze načtená verze. |
--json |
Místo tabulky vysílejte strojově čitelný JSON. |
func workload search
Vyhledává konfigurovaný katalog pracovních zátěží pro dostupné balíčky pracovních zátěží.
func workload search [<QUERY>] [options]
Když vynecháte <QUERY>, příkaz zobrazí všechny pracovní zátěže v katalogu.
| Možnost | Popis |
|---|---|
--source |
URL katalogu pro vyhledávání. Výchozí nastavení je nakonfigurovaný katalog. |
--prerelease |
Do výsledků zahrňte předběžné verze. Výchozí: zapnuto, zatímco pracovní zátěže jsou v náhledu. |
--json |
Místo tabulky vysílejte strojově čitelný JSON. |
func workload install
Vyřeší ID (nebo alias) pracovního zátěže prostřednictvím nakonfigurovaného katalogu a nainstaluje ho.
func workload install <ID> [options]
<ID> může být ID balíčku pracovní zátěže, aliasem (například python), nebo cestou k lokálnímu souboru balíku pracovní zátěže.
| Možnost | Popis |
|---|---|
--version, -v |
Konkrétní verze k instalaci. Výchozí: nejnovější stabilní verze v katalogu. |
--source |
Katalogová zdrojová URL nebo lokální adresář pro vyřešení. Výchozí: konfigurovaný katalog. |
--prerelease |
Při vyřešení z katalogu povolte předběžné verze. Výchozí: zapnuto, zatímco pracovní zátěže jsou v náhledu. |
--force, -f |
Přepiš existující instalaci se stejným ID a verzí. Také přeskočí výzvu "použít místo toho aktualizaci". |
--exact, -e |
Vypněte shodu aliasů.
<ID> musí být doslovné ID balíčku. |
Pokud je verze workloadu již nainstalovaná, CLI vás vyzve k použití func workload update místo ní. Neinteraktivní kontexty považují tuto výzvu za úpadek.
func workload update
Provede na místě atomickou výměnu verzí pro nainstalovanou pracovní zátěž. Aktualizace nejsou vedle sebe; Pro instalace vedle sebe použijte func workload install --force.
func workload update [<ID>] [options]
Vysílejte a <ID> aktualizujte jednu pracovní zátěž, nebo --all každou nainstalovanou zátěž. Specifikujte přesně jednu z těchto dvou možností.
| Možnost | Popis |
|---|---|
--version, -v |
Nainstalovaná verze k výměně. Výchozí: nejvýše nainstalovaná verze. |
--all |
Aktualizujte každou nainstalovanou zátěž. Vzájemně se vylučuje s <ID>. |
--major |
Povolte překročení hranice durové verze. Výchozí nastavení: pouze stejný obor. |
--source |
Katalogová zdrojová URL nebo lokální adresář pro vyřešení. Výchozí: konfigurovaný katalog. |
--prerelease |
Při vyřešení z katalogu povolte předběžné verze. Výchozí: zapnuto, zatímco pracovní zátěže jsou v náhledu. |
--exact, -e |
Vypněte shodu aliasů.
<ID> musí být doslovné ID balíčku. |
func workload uninstall
Odstraní jednu nebo všechny nainstalované verze pracovní zátěže.
func workload uninstall <ID> [options]
| Možnost | Popis |
|---|---|
--version, -v |
Konkrétní verze k odinstalaci. Výchozí: jediná instalovaná verze. |
--all-versions, -a |
Odinstalujte všechny nainstalované verze zátěže. Vzájemně se vylučuje s --version. |
--exact, -e |
Vypněte shodu aliasů.
<ID> musí být doslovné ID balíčku. |
func workload prune
Odstraňuje neaktivní instalace zátěže vedle sebe. Pro každý ID balíčku v rámci rozsahu příkaz ponechá nejvýše nainstalovanou verzi a odinstaluje starší verze. Tento příkaz je pouze lokální a nikdy se nedotýká katalogu.
func workload prune [<ID>] [options]
Když vynecháte <ID>, příkaz ořeže každou nainstalovanou pracovní zátěž.
| Možnost | Popis |
|---|---|
--exact, -e |
Vypněte shodu aliasů.
<ID> musí být doslovné ID balíčku. |
func azure functionapp
Kontext func azure functionapp obsahuje následující příkazy:
func azure functionapp fetch-app-settingsfunc azure functionapp list-functionsfunc azure functionapp logstreamfunc 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.
Příkaz stáhne nastavení do local.settings.json souboru pro projekt. Hodnoty na obrazovce jsou maskované pro zabezpečení. Nastavení v local.settings.json souboru můžete chránit povolením lokální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 Aplikace Azure 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í:
| 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/publishzá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. |
func azure storage fetch-connection-string
Získá připojovací řetězec pro zadaný účet Azure Storage.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Další informace najdete v tématu download a storage připojovací řetězec.
func azurecontainerapps deploy
Nasadí kontejnerizovanou aplikaci funkcí do Azure Container Apps prostředí. Výchozí účet hostitelského úložiště, funkční aplikace a prostředí musí již 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, powershella 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í) Previewa 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 připojovací řetězec úložiště, které se má použít. |
--task-hub-name |
Název centra úloh Durable, které se má použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable get-history
Vrátí historii zadané instance orchestrace.
func durable get-history --id <INSTANCE_ID>
Příkaz func durable get-history podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--id |
ID instance orchestrace. (Požadováno) |
--connection-string-setting |
Název nastavení, které má připojovací řetězec úložiště, které se má použít. |
--task-hub-name |
Název centra úloh Durable, které se má použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable get-instances
Vrátí stav všech instancí orchestrace. Tento příkaz podporuje stránkování pomocí parametru top .
func durable get-instances
Příkaz func durable get-instances podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--continuation-token |
Token označující konkrétní stránku nebo oddíl požadavků, které se mají vrátit. |
--connection-string-setting |
Název nastavení aplikace, které obsahuje připojovací řetězec úložiště, které se má použít. |
--created-after |
Získejte instance vytvořené po tomto datu a čase (UTC). Všechny hodnoty datetime ve formátu ISO 8601 jsou přijímány. |
--created-before |
Získejte instance vytvořené před konkrétním datem a časem (UTC). Všechny hodnoty datetime ve formátu ISO 8601 jsou přijímány. |
--runtime-status |
Získejte instance, jejichž stav odpovídá určitému stavu, včetně running, completeda failed. Můžete zadat jeden nebo více stavů oddělených mezerami. |
--top |
Omezte počet záznamů vrácených v daném požadavku. |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable get-runtime-status
Vrátí stav zadané instance orchestrace.
func durable get-runtime-status --id <INSTANCE_ID>
Příkaz func durable get-runtime-status podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--id |
ID instance orchestrace. (Požadováno) |
--show-input |
Při nastavení odpověď zahrnuje vstup funkce. |
--show-output |
Pokud je tato možnost nastavená, odpověď obsahuje historii spuštění. |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable purge-history
Vyprázdní stav instance orchestrace, historii a úložiště objektů blob pro orchestrace starší než zadaná prahová hodnota.
func durable purge-history
Příkaz func durable purge-history podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--created-after |
Odstraňte historii instancí vytvořených po tomto datu a čase (UTC). Všechny hodnoty data a času ve formátu ISO 8601 jsou přijímány. |
--created-before |
Odstraňte historii instancí vytvořených před tímto datem a časem (UTC). Všechny hodnoty data a času ve formátu ISO 8601 jsou přijímány. |
--runtime-status |
Odstraňte historii instancí, jejichž stav odpovídá určitému stavu, včetně completed, terminated, canceleda failed. Zadejte jeden nebo více stavů oddělených mezerami. Pokud nezahrnete --runtime-status, historie instancí se odstraní bez ohledu na stav. |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable raise-event
Vyvolá událost na zadanou instanci orchestrace.
func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>
Příkaz func durable raise-event podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--event-data |
Data, která se mají předat události, buď vložené, nebo ze souboru JSON. U souborů předpona cesty k souboru pomocí znaku at (@), například @path/to/file.json. (Požadováno) |
--event-name |
Název události, která se má vyvolat. (Požadováno) |
--id |
ID instance orchestrace. (Požadováno) |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable rewind
Převinutí zadané instance orchestrace zpět.
func durable rewind --id <INSTANCE_ID> --reason <REASON>
Příkaz func durable rewind podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--id |
ID instance orchestrace. (Požadováno) |
--reason |
Důvod pro převinutí orchestrace zpět. (Požadováno) |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable start-new
Spustí novou instanci zadané funkce orchestrátoru.
func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>
Příkaz func durable start-new podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--function-name |
Název funkce orchestrátoru, která se má spustit. (Požadováno) |
--id |
Určuje ID instance orchestrace. (Požadováno) |
--input |
Vstup do funkce orchestrátoru, buď vložený, nebo ze souboru JSON. U souborů předpona cesty k souboru pomocí ampersandu (@), například @path/to/file.json. (Požadováno) |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func durable terminate
Ukončí zadanou instanci orchestrace.
func durable terminate --id <INSTANCE_ID> --reason <REASON>
Příkaz func durable terminate podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--connection-string-setting |
Název nastavení obsahujícího připojovací řetězec úložiště, které se má použít. |
--id |
Určuje ID instance orchestrace. (Požadováno) |
--reason |
Důvod ukončení orchestrace (Požadováno) |
--task-hub-name |
Název Durable Functions centra úloh, které chcete použít. |
Další informace najdete v dokumentaci k Durable Functions.
func extensions install
Ručně nainstaluje rozšíření Functions do projektu, který není .NET nebo do projektu skriptu jazyka C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
Příkaz func extensions install podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--configPath, -c |
Cesta k adresáři obsahujícího soubor extensions.csproj. |
--csx |
Podpora projektů skriptování jazyka C# (.csx). |
--force, -f |
Aktualizujte verze existujících rozšíření. |
--output, -o |
Výstupní cesta pro rozšíření |
--package, -p |
Identifikátor konkrétního balíčku rozšíření. Pokud není zadáno, nainstalují se všechna odkazovaná rozšíření, stejně jako v func extensions syncpřípadě . |
--source, -s |
Zdroj informačního kanálu NuGet, pokud nepoužíváte NuGet.org. |
--version, -v |
Verze balíčku rozšíření |
Následující příklad nainstaluje v místním projektu verzi 5.0.1 rozšíření Event Hubs:
func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1
Tyto aspekty platí při použití func extensions install:
Pro zkompilované projekty jazyka C# (proces v procesu i izolovaný pracovní proces) použijte místo toho standardní metody instalace balíčku NuGet, například
dotnet add package.Pokud chcete rozšíření nainstalovat ručně pomocí nástrojů Core Tools, musíte mít nainstalovanou sadu .NET SDK.
Pokud je to možné, měli byste místo toho použít sady rozšíření. Tady je několik důvodů, proč možná budete muset nainstalovat rozšíření ručně:
- Potřebujete získat přístup ke konkrétní verzi rozšíření, která není v sadě k dispozici.
- V sadě potřebujete získat přístup k vlastnímu rozšíření, které není k dispozici.
- Potřebujete získat přístup ke konkrétní kombinaci rozšíření, která nejsou k dispozici v jedné sadě.
Než budete moct ručně nainstalovat rozšíření, musíte nejprve odebrat
extensionBundleobjekt ze souboruhost.json , který sadu definuje. Není provedena žádná akce, pokud je sada rozšíření již nastavena v souboruhost.json .Při první instalaci rozšíření se do kořenového adresáře projektu přidá soubor projektu .NET s názvem extensions.csproj. Tento soubor definuje sadu balíčků NuGet vyžadovaných vašimi funkcemi. I když můžete pracovat s odkazy na balíčky NuGet v tomto souboru, nástroje Core Tools umožňují instalovat rozšíření, aniž byste museli ručně upravovat tento soubor projektu C#.
func extensions sync
Nainstaluje všechna rozšíření potřebná vaší funkční aplikací.
Příkaz func extensions sync podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--configPath, -c |
Cesta k adresáři obsahujícímu soubor.extensions.csproj |
--csx |
Podporuje skriptování projektů jazyka C# (.csx). |
--output, -o |
Výstupní cesta pro rozšíření |
Obnoví chybějící extensions.csproj soubor. Neprovádí žádnou akci, když je host.json ve vašem souboru definován balíček rozšíření.
func kubernetes deploy
Nasadí projekt Functions jako vlastní kontejner Dockeru do clusteru Kubernetes.
func kubernetes deploy
Tento příkaz sestaví projekt jako vlastní kontejner a publikuje ho do clusteru Kubernetes. Vlastní kontejnery musí mít soubor Dockerfile. Pokud chcete vytvořit aplikaci se souborem Dockerfile, použijte tuto --docker možnost s příkazem func init .
Příkaz func kubernetes deploy podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--dry-run |
Zobrazí šablonu nasazení bez spuštění. |
--config-map-name |
Název existující mapy konfigurace s nastavením aplikace funkcí , která se má použít v nasazení Vyžaduje --use-config-map. Výchozím chováním je vytvoření nastavení na základě objektu Values v souborulocal.settings.json . |
--cooldown-period |
Období obnovení (v sekundách) po všech aktivačních událostech už není aktivní, než se nasazení škáluje zpět na nulu, přičemž výchozí hodnota je 300 s. |
--ignore-errors |
Pokračujte v nasazení poté, co prostředek vrátí chybu. Výchozí chování je zastavit chybu. |
--image-name |
Název image, která se má použít pro nasazení podu a ze které se mají číst funkce. |
--keda-version |
Nastavte verzi KEDA, která se má nainstalovat. Platné možnosti jsou: v1 a v2 (výchozí). |
--keys-secret-name |
Název kolekce tajných kódů Kubernetes, který se má použít k ukládání přístupových klíčů. |
--max-replicas |
Nastavte maximální počet replik, na který se horizontální automatické škálování podů (HPA) škáluje. |
--min-replicas |
Nastavte minimální počet replik, pod kterým se HPA nebude škálovat. |
--mount-funckeys-as-containervolume |
Připojte přístupové klíče jako svazek kontejneru. |
--name |
Název použitý pro nasazení a další artefakty v Kubernetes. |
--namespace |
Nastavte obor názvů Kubernetes, na který se má nasadit. Ve výchozím nastavení se nastaví výchozí obor názvů. |
--no-docker |
Funkce můžete číst z aktuálního adresáře místo z obrázku. Vyžaduje připojení systému souborů image. |
--registry |
Při nastavení se spustí sestavení Dockeru a image se odešle do registru tohoto názvu. Nemůžete použít --registry s --image-name. Pro Docker použijte své uživatelské jméno. |
--polling-interval |
Interval dotazování (v sekundách) pro kontrolu triggerů mimo PROTOKOL HTTP s výchozím nastavením 30s. |
--pull-secret |
Tajný klíč používaný pro přístup k přihlašovacím údajům privátního registru. |
--secret-name |
Název existující kolekce tajných kódů Kubernetes, která má nastavení aplikace funkcí pro použití v nasazení. Výchozím chováním je vytvoření nastavení na základě objektu Values v souborulocal.settings.json . |
--show-service-fqdn |
Místo výchozího chování použití IP adresy zobrazte adresy URL triggerů HTTP s plně kvalifikovaným názvem domény Kubernetes. |
--service-type |
Nastavte typ služby Kubernetes Service. Podporované hodnoty jsou: ClusterIP, NodePorta LoadBalancer (výchozí). |
--use-config-map |
ConfigMap Ke konfiguraci Secret aplikace funkcí použijte objekt (v1) místo objektu (v1). Název mapy je nastaven pomocí --config-map-name. |
--use-git-hash-version |
Jako verzi image kontejneru použijte hodnotu hash Gitu. |
--write-configs |
Vypíšete konfigurace Kubernetes jako soubory YAML místo nasazení. |
--config-file |
Výstupní cesta k souboru při použití --write-configs. Výchozí: functions.yaml. |
--hash-files |
Soubory, které mají hodnotu hash určit verzi image. |
--image-build |
Pokud je falsetato možnost nastavená, přeskočí sestavení Dockeru. |
--key-secret-annotations |
Poznámky pro přidání do tajného kódu klíčů ve key1=val1,key2=val2 formátu |
Nástroje Core Tools používají místní rozhraní příkazového řádku Dockeru k sestavení a publikování image. Ujistěte se, že je Docker už nainstalovaný místně. Spuštěním docker login příkazu se připojte ke svému účtu.
Azure Functions podporuje hostování kontejnerizovaných funkcí v Azure Container Apps nebo v Azure Functions. Azure Functions oficiálně nepodporuje spouštění kontejnerů přímo v clusteru Kubernetes nebo v Azure Kubernetes Service (AKS). Další informace najdete v tématu Podpora kontejneruLinux v Azure Functions.
func kubernetes delete
Odstraní nasazení služby Functions z clusteru Kubernetes.
func kubernetes delete --name <APP_NAME>
Příkaz func kubernetes delete podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--name |
Název nasazení a dalších artefaktů v Kubernetes (Požadováno) |
--namespace |
Nastavte obor názvů Kubernetes. Výchozí hodnota je obor default názvů. |
--registry |
Název registru kontejneru. |
--image-name |
Image, která se má použít pro nasazení podu. |
--keda-version |
Nastavte verzi KEDA. Platné možnosti jsou v1 a v2 (výchozí). |
func kubernetes install
Nainstaluje KEDA v clusteru Kubernetes.
func kubernetes install
Nainstaluje KEDA do clusteru definovaného v konfiguračním souboru kubectl.
Příkaz func kubernetes install podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--dry-run |
Zobrazí šablonu nasazení bez spuštění. |
--keda-version |
Nastaví verzi KEDA, která se má nainstalovat. Platné možnosti jsou: v1 a v2 (výchozí). |
--namespace |
Nainstaluje se do konkrétního oboru názvů Kubernetes. Pokud není nastavený, použije se výchozí obor názvů. |
Další informace najdete v tématu Správa KEDA a funkcí v Kubernetes.
func kubernetes remove
Odebere KEDA z clusteru Kubernetes definovaného v konfiguračním kubectl souboru.
func kubernetes remove
Odebere KEDA z clusteru definovaného v konfiguračním kubectl souboru.
Příkaz func kubernetes remove podporuje tuto možnost:
| Možnost | Popis |
|---|---|
--namespace |
Odinstaluje se z konkrétního oboru názvů Kubernetes. Pokud není nastavený, použije se výchozí obor názvů. |
Další informace najdete v tématu Odinstalace KEDA z Kubernetes.
func settings add
Přidá nové nastavení do Values kolekce v souboru local.settings.json.
func settings add <SETTING_NAME> <VALUE>
Nahraďte <SETTING_NAME> názvem nastavení aplikace.
Příkaz func settings add podporuje tuto možnost:
| Možnost | Popis |
|---|---|
--connectionString |
Přidá dvojici name-value do ConnectionStrings kolekce místo Values kolekce. Kolekci ConnectionStrings používejte pouze v případech, kdy je vyžadují určité architektury. Další informace najdete v local.settings.json souboru. |
func settings decrypt
Dešifruje šifrované hodnoty v Values kolekci v souboru local.settings.json .
func settings decrypt
Tento příkaz také dešifruje připojovací řetězec hodnoty v kolekci ConnectionStrings. V local.settings.json, příkaz nastaví IsEncrypted na .false Šifrujte lokální nastavení, abyste snížili riziko odhalení citlivých informací zlocal.settings.json. V Azure jsou nastavení aplikace vždy uložena zašifrovaná.
func settings delete
Odebere existující nastavení z Values kolekce v souboru local.settings.json.
func settings delete <SETTING_NAME>
Nahraďte <SETTING_NAME> názvem nastavení aplikace a <VALUE> hodnotou nastavení.
Příkaz func settings delete podporuje tuto možnost:
| Možnost | Popis |
|---|---|
--connectionString |
Odebere dvojici name-value z ConnectionStrings kolekce místo Values kolekce. |
func settings encrypt
Zašifruje hodnoty jednotlivých položek v Values kolekci v souboru local.settings.json.
func settings encrypt
Příkaz také šifruje hodnoty připojovacího řetězce v kolekci ConnectionStrings . V local.settings.json, příkaz nastaví IsEncrypted na true, což určuje, že lokální runtime dešifruje nastavení před jejich použitím. Šifrujte lokální nastavení, abyste snížili riziko odhalení citlivých informací zlocal.settings.json. V Azure jsou nastavení aplikace vždy uložena jako zašifrovaná.
func settings list
Vypíše seznam nastavení v Values kolekci v souboru local.settings.json.
func settings list
Výstup obsahuje také připojovací řetězce z ConnectionStrings kolekce. Ve výchozím nastavení příkaz maskuje hodnoty pro bezpečnost.
--showValue Pomocí možnosti zobrazíte skutečnou hodnotu.
Příkaz func settings list podporuje tuto možnost:
| Možnost | Popis |
|---|---|
--showValue, -a |
Zobrazení skutečných nemaskovaných hodnot ve výstupu |
func templates list
Zobrazí seznam dostupných šablon funkce (triggeru).
Příkaz func templates list podporuje tuto možnost:
| Možnost | Popis |
|---|---|
--language, -l |
Jazyk, pro který se mají filtrovat vrácené šablony. Vrátí ve výchozím nastavení všechny jazyky. |
Globální možnosti
Většina příkazů Core Tools podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--script-root |
Nastaví kořenový adresář aplikace funkcí a změní pracovní adresář příkazu. |
--verbose |
Povolí podrobný výstup pro podrobné protokolování. Ne všechny příkazy tuto možnost podporují. |
--offline |
Běží v offline režimu bez volání externí sítě. Příkazy func start, func init, a func new podporují tuto možnost. Můžete to také nastavit pomocí proměnné FUNCTIONS_CORE_TOOLS_OFFLINE prostředí. |
--version, -v |
Zobrazí verzi nástrojů Azure Functions Core Tools. |
--help, -h |
Zobrazí informace nápovědy. |
--pause-on-error |
Před ukončením procesu pozastaví další vstup. Tato možnost je užitečná, když spouštíte Core Tools z integrovaného vývojového prostředí (IDE). |
Většina příkazů podporuje tyto možnosti:
| Možnost | Popis |
|---|---|
--help, -h |
Zobrazit nápovědu k příkazu. |
--version |
Zobrazit verzi Azure Functions CLI. Používejte --verbose společně --version s podrobnými informacemi o stavbě. |
--verbose |
Povolte podrobný výstup. Šíří se ke všem podpříkazům. Když je předán v kořeni bez podpříkazu, vytiskne podrobné informace o buildu, runtime, OS a architektuře. |
Dostupné pracovní zátěže
Běžte func workload search si prohlédnout aktuální katalog. K dispozici jsou následující pracovní zátěže:
| Name | Popis |
|---|---|
host |
Azure Functions hostitelské runtime používané func run. |
bundles |
Nainstalujte balíčky rozšíření, které umožňují všechna vazby rozšíření. Použijte tuto pracovní zátěž pro jakýkoli ne-.NET stack. .NET projekty tuto zátěž nevyužívají. Místo toho se na rozšíření přímo odkazují ve svých projektech. |
dotnet |
Azure Functions CLI tooling for .NET (C#, F#) projekty. Také přispívá šablonami pro func quickstart. .NET nevyžaduje samostatnou pracovní zátěž, protože pracovník je součástí samotného kompilovaného projektu. |
dotnet-templates |
Šablony funkčního lešení pro .NET izolované pracovní projekty. |
python |
Azure Functions CLI tooling for Python projects. Také přispívá šablonami pro func quickstart. |
python-worker |
Jazykový worker Python používaný hostitelem Functions. |
python-templates |
Šablony funkčního lešení pro Python (modely programování v1 a v2). |
node |
Azure Functions CLI nástroje pro Node.js projekty (JavaScript, TypeScript). Také přispívá šablonami pro func quickstart. |
node-worker |
Node.js jazykový pracovník používaný hostitelem Functions. |
node-templates |
Šablony funkčního lešení pro Node.js (JavaScript, TypeScript). |
go |
Azure Functions CLI tooling for Go projects. Také přispívá šablonami pro func quickstart. |
go-worker |
Jazykový pracovník Go používaný hostitelem Functions. |
Poznámka:
Ne všechny jazykové zásobníky Functions jsou v současnosti dostupné jako pracovní zátěže. Java a PowerShell stacky nejsou v současnosti podporovány v Azure Functions CLI.