Anslut Azure Functions att Azure Cosmos DB med Visual Studio Code

Med Azure Functions kan du ansluta Azure-tjänster och andra resurser till funktioner utan att behöva skriva din egen integrerings kod. Dessa bindningar, som representerar både indata och utdata, deklareras i funktions definitionen. Data från bindningar skickas som parametrar till funktionen. En utlösare är en särskild typ av ingående bindning. Även om en funktion bara har en utlösare, kan den ha flera indata och utdata-bindningar. Mer information finns i Azure Functions utlösare och bindningar begrepp.

Den här artikeln visar hur du använder Visual Studio Code för att Azure Cosmos DB till funktionen som du skapade i föregående snabbstartsartikel. Den utdatabindning som du lägger till i den här funktionen skriver data från HTTP-begäran till ett JSON-dokument som lagras i en Azure Cosmos DB container.

Konfigurera din miljö

Innan du börjar måste du installera Tillägget Azure Databases för Visual Studio Code.

Skapa ditt Azure Cosmos DB konto

1. I Visual Studio Code väljer du Azure-ikonen i Aktivitetsfältet.

2. I området Azure: Databaser högerklickar du (Ctrl+klickar på macOS) i Azure-prenumerationen där du skapade funktionsappen i föregående artikel ochväljer Skapa server...

   

3. Ange följande information i meddelanderutorna:

   Prompt	Urval
   Välj en Azure Database-server	Välj Core (SQL) att skapa en dokumentdatabas som du kan köra frågor mot med hjälp av SQL syntax. Läs mer om Azure Cosmos DB SQL API.
   Kontonamn	Ange ett unikt namn som identifierar ditt Azure Cosmos DB-konto. Kontonamnet får bara använda gemener, siffror och bindestreck (-) och måste vara mellan 3 och 31 tecken långt.
   Välj en kapacitetsmodell	Välj Serverlös för att skapa ett konto i serverlöst läge.
   Välj en resursgrupp för nya resurser	Välj den resursgrupp där du skapade funktionsappen i föregående artikel.
   Välj en plats för nya resurser	Välj en geografisk plats som värd för ditt Azure Cosmos DB-konto. Använd den plats som är närmast dig eller dina användare för att få den snabbaste åtkomsten till dina data.

   När ditt nya konto har etablerats visas ett meddelande i meddelandefältet.

Skapa en Azure Cosmos DB databas och container

1. Högerklicka på ditt konto och välj Skapa databas....

2. Ange följande information i meddelanderutorna:

   Prompt	Urval
   Databasnamn	Skriv my-database.
   Ange och ID för din samling	Skriv my-container.
   Ange partitionsnyckeln för samlingen	Skriv /id som partitionsnyckel.

3. Välj OK för att skapa containern och databasen.

Uppdatera inställningarna för funktionsappen

I den föregående snabbstartsartikelnskapade du en funktionsapp i Azure. I den här artikeln uppdaterar du din app för att skriva JSON-dokument till Azure Cosmos DB container som du nyss skapade. Om du vill ansluta Azure Cosmos DB ditt konto måste du lägga till dess anslutningssträng i appinställningarna. Sedan laddar du ned den nya inställningen till filen local.settings.json så att du kan ansluta till ditt Azure Cosmos DB konto när du kör lokalt.

1. I Visual Studio Code högerklickar du (Ctrl+klickar på macOS) på ditt nya Azure Cosmos DB konto och väljer Kopiera anslutningssträng.

   

2. Tryck på F1 för att öppna kommandopaletten och sök sedan efter och kör kommandot Azure Functions: Add New Setting... .

3. Välj den funktionsapp som du skapade i föregående artikel. Ange följande information i meddelanderutorna:

   Prompt	Urval
   Ange namnet på den nya appinställningen	Skriv CosmosDbConnectionString.
   Ange värdet för "CosmosDbConnectionString"	Klistra in anslutningssträngen för ditt Azure Cosmos DB som du nyss kopierade.

   Detta skapar en programinställning med namnet CosmosDbConnectionString anslutning i funktionsappen i Azure. Nu kan du ladda ned den här inställningen till filen local.settings.json.

4. Tryck på F1 igen för att öppna kommandopaletten och sök sedan efter och kör kommandot Azure Functions: Download Remote Settings... .

5. Välj den funktionsapp som du skapade i föregående artikel. Välj Ja om du vill skriva över de befintliga lokala inställningarna.

Då laddas alla inställningar ned från Azure till ditt lokala projekt, inklusive den nya inställningen för anslutningssträngen. De flesta av de nedladdade inställningarna används inte när du kör lokalt.

Registrera bindningstillägg

Eftersom du använder en Azure Cosmos DB-utdatabindning måste du ha motsvarande bindningstillägg installerat innan du kör projektet.

dotnet add package Microsoft.Azure.WebJobs.Extensions.CosmosDB 

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.CosmosDB

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle",
    "version": "[1.*, 2.0.0)"
  } 
}

Nu kan du lägga till Azure Cosmos DB-utdatabindningen i projektet.

Lägg till en utdatabindning

I Functions kräver varje typ av bindning direction en , och en unik för att type name definieras i filen function.json. Hur du definierar dessa attribut beror på funktionsappens språk.

[CosmosDB(databaseName: "my-database", collectionName: "my-container",
    ConnectionStringSetting = "CosmosDbConnectionString"
    )]IAsyncCollector<dynamic> documentsOut,

