Místní vývoj Azure Functions pomocí nástrojů Core Tools

Azure Functions Core Tools umožňuje vyvíjet a testovat funkce na místním počítači. Až budete připraveni, můžete pomocí nástrojů Core Tools nasadit projekt kódu do Azure a pracovat s nastavením aplikace.

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ápovědu k problémům souvisejícím s verzemi najdete v tématu Verze nástrojů Core Tools.

Vytvoření místního projektu

V okně terminálu nebo z příkazového řádku spusťte následující příkaz, který vytvoří projekt ve MyProjFolder složce:

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

Když spustíte func init bez --worker-runtime možnosti, zobrazí se výzva k výběru jazyka projektu. Další informace o dostupných možnostech func init příkazu najdete v referenčních informacích func init .

Vytvoření funkce

Pokud chcete do projektu přidat funkci, spusťte func new příkaz pomocí --template možnosti pro výběr šablony triggeru. Následující příklad vytvoří trigger HTTP s názvem MyHttpTrigger:

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

Tento příklad vytvoří trigger Queue Storage s názvem MyQueueTrigger:

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

Při přidávání funkcí platí následující aspekty:

• Když spustíte func new bez --template možnosti, zobrazí se výzva k výběru šablony.

• func templates list Pomocí příkazu zobrazíte úplný seznam dostupných šablon pro váš jazyk.

• Když přidáte trigger, který se připojí ke službě, budete také muset přidat nastavení aplikace, které odkazuje na připojovací řetězec nebo spravovanou identitu na soubor local.settings.json. Použitím nastavení aplikace tímto způsobem zabráníte vložení přihlašovacích údajů do kódu. Další informace najdete v tématu Práce s místním nastavením aplikace.

Další informace o dostupných možnostech func new příkazu najdete v referenčních informacích func new .

Přidání vazby do funkce

Functions poskytuje sadu vstupních a výstupních vazeb specifických pro službu, které usnadňují připojení vaší funkce k jiným službám Azure, aniž by bylo nutné používat klientské sady SDK specifické pro službu. Další informace najdete v tématu o koncepcích triggerů a vazeb Azure Functions.

Pokud chcete do existující funkce přidat vstupní nebo výstupní vazbu, musíte definici funkce aktualizovat ručně.

Následující příklad ukazuje definici funkce po přidání výstupní vazby Queue Storage do funkce aktivované protokolem HTTP:

[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"
    }
  ]
}

Při přidávání vazeb do funkce platí následující aspekty:

• Když přidáte vazby, které se připojují ke službě, musíte také přidat nastavení aplikace odkazující na připojovací řetězec nebo spravovanou identitu na soubor local.settings.json. Další informace najdete v tématu Práce s místním nastavením aplikace.

Spuštění modulu runtime Služby Functions

Než budete moct spustit nebo ladit funkce v projektu, musíte spustit hostitele Functions z kořenového adresáře projektu. Hostitel povolí triggery pro všechny funkce v projektu. Pomocí tohoto příkazu spusťte místní modul runtime:

mvn clean package 
mvn azure-functions:run

func start

func start

func start

npm install
npm start     

Když se hostitel Functions spustí, vypíše seznam funkcí v projektu, včetně adres URL všech funkcí aktivovaných protokolem HTTP, například v tomto příkladu:

Found the following functions:
Host.Functions.MyHttpTrigger

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

Při místním spouštění funkcí mějte na paměti následující aspekty:

• Ve výchozím nastavení se autorizace pro koncové body HTTP nevynucuje místně. To znamená, že všechny místní požadavky HTTP se zpracovávají jako authLevel = "anonymous". Další informace najdete v tématu Úroveň autorizace. Tuto možnost můžete použít --enableAuth k vyžadování autorizace při místním spuštění. Další informace viz func start.

• Místní emulátor Azurite můžete použít při místním spouštění funkcí, které vyžadují přístup ke službám Azure Storage (Queue Storage, Blob Storage a Table Storage), aniž byste se museli k těmto službám v Azure připojovat. Při použití místní emulace nezapomeňte spustit Azurite před spuštěním místního hostitele (func.exe). Další informace naleznete v tématu Emulace místního úložiště.

