Sdílet prostřednictvím

Rychlý start: Vytvoření funkce TypeScript v Azure z příkazového řádku

  • Článek

V tomto článku pomocí nástrojů příkazového řádku vytvoříte funkci TypeScript, která reaguje na požadavky HTTP. Po místním otestování kód nasadíte do bezserverového prostředí Azure Functions.

Důležité

Obsah tohoto článku se změní na základě vašeho výběru programovacího modelu Node.js v selektoru v horní části stránky. Model v4 je obecně dostupný a je navržený tak, aby měl flexibilnější a intuitivnější prostředí pro vývojáře v JavaScriptu a TypeScriptu. Další informace o rozdílech mezi v3 a v4 najdete v průvodci migrací.

Dokončení tohoto rychlého startu způsobuje malé náklady na několik centů USD nebo méně ve vašem účtu Azure.

K dispozici je také verze tohoto článku založená na editoru Visual Studio Code.

Konfigurace místního prostředí

Než začnete, musíte mít následující požadavky:

  • Účet Azure s aktivním předplatným. Vytvoření účtu zdarma

  • Jeden z následujících nástrojů pro vytváření prostředků Azure:

    • Azure CLI verze 2.4 nebo novější

    • Modul Azure Az PowerShell verze 5.9.0 nebo novější.

  • Node.js verze 14 nebo vyšší.

  • Node.js verze 18 nebo novější.

  • TypeScript verze 4 nebo novější.

Instalace nástrojů Azure Functions Core

Doporučený způsob instalace nástrojů Core Tools závisí na operačním systému místního vývojového počítače.

Následující kroky používají instalační službu systému Windows (MSI) k instalaci nástrojů Core Tools verze 4.x. Další informace o dalších instalačních programech založených na balíčcích najdete v souboru readme nástroje Core Tools.

Stáhněte a spusťte instalační program Core Tools na základě vaší verze Windows:

Pokud jste dříve použili instalační službu systému Windows (MSI) k instalaci nástrojů Core Tools ve Windows, měli byste před instalací nejnovější verze odinstalovat starou verzi z nástroje Přidat odebrat programy.

  • Ujistěte se, že jste nainstalovali verzi v4.0.5382 nástrojů Core Tools nebo novější verzi.

Vytvoření místního projektu funkce