public class MultiResponse
{
    [CosmosDBOutput("my-database", "my-container",
        ConnectionStringSetting = "CosmosDbConnectionString", CreateIfNotExists = true)]
    public MyDocument Document { get; set; }
    public HttpResponseData HttpResponse { get; set; }
}
public class MyDocument {
    public string id { get; set; }
    public string message { get; set; }
}

{
    "type": "cosmosDB",
    "direction": "out",
    "name": "outputDocument",
    "databaseName": "my-database",
    "collectionName": "my-container",
    "createIfNotExists": "false",
    "connectionStringSetting": "CosmosDbConnectionString"
}

Lägg till kod som använder utdatabindning

if (!string.IsNullOrEmpty(name))
{
    // Add a JSON document to the output container.
    await documentsOut.AddAsync(new
    {
        // create a random ID
        id = System.Guid.NewGuid().ToString(),
        name = name
    });
}

[FunctionName("HttpExample")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req,
    [CosmosDB(
        databaseName: "my-database",
        collectionName: "my-container",
        ConnectionStringSetting = "CosmosDbConnectionString")]IAsyncCollector<dynamic> documentsOut,
    ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    string name = req.Query["name"];

    string requestBody = await new StreamReader(req.Body).ReadToEndAsync();
    dynamic data = JsonConvert.DeserializeObject(requestBody);
    name = name ?? data?.name;

    if (!string.IsNullOrEmpty(name))
    {
        // Add a JSON document to the output container.
        await documentsOut.AddAsync(new
        {
            // create a random ID
            id = System.Guid.NewGuid().ToString(),
            name = name
        });
    }

    string responseMessage = string.IsNullOrEmpty(name)
        ? "This HTTP triggered function executed successfully. Pass a name in the query string or in the request body for a personalized response."
        : $"Hello, {name}. This HTTP triggered function executed successfully.";

    return new OkObjectResult(responseMessage);
}

[Function("HttpExample")]
public static MultiResponse Run([HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequestData req,
    FunctionContext executionContext)
{
    var logger = executionContext.GetLogger("HttpExample");
    logger.LogInformation("C# HTTP trigger function processed a request.");

    var message = "Welcome to Azure Functions!";

    var response = req.CreateResponse(HttpStatusCode.OK);
    response.Headers.Add("Content-Type", "text/plain; charset=utf-8");
    response.WriteString(message);

    // Return a response to both HTTP trigger and Azure Cosmos DB output binding.
    return new MultiResponse()
    {
         Document = new MyDocument
        {
            id = System.Guid.NewGuid().ToString(),
            message = message
        },
        HttpResponse = response
    };
}

if (name) {
    context.bindings.outputDocument = JSON.stringify({
        // create a random ID
        id: new Date().toISOString() + Math.random().toString().substr(2,8),
        name: name
    });
}

module.exports = async function (context, req) {
    context.log('JavaScript 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.";

    if (name) {
        context.bindings.outputDocument = JSON.stringify({
            // create a random ID
            id: new Date().toISOString() + Math.random().toString().substr(2,8),
            name: name
        });
    }

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

Kontrollera att ett JSON-dokument har skapats

1. På den Azure Portal går du tillbaka till ditt Azure Cosmos DB konto och väljer Datautforskaren.

2. Expandera databasen och containern och välj Objekt för att visa de dokument som skapats i containern.

3. Kontrollera att ett nytt JSON-dokument har skapats av utdatabindningen.

   

Distribuera om och verifiera den uppdaterade appen

1. I Visual Studio Code trycker du på F1 för att öppna kommandopaletten. I kommandopaletten söker du efter och väljer Azure Functions: Deploy to function app... .

2. Välj den funktionsapp som du skapade i den första artikeln. Eftersom du omdistribuerar projektet till samma app väljer du Distribuera för att stänga varningen om att skriva över filer.

3. När distributionen är klar kan du använda funktionen Kör nu... igen för att utlösa funktionen i Azure.

4. Kontrollera återigen dokumenten som skapats i Azure Cosmos DB containern för att verifiera att utdatabindningen genererar ett nytt JSON-dokument igen.

Rensa resurser

I Azure refererar resurser till funktionsappar, funktioner, lagringskonton och så vidare. De grupperas i resursgrupper och du kan ta bort allt i en grupp genom att ta bort gruppen.

Du skapade resurser för att slutföra de här snabbstarterna. Det är möjligt att du debiteras för de här resurserna beroende på din kontostatus och dina servicepriser. Om du inte behöver resurserna längre så visar vi hur du tar bort dem här:

1. I Visual Studio Code, trycker du på F1 för att öppna kommando paletten. I paletten kommando söker du efter och väljer Azure Functions: Open in portal .

2. Välj Function-appen och tryck på RETUR. Sidan Function-appen öppnas i Azure Portal.

3. På fliken Översikt väljer du den namngivna länken bredvid resurs grupp.

   

4. Granska listan över resurser som ingår och verifiera att det är dem som du vill ta bort på sidan Resursgrupp.

5. Välj Ta bort resursgrupp och följ instruktionerna.

   Borttagningen kan ta några minuter. När du är färdig visas ett meddelande i några sekunder. Du kan även välja klockikonen längst upp på sidan för att se meddelandet.

Nästa steg

Du har uppdaterat den HTTP-utlösta funktionen för att skriva JSON-dokument till en Azure Cosmos DB container. Nu kan du lära dig mer om att utveckla funktioner med Visual Studio Code:

• Utveckla Azure Functions med Visual Studio Code

• Azure Functions utlösare och bindningar.