• Funkce jiného typu než HTTP můžete aktivovat místně bez připojení k živé službě. Další informace naleznete v tématu Spuštění místní funkce.

• Když do souboru local.settings.json zahrnete informace o připojení Application Insights, zapíšou se data místního protokolu do konkrétní instance Application Insights. Pokud chcete zachovat místní telemetrická data oddělená od produkčních dat, zvažte použití samostatné instance Application Insights pro vývoj a testování.

Spuštění místní funkce

Když je spuštěný místní hostitel služby Functions (func.exe), můžete teď aktivovat jednotlivé funkce, které budou spouštět a ladit kód funkce. Způsob spuštění jednotlivé funkce závisí na jeho typu triggeru.

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

Publikování do Azure

Azure Functions Core Tools podporuje tři typy nasazení:

Abyste mohli publikovat do Azure z Nástrojů Core Tools, musíte mít místně nainstalované Rozhraní příkazového řádku Azure nebo Azure PowerShell . Nástroje Core Tools ve výchozím nastavení používají tyto nástroje k ověření pomocí vašeho účtu Azure.

Pokud tyto nástroje nemáte nainstalované, musíte místo toho získat platný přístupový token , který se má použít během nasazení. Přístupový token můžete prezentovat pomocí --access-token možnosti v příkazech nasazení.

Nasazení souborů projektu

func azure functionapp publish <FunctionAppName>

mvn azure-functions:deploy

Nasazení kontejnerů

Nástroje Core Tools umožňují nasadit kontejnerizovanou aplikaci funkcí do spravovaných prostředí Azure Container Apps i clusterů Kubernetes, které spravujete.

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> 

Práce s místním nastavením aplikace

Při spuštění v aplikaci funkcí v Azure se nastavení vyžadovaná funkcemi bezpečně ukládají v nastavení aplikace. Během místního vývoje se tato nastavení místo toho přidají do Values kolekce v souboru local.settings.json. Soubor local.settings.json také ukládá nastavení používaná místními vývojářskými nástroji.

Položky v kolekci Values v souboru local.settings.json projektu mají zrcadlit položky v nastavení aplikace funkcí v Azure.

Při práci se souborem místního nastavení platí následující aspekty:

• Protože local.settings.json může obsahovat tajné kódy, jako jsou připojovací řetězec, nikdy byste je neměli ukládat do vzdáleného úložiště. Nástroje Core Tools pomáhají šifrovat tento místní soubor nastavení pro lepší zabezpečení. Další informace naleznete v tématu Místní soubor nastavení. Můžete také zašifrovat local.settings.json soubor pro přidání zabezpečení.

• Ve výchozím nastavení se při publikování projektu do Azure automaticky nemigrují místní nastavení. Tuto možnost použijte při publikování souborů projektu, abyste měli jistotu --publish-local-settings , že se tato nastavení přidají do aplikace funkcí v Azure. Hodnoty v oddílu ConnectionStrings se nikdy nepublikují. Nastavení můžete také nahrát z local.settings.json souboru kdykoli.

• Nastavení v souboru local.settings.json můžete stáhnout a přepsat nastavením z aplikace funkcí v Azure. Další informace najdete v tématu Stažení nastavení aplikace.

• Pokud není nastavena AzureWebJobsStorage žádná platná připojovací řetězec úložiště a nepoužívá se emulátor místního úložiště, zobrazí se chyba. Nástroje Core Tools můžete použít ke stažení konkrétního připojovací řetězec z libovolného účtu azure Storage.

Stažení nastavení aplikace

V kořenovém adresáři projektu pomocí následujícího příkazu stáhněte všechna nastavení aplikace z myfunctionapp12345 aplikace v Azure:

func azure functionapp fetch-app-settings myfunctionapp12345

Tento příkaz přepíše všechna existující nastavení v souboru local.settings.json hodnotami z Azure. Pokud ještě nejsou k dispozici, do kolekce se přidají nové položky. Další informace najdete v func azure functionapp fetch-app-settings příkazu.

