Utveckla Azure Functions lokalt med core tools

Med Azure Functions Core Tools kan du utveckla och testa dina funktioner på den lokala datorn. När du är klar kan du också använda Core Tools för att distribuera kodprojektet till Azure och arbeta med programinställningar.

Installera Azure Functions Core Tools

Det rekommenderade sättet att installera Core Tools beror på operativsystemet på din lokala utvecklingsdator.

Hjälp med versionsrelaterade problem finns i Core Tools-versioner.

Skapa ditt lokala projekt

I terminalfönstret eller från en kommandotolk kör du följande kommando för att skapa ett projekt i MyProjFolder mappen:

func init MyProjFolder --worker-runtime dotnet-isolated 

func init MyProjFolder --worker-runtime dotnet 

func init MyProjFolder --worker-runtime javascript --model V4

func init MyProjFolder --worker-runtime javascript --model V3

func init MyProjFolder --worker-runtime typescript --model V4

func init MyProjFolder --worker-runtime typescript --model V3

func init MyProjFolder --worker-runtime powershell

func init MyProjFolder --worker-runtime python --model V2

func init MyProjFolder --worker-runtime python

När du kör func init utan --worker-runtime alternativet uppmanas du att välja projektspråk. Mer information om tillgängliga alternativ för func init kommandot finns i referensen func init .

Skapa en funktion

Om du vill lägga till en funktion i projektet kör func new du kommandot med hjälp av --template alternativet för att välja utlösarmallen. I följande exempel skapas en HTTP-utlösare med namnet MyHttpTrigger:

func new --template "Http Trigger" --name MyHttpTrigger

I det här exemplet skapas en Queue Storage-utlösare med namnet MyQueueTrigger:

func new --template "Azure Queue Storage Trigger" --name MyQueueTrigger

Följande överväganden gäller när du lägger till funktioner:

• När du kör func new utan --template alternativet uppmanas du att välja en mall.

• func templates list Använd kommandot för att se den fullständiga listan över tillgängliga mallar för ditt språk.

• När du lägger till en utlösare som ansluter till en tjänst måste du också lägga till en programinställning som refererar till en niska veze eller en hanterad identitet i local.settings.json-filen. Om du använder appinställningar på det här sättet kan du inte behöva bädda in autentiseringsuppgifter i koden. Mer information finns i Arbeta med appinställningar lokalt.

Mer information om tillgängliga alternativ för func new kommandot finns i referensen func new .

Lägga till en bindning till din funktion

Functions tillhandahåller en uppsättning tjänstspecifika in- och utdatabindningar, vilket gör det enklare för funktionen att ansluta till andra Azure-tjänster utan att behöva använda tjänstspecifika klient-SDK:er. Mer information finns i Utlösare och bindningar i Azure Functions.

Om du vill lägga till en indata- eller utdatabindning till en befintlig funktion måste du uppdatera funktionsdefinitionen manuellt.

I följande exempel visas funktionsdefinitionen när du har lagt till en utdatabindning för queue storage till en HTTP-utlöst funktion:

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequest req,
    FunctionContext executionContext)
{

public class MultiResponse
{
    [QueueOutput("outqueue",Connection = "AzureWebJobsStorage")]
    public string[] Messages { get; set; }
    public IActionResult HttpResponse { get; set; }
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
    [Queue("outqueue"),StorageAccount("AzureWebJobsStorage")] ICollector<string> msg, 
    ILogger log)

@FunctionName("HttpExample")
public HttpResponseMessage run(
        @HttpTrigger(name = "req", methods = {HttpMethod.GET, HttpMethod.POST}, authLevel = AuthorizationLevel.ANONYMOUS) 
        HttpRequestMessage<Optional<String>> request, 
        @QueueOutput(name = "msg", queueName = "outqueue", 
        connection = "AzureWebJobsStorage") OutputBinding<String> msg, 
        final ExecutionContext context) {

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

$outputMsg = $name
Push-OutputBinding -name msg -Value $outputMsg

@app.route(route="HttpExample")
@app.queue_output(arg_name="msg", queue_name="outqueue", connection="AzureWebJobsStorage")
def HttpExample(req: func.HttpRequest, msg: func.Out [func.QueueMessage]) -> func.HttpResponse:
    logging.info('Python HTTP trigger function processed a request.')

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

{
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": ["get", "post"]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "res"
    },
    {
      "type": "queue",
      "direction": "out",
      "name": "msg",
      "queueName": "outqueue",
      "connection": "AzureWebJobsStorage"
    }
  ]
}

Följande överväganden gäller när du lägger till bindningar i en funktion:

• När du lägger till bindningar som ansluter till en tjänst måste du också lägga till en programinställning som refererar till en niska veze eller hanterad identitet i local.settings.json-filen. Mer information finns i Arbeta med appinställningar lokalt.