Ve službě Azure Functions je projekt funkcí kontejnerem pro jednu nebo více jednotlivých funkcí, které každá reaguje na konkrétní trigger. Všechny funkce v projektu sdílejí stejné místní a hostitelské konfigurace. V této části vytvoříte projekt funkce, který obsahuje jednu funkci.

  1. V vhodné složce spusťte func init příkaz následujícím způsobem a vytvořte v aktuální složce projekt TypeScriptu Node.js v3:

    func init --typescript --model V3

    Tato složka teď obsahuje různé soubory projektu, včetně konfiguračních souborů s názvem local.settings.json a host.json. Protože local.settings.json může obsahovat tajné kódy stažené z Azure, soubor je ve výchozím nastavení vyloučen ze správy zdrojového kódu v souboru .gitignore .

  2. Přidejte do projektu funkci pomocí následujícího příkazu, kde --name argument je jedinečný název funkce (HttpExample) a --template argument určuje trigger funkce (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"

    func new vytvoří podsložku odpovídající názvu funkce, která obsahuje soubor kódu odpovídající zvolenému jazyku projektu a konfiguračnímu souboru s názvem function.json.

(Volitelné) Prozkoumání obsahu souboru

V případě potřeby můžete funkci spustit místně a později obsah souboru prozkoumat.

index.ts

index.ts exportuje funkci aktivovanou podle konfigurace v function.json.

import { AzureFunction, Context, HttpRequest } from "@azure/functions"

const httpTrigger: AzureFunction = async function (context: Context, req: HttpRequest): Promise<void> {
    context.log('HTTP trigger function processed a request.');
    const name = (req.query.name || (req.body && req.body.name));
    const responseMessage = name
        ? "Hello, " + name + ". This HTTP triggered function executed successfully."
        : "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response.";

    context.res = {
        // status: 200, /* Defaults to 200 */
        body: responseMessage
    };

};

export default httpTrigger;

U triggeru HTTP funkce přijímá data požadavku v proměnné req typu HttpRequest , jak je definováno v function.json. Návratový objekt definovaný jako $return v function.json je odpověď.

function.json

function.json je konfigurační soubor, který definuje vstup a výstup bindings funkce, včetně typu triggeru.

{
    "bindings": [
        {
            "authLevel": "function",
            "type": "httpTrigger",
            "direction": "in",
            "name": "req",
            "methods": [
                "get",
                "post"
            ]
        },
        {
            "type": "http",
            "direction": "out",
            "name": "res"
        }
    ]
}

Každá vazba vyžaduje směr, typ a jedinečný název. Trigger HTTP má vstupní vazbu typu httpTrigger a výstupní vazby typu http.

  1. V vhodné složce spusťte func init příkaz následujícím způsobem a vytvořte v aktuální složce projekt TypeScriptu Node.js v4:

    func init --typescript

    Tato složka teď obsahuje různé soubory projektu, včetně konfiguračních souborů s názvem local.settings.json a host.json. Protože local.settings.json může obsahovat tajné kódy stažené z Azure, soubor je ve výchozím nastavení vyloučen ze správy zdrojového kódu v souboru .gitignore . Požadované balíčky npm jsou také nainstalovány v node_modules.

  2. Přidejte do projektu funkci pomocí následujícího příkazu, kde --name argument je jedinečný název funkce (HttpExample) a --template argument určuje trigger funkce (HTTP).

    func new --name HttpExample --template "HTTP trigger" --authlevel "anonymous"

    func new vytvoří soubor s názvem HttpExample.ts v adresáři src/functions , který obsahuje kód vaší funkce.

  3. Do local.settings.json přidejte informace o připojení ke službě Azure Storage.

    {
    "Values": {       
        "AzureWebJobsStorage": "<Azure Storage connection information>",
        "FUNCTIONS_WORKER_RUNTIME": "node"
    }
}

  4. (Volitelné) Pokud chcete získat další informace o konkrétní funkci, například trigger HTTP, můžete spustit následující příkaz:

    func help httptrigger

Místní spuštění funkce

  1. Spusťte funkci spuštěním místního hostitele modulu runtime Azure Functions ze složky LocalFunctionProj :

    npm install
npm start

    npm start

    Na konci výstupu by se měly zobrazit následující protokoly:

    Snímek obrazovky s výstupem okna terminálu při místním spuštění funkce

    Poznámka:

    Pokud se httpExample nezobrazí, jak je znázorněno v protokolech, pravděpodobně jste spustili hostitele mimo kořenovou složku projektu. V takovém případě pomocí ctrl+c zastavte hostitele, přejděte do kořenové složky projektu a spusťte předchozí příkaz znovu.

  2. Zkopírujte adresu URL vaší HttpExample funkce z tohoto výstupu do prohlížeče a připojte řetězec ?name=<your-name>dotazu a vytvořte úplnou adresu URL jako http://localhost:7071/api/HttpExample?name=Functions. V prohlížeči by se měla zobrazit zpráva podobná Hello Functions:

    Výsledek spuštění funkce místně v prohlížeči

    V terminálu, ve kterém jste spustili projekt, se při provádění požadavků zobrazuje také výstup protokolu.

  3. Až budete připraveni, stiskněte Ctrl+c a stisknutím klávesy y zastavte hostitele funkcí.

Vytvoření podpůrných prostředků Azure pro vaši funkci

Než budete moct nasadit kód funkce do Azure, musíte vytvořit tři prostředky:

  • Skupina prostředků, což je logický kontejner pro související prostředky.
  • Účet úložiště, který slouží k udržování stavu a dalších informací o vašich funkcích.
  • Aplikace funkcí, která poskytuje prostředí pro spouštění kódu funkce. Aplikace funkcí se mapuje na místní projekt funkcí a umožňuje seskupit funkce jako logickou jednotku pro snadnější správu, nasazení a sdílení prostředků.

K vytvoření těchto položek použijte následující příkazy. Podporuje se Azure CLI i PowerShell.

  1. Pokud jste to ještě neudělali, přihlaste se k Azure:

    az login

    Příkaz az login vás přihlásí ke svému účtu Azure.

  2. Vytvořte skupinu prostředků s názvem AzureFunctionsQuickstart-rg ve zvolené oblasti:

    az group create --name AzureFunctionsQuickstart-rg --location <REGION>

    Příkaz az group create vytvoří skupinu prostředků. Ve výše uvedeném příkazu nahraďte <REGION> oblastí blízko vás pomocí dostupného kódu oblasti vráceného z příkazu az account list-locations .

  3. Ve skupině prostředků a oblasti vytvořte účet úložiště pro obecné účely:

    az storage account create --name <STORAGE_NAME> --location <REGION> --resource-group AzureFunctionsQuickstart-rg --sku Standard_LRS --allow-blob-public-access false

    Příkaz az storage account create vytvoří účet úložiště.

    V předchozím příkladu nahraďte <STORAGE_NAME> názvem, který je pro vás a jedinečný v Azure Storage. Názvy musí obsahovat jenom číslice se třemi až 24 znaky a malými písmeny. Standard_LRS určuje účet pro obecné účely, který služba Functions podporuje.

Důležité

Účet úložiště slouží k ukládání důležitých dat aplikace, někdy včetně samotného kódu aplikace. Přístup z jiných aplikací a uživatelů byste měli omezit na účet úložiště.

  1. Vytvoření aplikace funkcí v Azure:

    az functionapp create --resource-group AzureFunctionsQuickstart-rg --consumption-plan-location <REGION> --runtime node --runtime-version 18 --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>

    Příkaz az functionapp create vytvoří aplikaci funkcí v Azure. Doporučujeme používat nejnovější verzi Node.js, která je aktuálně 18. Verzi můžete zadat nastavením --runtime-version na 18hodnotu .

    V předchozím příkladu nahraďte <STORAGE_NAME> názvem účtu, který jste použili v předchozím kroku, a nahraďte <APP_NAME> globálně jedinečným názvem, který je pro vás vhodný. <APP_NAME> je také výchozí doména DNS pro aplikaci funkcí.

    Tento příkaz vytvoří aplikaci funkcí spuštěnou v zadaném modulu runtime jazyka v rámci plánu Consumption služby Azure Functions, která je bezplatná pro množství využití, které se zde účtují. Příkaz také vytvoří přidruženou instanci Aplikace Azure lication Insights ve stejné skupině prostředků, pomocí které můžete monitorovat aplikaci funkcí a zobrazit protokoly. Další informace najdete v tématu Monitorování azure Functions. Instance se neúčtují žádné náklady, dokud ji neaktivujete.

Nasazení projektu funkce do Azure

Před nasazením projektu do Azure pomocí nástrojů Core Tools vytvoříte z zdrojových souborů TypeScriptu sestavení javascriptových souborů připravené pro produkční prostředí.

  1. Pomocí následujícího příkazu připravte projekt TypeScriptu pro nasazení:

    npm run build

  2. S potřebnými prostředky jste teď připraveni nasadit projekt místních funkcí do aplikace funkcí v Azure pomocí příkazu publikovat . V následujícím příkladu nahraďte <APP_NAME> názvem vaší aplikace.

    func azure functionapp publish <APP_NAME>

    Pokud se zobrazí chyba "Nejde najít aplikaci s názvem...", počkejte několik sekund a zkuste to znovu, protože Azure pravděpodobně aplikaci po předchozím az functionapp create příkazu plně inicializovala.

    Příkaz publish zobrazí výsledky podobné následujícímu výstupu (zkráceně kvůli jednoduchosti):

     ...

 Getting site publishing info...
 Creating archive for current directory...
 Performing remote build for functions project.

 ...

 Deployment successful.
 Remote build succeeded!
 Syncing triggers...
 Functions in msdocs-azurefunctions-qs:
     HttpExample - [httpTrigger]
         Invoke url: https://msdocs-azurefunctions-qs.azurewebsites.net/api/httpexample?code=KYHrydo4GFe9y0000000qRgRJ8NdLFKpkakGJQfC3izYVidzzDN4gQ==

Vyvolání funkce v Azure

Vzhledem k tomu, že vaše funkce používá trigger HTTP, vyvoláte ji tak, že v prohlížeči nebo pomocí nástroje, jako je curl, vytvoří požadavek HTTP na jeho adresu URL.

Zkopírujte úplnou adresu URL vyvolání zobrazené ve výstupu příkazu publish do adresního řádku prohlížeče a připojte parametr ?name=Functionsdotazu . Prohlížeč by měl zobrazit podobný výstup jako při místním spuštění funkce.

Výstup funkce spuštěné v Azure v prohlížeči

Spuštěním následujícího příkazu zobrazte protokoly streamování téměř v reálném čase:

func azure functionapp logstream <APP_NAME>

V samostatném okně terminálu nebo v prohlížeči znovu volejte vzdálenou funkci. Podrobný protokol spuštění funkce v Azure se zobrazí v terminálu.

Vyčištění prostředků

Pokud budete pokračovat k dalšímu kroku a přidáte výstupní vazbu fronty Azure Storage, ponechte všechny prostředky na místě, protože budete vycházet z toho, co jste už udělali.

Jinak pomocí následujícího příkazu odstraňte skupinu prostředků a všechny její obsažené prostředky, abyste se vyhnuli dalším nákladům.

az group delete --name AzureFunctionsQuickstart-rg

Další kroky

Připojení k frontě služby Azure Storage