Stažení připojovací řetězec úložiště

Nástroje Core Tools také usnadňují získání připojovací řetězec libovolného účtu úložiště, ke kterému máte přístup. Z kořenového adresáře projektu pomocí následujícího příkazu stáhněte připojovací řetězec z účtu úložiště s názvem mystorage12345.

func azure storage fetch-connection-string mystorage12345

Tento příkaz přidá nastavení pojmenované mystorage12345_STORAGE do souboru local.settings.json, který obsahuje připojovací řetězec účtumystorage12345. Další informace najdete v func azure storage fetch-connection-string příkazu.

Pokud chcete zlepšit zabezpečení během vývoje, zvažte šifrování souboru local.settings.json.

Nahrání místního nastavení do Azure

Když publikujete soubory projektu do Azure bez použití --publish-local-settings této možnosti, nastavení v souboru local.settings.json se ve vaší aplikaci funkcí nenastaví. Vždy můžete znovu spustit func azure functionapp publish možnost --publish-settings-only nahrání jenom nastavení bez opětovného publikování souborů projektu.

Následující příklad nahraje pouze nastavení z Values kolekce v souboru local.settings.json do aplikace funkcí v Azure s názvem myfunctionapp12345:

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

Šifrování místního souboru nastavení

Nástroje Core Tools umožňují šifrovat soubor local.settings.json, aby se zlepšilo zabezpečení připojovací řetězec a dalších cenných dat v místním nastavení. Když je tento soubor zašifrovaný, modul runtime automaticky dešifruje nastavení v případě potřeby stejným způsobem jako nastavení aplikace v Azure. Můžete také dešifrovat místně zašifrovaný soubor a pracovat s nastavením.

Pomocí následujícího příkazu zašifrujte místní soubor nastavení projektu:

func settings encrypt

Pomocí následujícího příkazu dešifrujte šifrované místní nastavení, abyste s ním mohli pracovat:

func settings decrypt

Když je soubor nastavení zašifrovaný a dešifrovaný, aktualizuje se také nastavení souboru IsEncrypted .

Konfigurace rozšíření vazeb

Triggery a vazby funkcí se implementují jako balíčky rozšíření .NET (NuGet). Aby bylo možné použít konkrétní rozšíření vazby, musí být toto rozšíření nainstalované v projektu.

Verze nástrojů Core Tools

Hlavní verze nástrojů Azure Functions Core Tools jsou propojené s konkrétními hlavními verzemi modulu runtime Azure Functions. Například verze 4.x nástrojů Core Tools podporuje verzi 4.x modulu runtime Functions. Tato verze je doporučenou hlavní verzí modulu runtime služby Functions i nástrojů Core Tools. Nejnovější verzi nástrojů Core Tools můžete určit v úložišti Azure Functions Core Tools.

Spuštěním následujícího příkazu určete verzi aktuální instalace nástrojů Core Tools:

func --version

Pokud není uvedeno jinak, příklady v tomto článku jsou určené pro verzi 4.x.

Následující aspekty platí pro instalace nástrojů Core Tools:

• Na daný počítač můžete nainstalovat jenom jednu verzi nástrojů Core Tools.

• Při upgradu na nejnovější verzi nástrojů Core Tools byste měli použít stejnou metodu, jakou jste použili k provedení upgradu původní instalace. Pokud jste například použili MSI ve Windows, odinstalujte aktuální MSI a nainstalujte nejnovější. Nebo pokud jste použili npm, spusťte npm install commandznovu .

• Verze 2.x a 3.x nástrojů Core Tools byla použita s verzemi 2.x a 3.x modulu runtime Functions, které dosáhly konce podpory. Další informace najdete v přehledu verzí modulu runtime Azure Functions.

Další kroky

Naučte se vyvíjet , testovat a publikovat funkce Azure pomocí základních nástrojů Azure Functions. Azure Functions Core Tools je open source a hostuje se na GitHubu. Pokud chcete podat žádost o chybu nebo funkci, otevřete problém GitHubu.