Starta Functions-körningen

Innan du kan köra eller felsöka funktionerna i projektet måste du starta Functions-värden från rotkatalogen i projektet. Värden aktiverar utlösare för alla funktioner i projektet. Använd det här kommandot för att starta den lokala körningen:

mvn clean package 
mvn azure-functions:run

func start

npm install
npm start     

När Functions-värden startar matar den ut en lista över funktioner i projektet, inklusive URL:erna för alla HTTP-utlösta funktioner, som i det här exemplet:

Found the following functions:
Host.Functions.MyHttpTrigger

Job host started
Http Function MyHttpTrigger: http://localhost:7071/api/MyHttpTrigger

Tänk på följande när du kör dina funktioner lokalt:

• Som standard tillämpas inte auktorisering lokalt för HTTP-slutpunkter. Det innebär att alla lokala HTTP-begäranden hanteras som authLevel = "anonymous". Mer information finns i auktoriseringsnivå. Du kan använda alternativet --enableAuth för att kräva auktorisering när du kör lokalt. Mer information finns i func start

• Du kan använda den lokala Azurite-emulatorn när du kör funktioner lokalt som kräver åtkomst till Azure Storage-tjänster (Queue Storage, Blob Storage och Table Storage) utan att behöva ansluta till dessa tjänster i Azure. När du använder lokal emulering måste du starta Azurite innan du startar den lokala värden (func.exe). Mer information finns i Lokal lagringsemulering.

• Du kan utlösa icke-HTTP-funktioner lokalt utan att ansluta till en livetjänst. Mer information finns i Kör en lokal funktion.

• När du inkluderar anslutningsinformationen för Application Insights i local.settings.json filen skrivs lokala loggdata till den specifika Application Insights-instansen. Om du vill hålla lokala telemetridata åtskilda från produktionsdata bör du överväga att använda en separat Application Insights-instans för utveckling och testning.

Köra en lokal funktion

När den lokala Functions-värden (func.exe) körs kan du nu utlösa enskilda funktioner för att köra och felsöka funktionskoden. Hur du kör en enskild funktion beror på dess utlösartyp.

http://localhost:<PORT>/api/<FUNCTION_NAME>

curl --get http://localhost:7071/api/MyHttpTrigger?name=Azure%20Rocks

curl --request POST http://localhost:7071/api/MyHttpTrigger --data '{"name":"Azure Rocks"}'

curl --request POST http://localhost:7071/api/MyHttpTrigger --data "{'name':'Azure Rocks'}"

http://localhost:<PORT>/admin/functions/<FUNCTION_NAME>

{
    "input": "<TRIGGER_INPUT>"
}

curl --request POST -H "Content-Type:application/json" --data '{"input":"sample queue data"}' http://localhost:7071/admin/functions/QueueTrigger

curl --request POST -H "Content-Type:application/json" --data "{'input':'sample queue data'}" http://localhost:7071/admin/functions/QueueTrigger

Publicera till Azure

Azure Functions Core Tools stöder tre typer av distribution:

Du måste ha antingen Azure CLI eller Azure PowerShell installerat lokalt för att kunna publicera till Azure från Core Tools. Som standard använder Core Tools dessa verktyg för att autentisera med ditt Azure-konto.

Om du inte har dessa verktyg installerade måste du i stället hämta en giltig åtkomsttoken som ska användas under distributionen. Du kan visa en åtkomsttoken med hjälp av --access-token alternativet i distributionskommandona.

Distribuera projektfiler

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

Distribuera containrar

Med Core Tools kan du distribuera din containerbaserade funktionsapp till både hanterade Azure Container Apps-miljöer och Kubernetes-kluster som du hanterar.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> [--registry-password] [--registry-server] [--registry-username]

func kubernetes deploy --name <DEPLOYMENT_NAME> --registry <REGISTRY_USERNAME> 

Arbeta med appinställningar lokalt

När du kör i en funktionsapp i Azure lagras de inställningar som krävs av dina funktioner på ett säkert sätt i appinställningarna. Under den lokala utvecklingen läggs de här inställningarna i stället till Values i samlingen i local.settings.json-filen. Filen local.settings.json lagrar även inställningar som används av lokala utvecklingsverktyg.

Objekt i Values samlingen i projektets local.settings.json fil är avsedda att spegla objekt i funktionsappens programinställningar i Azure.

Följande överväganden gäller när du arbetar med filen med lokala inställningar:

• Eftersom local.settings.json kan innehålla hemligheter, till exempel niska veze, bör du aldrig lagra den på en fjärrlagringsplats. Core Tools hjälper dig att kryptera den här filen med lokala inställningar för bättre säkerhet. Mer information finns i Filen Lokala inställningar. Du kan också kryptera local.settings.json-filen för ökad säkerhet.

