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

  • Článek

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

Při dokončení tohoto rychlého zprovoznění vzniknou ve vašem účtu Azure náklady ve výši několika centů USD (nebo menší).

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í:

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.

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. Spuštěním func init následujícího příkazu vytvořte projekt funkcí ve složce s názvem LocalFunctionProj se zadaným modulem runtime:

    func init LocalFunctionProj --powershell

  2. Přejděte do složky projektu:

    cd LocalFunctionProj

    Tato složka obsahuje různé soubory projektu, včetně konfiguračních souborů s názvem local.settings.json a host.json. Vzhledem k tomu, ž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 .

  3. 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.

run.ps1

run.ps1 definuje skript funkce, který se aktivuje podle konfigurace ve function.json.

using namespace System.Net

# Input bindings are passed in via param block.
param($Request, $TriggerMetadata)

# Write to the Azure Functions log stream.
Write-Host "PowerShell HTTP trigger function processed a request."

# Interact with query parameters or the body of the request.
$name = $Request.Query.Name
if (-not $name) {
    $name = $Request.Body.Name
}

$body = "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."

if ($name) {
    $body = "Hello, $name. This HTTP triggered function executed successfully."
}

# Associate values to output bindings by calling 'Push-OutputBinding'.
Push-OutputBinding -Name Response -Value ([HttpResponseContext]@{
    StatusCode = [HttpStatusCode]::OK
    Body = $body
})

U triggeru HTTP funkce přijímá data požadavku předaná do parametru definovaného $Request ve function.json. Návratový objekt definovaný jako Response ve function.json se předá rutině Push-OutputBinding jako 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": "Request",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "Response"
    }
  ]
}

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.

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 .

    func start

    Na konci výstupu se musí zobrazit následující řádky:

    Screenshot of terminal window output when running function locally.

    Poznámka:

    Pokud se httpExample nezobrazí, jak je znázorněno výše, pravděpodobně jste hostitele spustili 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 funkce HTTP z tohoto výstupu do prohlížeče a připojte řetězec ?name=<YOUR_NAME>dotazu, čímž se úplná adresa URL podobá http://localhost:7071/api/HttpExample?name=Functions. Prohlížeč by měl zobrazit zprávu s odpovědí, která vrací hodnotu řetězce dotazu. 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 hotovi, stiskněte Ctrl+C a stisknutím y kláves Ctrl+C 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 powershell --functions-version 4 --name <APP_NAME> --storage-account <STORAGE_NAME>

    Příkaz az functionapp create vytvoří aplikaci funkcí v Azure.

    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é zřídí přidruženou instanci Aplikace Azure Přehledy 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

Po úspěšném vytvoření aplikace funkcí v Azure jste teď připraveni nasadit místní projekt funkcí pomocí příkazu func azure functionapp publish .

V následujícím příkladu nahraďte <APP_NAME> názvem vaší aplikace.

func azure functionapp publish <APP_NAME>

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

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.

The output of the function run on Azure in a browser

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í do fronty služby Azure Storage