• Som standard migreras inte lokala inställningar automatiskt när projektet publiceras till Azure. Använd alternativet --publish-local-settings när du publicerar dina projektfiler för att se till att de här inställningarna läggs till i funktionsappen i Azure. Värden i ConnectionStrings avsnittet publiceras aldrig. Du kan också ladda upp inställningar från local.settings.json-filen när som helst.

• Du kan ladda ned och skriva över inställningar i din local.settings.json-fil med inställningar från funktionsappen i Azure. Mer information finns i Ladda ned programinställningar.

• När inget giltigt lagringsutrymme niska veze har angetts för AzureWebJobsStorage och en lokal lagringsemulator inte används visas ett fel. Du kan använda Core Tools för att ladda ned en specifik niska veze från något av dina Azure Storage-konton.

Ladda ned programinställningar

Från projektroten använder du följande kommando för att ladda ned alla programinställningar från myfunctionapp12345 appen i Azure:

func azure functionapp fetch-app-settings myfunctionapp12345

Det här kommandot skriver över alla befintliga inställningar i filen local.settings.json med värden från Azure. När de inte redan finns läggs nya objekt till i samlingen. Mer information finns i func azure functionapp fetch-app-settings kommandot .

Ladda ned en lagrings-niska veze

Core Tools gör det också enkelt att få niska veze för alla lagringskonton som du har åtkomst till. Från projektroten använder du följande kommando för att ladda ned niska veze från ett lagringskonto med namnet mystorage12345.

func azure storage fetch-connection-string mystorage12345

Det här kommandot lägger till en inställning med namnet mystorage12345_STORAGE i local.settings.json-filen, som innehåller niska veze för mystorage12345 kontot. Mer information finns i func azure storage fetch-connection-string kommandot .

För förbättrad säkerhet under utveckling bör du överväga att kryptera local.settings.json-filen.

Ladda upp lokala inställningar till Azure

När du publicerar dina projektfiler till Azure utan att använda alternativet anges inte inställningarna i local.settings.json filen i funktionsappen --publish-local-settings . Du kan alltid köra func azure functionapp publish om med --publish-settings-only alternativet att ladda upp bara inställningarna utan att publicera om projektfilerna.

I följande exempel laddas bara inställningar från Values samlingen i local.settings.json-filen upp till funktionsappen i Azure med namnet myfunctionapp12345:

func azure functionapp publish myfunctionapp12345 --publish-settings-only

Kryptera filen med lokala inställningar

För att förbättra säkerheten för niska veze och andra värdefulla data i dina lokala inställningar kan du med Core Tools kryptera local.settings.json-filen. När den här filen krypteras dekrypterar körningen automatiskt inställningarna när det behövs på samma sätt som med programinställningen i Azure. Du kan också dekryptera en lokalt krypterad fil för att arbeta med inställningarna.

Använd följande kommando för att kryptera filen med lokala inställningar för projektet:

func settings encrypt

Använd följande kommando för att dekryptera en krypterad lokal inställning så att du kan arbeta med den:

func settings decrypt

När inställningsfilen krypteras och dekrypteras uppdateras även filens IsEncrypted inställning.

Konfigurera bindningstillägg

Funktionsutlösare och bindningar implementeras som .NET-tilläggspaket (NuGet). För att kunna använda ett specifikt bindningstillägg måste tillägget installeras i projektet.

Core Tools-versioner

Huvudversioner av Azure Functions Core Tools är länkade till specifika huvudversioner av Azure Functions-körningen. Version 4.x av Core Tools stöder till exempel version 4.x av Functions-körningen. Den här versionen är den rekommenderade huvudversionen av både Functions-körningen och Core Tools. Du kan fastställa den senaste versionen av Core Tools på Azure Functions Core Tools-lagringsplatsen.

Kör följande kommando för att fastställa vilken version av din aktuella Core Tools-installation:

func --version

Om inget annat anges gäller exemplen i den här artikeln version 4.x.

Följande överväganden gäller för Core Tools-installationer:

• Du kan bara installera en version av Core Tools på en viss dator.

• När du uppgraderar till den senaste versionen av Core Tools bör du använda samma metod som du använde för den ursprungliga installationen för att utföra uppgraderingen. Om du till exempel använde en MSI i Windows avinstallerar du den aktuella MSI:en och installerar den senaste. Eller om du använde npm kör npm install commanddu igen .

• Version 2.x och 3.x av Core Tools användes med version 2.x och 3.x av Functions-körningen, som har nått slutet av supporten. Mer information finns i Översikt över Azure Functions-körningsversioner.

Nästa steg

Lär dig hur du utvecklar, testar och publicerar Azure-funktioner med hjälp av Azure Functions-kärnverktyg. Azure Functions Core Tools är öppen källkod och finns på GitHub. Om du vill skicka en bugg eller funktionsbegäran öppnar du ett GitHub-problem.