Łączenie funkcji z usługami Azure przy użyciu powiązań

Podczas tworzenia funkcji kod wyzwalacza specyficzny dla języka jest dodawany w projekt z zestawu szablonów wyzwalania. Jeśli chcesz połączyć funkcję z innymi usługami przy użyciu powiązań wejściowych lub wyjściowych, musisz dodać określone definicje powiązań w funkcji. Aby dowiedzieć się więcej o powiązaniach, zobacz pojęcia dotyczące wyzwalaczy i powiązań Azure Functions.

Rozwój lokalny

Podczas lokalnego opracowywania funkcji należy zaktualizować kod funkcji, aby dodać powiązania. W przypadku języków korzystających z function.jsonVisual Studio Code udostępnia narzędzia umożliwiające dodawanie powiązań do funkcji.

Ręczne dodawanie powiązań na podstawie przykładów

Podczas dodawania powiązania do istniejącej funkcji należy dodać atrybuty specyficzne dla powiązania do definicji funkcji w kodzie.

Podczas dodawania powiązania do istniejącej funkcji należy dodać adnotacje specyficzne dla powiązania do definicji funkcji w kodzie.

Podczas dodawania powiązania do istniejącej funkcji należy zaktualizować kod funkcji i dodać definicję do pliku konfiguracji function.json.

Dodając przypisanie do istniejącej funkcji, musisz zaktualizować definicję funkcji w zależności od modelu:

Należy dodać adnotacje specyficzne dla powiązania do definicji funkcji w kodzie.

W języku Go konfigurujesz obsługiwane wyzwalacze przy użyciu płynnego interfejsu API rejestracji w funkcji main(). Każdy typ wyzwalacza ma dedykowaną metodę rejestracji z opcjami funkcjonalnymi konfiguracji. Nie jest wymagany oddzielny plik konfiguracji powiązania.

W poniższym przykładzie przedstawiono funkcję wyzwalaną przez protokół HTTP. Jeśli musisz zapisywać do usługi Queue Storage z funkcji Go, użyj bezpośrednio zestawu Azure SDK dla języka Go, ponieważ powiązania wyjściowe usługi Queue Storage nie są obecnie obsługiwane przez moduł roboczy języka Go:

package main

import (
    "encoding/json"
    "fmt"
    "net/http"

    "github.com/azure/azure-functions-golang-worker/sdk"
    "github.com/azure/azure-functions-golang-worker/worker"
)

func main() {
    app := sdk.FunctionApp()
    app.HTTP("HttpExample", httpHandler,
        sdk.WithMethods("GET", "POST"),
        sdk.WithAuth("anonymous"),
    )
    worker.Start(app)
}

func httpHandler(w http.ResponseWriter, r *http.Request) {
    name := r.URL.Query().Get("name")
    if name == "" {
        var body struct{ Name string }
        json.NewDecoder(r.Body).Decode(&body)
        name = body.Name
    }
    if name == "" {
        w.WriteHeader(http.StatusBadRequest)
        fmt.Fprint(w, "Please pass a name on the query string or in the request body.")
        return
    }
    // Queue output bindings are not yet supported in the Go worker.
    // Use the Azure SDK for Go to write to Queue Storage directly.
    fmt.Fprintf(w, "Hello, %s!", name)
}

Note

Proces roboczy języka Go obecnie obsługuje tylko wyzwalacze. Powiązania wejściowe i wyjściowe, takie jak powiązania wyjściowe usługi Queue Storage, nie są jeszcze dostępne. Użyj Azure SDK dla języka Go aby korzystać z innych usług Azure bezpośrednio z kodu funkcji.

Worker Go obsługuje obecnie następujące typy wyzwalaczy:

Typ wyzwalacza Metoda rejestracji Przykłady
HTTP app.HTTP() Przykłady HTTP
Czasomierz app.Timer() Przykłady timera
Azure Cosmos DB app.CosmosDB() Przykłady usługi Cosmos DB
Azure Service Bus (Queue) app.ServiceBusQueue() Przykłady kolejki Service Bus
Azure Service Bus (Temat) app.ServiceBusTopic() Przykłady tematów Service Bus
Event Hubs app.EventHub() Przykłady Event Hubs
Event Grid app.EventGrid() Przykłady usługi Event Grid
Blob Storage app.Blob() Przykłady obiektów Blob

Aby uzyskać więcej informacji, zobacz dokumentację dla deweloperów języka Go.

Poniższy przykład przedstawia definicję funkcji po dodaniu powiązania wyjściowego Queue Storage do funkcji uruchamianej przez HTTP:

Ponieważ funkcja wyzwalana przez protokół HTTP zwraca również odpowiedź HTTP, funkcja zwraca MultiResponse obiekt, który reprezentuje zarówno dane wyjściowe HTTP, jak i kolejki.

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

Ten przykład przedstawia definicję obiektu MultiResponse, który zawiera powiązanie wyjściowe.

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

W tym przykładzie użyto integracji ASP.NET Core. Jeśli nie używasz integracji ASP.NET Core, musisz zmienić HttpRequest na HttpRequestData i IActionResult na HttpResponseData.

Po zakończeniu działania funkcji komunikaty są wysyłane do kolejki. Sposób definiowania powiązania wyjściowego zależy od modelu procesu. Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

@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) {

Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

const { app, output } = require('@azure/functions');

const sendToQueue = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  extraOutputs: [sendToQueue],
  handler: async (request, context) => {
    try {
      context.log(`Http function processed request for url "${request.url}"`);

      const name = request.query.get('name') || (await request.text());
      context.log(`Name: ${name}`);

      if (name) {
        const msg = `Name passed to the function ${name}`;
        context.extraOutputs.set(sendToQueue, [msg]);
        return { body: msg };
      } else {
        context.log('Missing required data');
        return { status: 404, body: 'Missing required data' };
      }
    } catch (error) {
      context.log(`Error: ${error}`);
      return { status: 500, body: 'Internal Server Error' };
    }
  },
});

Sposób definiowania powiązania wyjściowego zależy od wersji modelu Node.js. Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

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

Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

@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.')

Sposób definiowania powiązania wyjściowego zależy od wersji modelu języka Python. Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

import {
  app,
  output,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  StorageQueueOutput,
} from '@azure/functions';

const sendToQueue: StorageQueueOutput = output.storageQueue({
  queueName: 'outqueue',
  connection: 'AzureWebJobsStorage',
});

export async function HttpExample(
  request: HttpRequest,
  context: InvocationContext,
): Promise<HttpResponseInit> {
  try {
    context.log(`Http function processed request for url "${request.url}"`);

    const name = request.query.get('name') || (await request.text());
    context.log(`Name: ${name}`);

    if (name) {
      const msg = `Name passed to the function ${name}`;
      context.extraOutputs.set(sendToQueue, [msg]);
      return { body: msg };
    } else {
      context.log('Missing required data');
      return { status: 404, body: 'Missing required data' };
    }
  } catch (error) {
    context.log(`Error: ${error}`);
    return { status: 500, body: 'Internal Server Error' };
  }
}

app.http('HttpExample', {
  methods: ['GET', 'POST'],
  authLevel: 'anonymous',
  handler: HttpExample,
});

Sposób definiowania powiązania wyjściowego zależy od wersji modelu Node.js. Aby uzyskać więcej informacji, w tym linki do przykładowego kodu powiązania, do którego można się odwołać, zobacz Dodawanie powiązań do funkcji.

Skorzystaj z poniższej tabeli, aby znaleźć przykłady określonych typów powiązań, których można użyć, aby przeprowadzić aktualizowanie istniejącej funkcji. Najpierw wybierz zakładkę językową odpowiadającą twojemu projektowi.

Kod powiązania dla języka C# zależy od określonego modelu procesu.

Usługa Przykłady Przykłady
Blob Storage Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Cosmos DB Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Data Explorer Wejście
Dane wyjściowe
Link
Azure SQL Wyzwalacz
Wejście
Dane wyjściowe
Link
Event Grid Wyzwalacz
Dane wyjściowe
Link
Centra zdarzeń Wyzwalacz
Dane wyjściowe
Centrum IoT Wyzwalacz
Dane wyjściowe
HTTP Wyzwalacz Link
Protokół kontekstu modelu Wyzwalacz narzędzia
Wyzwalacz zasobu
Wyzwalacz monitu
Link
Queue Storage Wyzwalacz
Dane wyjściowe
Link
RabbitMQ Wyzwalacz
Dane wyjściowe
SendGrid Dane wyjściowe
Magistrala usług Wyzwalacz
Dane wyjściowe
Link
Azure SignalR Service Wyzwalacz
Wejście
Dane wyjściowe
Magazyn tabel Wejście
Dane wyjściowe
Czasomierz Wyzwalacz Link
Twilio Dane wyjściowe Link
Łączniki zarządzane Wyzwalacz Link
Usługa Przykłady Przykłady
Blob Storage Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Cosmos DB Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Data Explorer Wejście
Dane wyjściowe
Link
Azure SQL Wyzwalacz
Wejście
Dane wyjściowe
Event Grid Wyzwalacz
Dane wyjściowe
Link
Centra zdarzeń Wyzwalacz
Dane wyjściowe
Centrum IoT Wyzwalacz
Dane wyjściowe
HTTP Wyzwalacz Link
Protokół kontekstu modelu Wyzwalacz narzędzia
Wyzwalacz zasobu
Wyzwalacz monitu
Link
Queue Storage Wyzwalacz
Dane wyjściowe
Link
RabbitMQ Wyzwalacz
Dane wyjściowe
SendGrid Dane wyjściowe
Magistrala usług Wyzwalacz
Dane wyjściowe
Link
Azure SignalR Service Wyzwalacz
Wejście
Dane wyjściowe
Magazyn tabel Wejście
Dane wyjściowe
Czasomierz Wyzwalacz Link
Twilio Dane wyjściowe
Usługa Przykłady Przykłady
Blob Storage Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Cosmos DB Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Data Explorer Wejście
Dane wyjściowe
Azure SQL Wyzwalacz
Wejście
Dane wyjściowe
Link
Event Grid Wyzwalacz
Dane wyjściowe
Centra zdarzeń Wyzwalacz
Dane wyjściowe
Centrum IoT Wyzwalacz
Dane wyjściowe
HTTP Wyzwalacz Link
Protokół kontekstu modelu Wyzwalacz narzędzia
Wyzwalacz zasobu
Wyzwalacz monitu
Link
Queue Storage Wyzwalacz
Dane wyjściowe
Link
RabbitMQ Wyzwalacz
Dane wyjściowe
SendGrid Dane wyjściowe
Magistrala usług Wyzwalacz
Dane wyjściowe
Link
Azure SignalR Service Wyzwalacz
Wejście
Dane wyjściowe
Magazyn tabel Wejście
Dane wyjściowe
Czasomierz Wyzwalacz
Twilio Dane wyjściowe
Łączniki zarządzane Wyzwalacz Link
Usługa Przykłady Przykłady
Blob Storage Wyzwalacz
Wejście
Dane wyjściowe
Azure Cosmos DB Wyzwalacz
Wejście
Dane wyjściowe
Azure SQL Wyzwalacz
Wejście
Dane wyjściowe
Event Grid Wyzwalacz
Dane wyjściowe
Centra zdarzeń Wyzwalacz
Dane wyjściowe
Centrum IoT Wyzwalacz
Dane wyjściowe
HTTP Wyzwalacz Link
Queue Storage Wyzwalacz
Dane wyjściowe
RabbitMQ Wyzwalacz
Dane wyjściowe
SendGrid Dane wyjściowe
Magistrala usług Wyzwalacz
Dane wyjściowe
Azure SignalR Service Wyzwalacz
Wejście
Dane wyjściowe
Magazyn tabel Wejście
Dane wyjściowe
Czasomierz Wyzwalacz
Twilio Dane wyjściowe

Kod powiązań dla Pythona zależy od wersji modelu Pythona.

Usługa Przykłady Przykłady
Blob Storage Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Cosmos DB Wyzwalacz
Wejście
Dane wyjściowe
Link
Azure Data Explorer Wejście
Dane wyjściowe
Azure SQL Wyzwalacz
Wejście
Dane wyjściowe
Link
Event Grid Wyzwalacz
Dane wyjściowe
Centra zdarzeń Wyzwalacz
Dane wyjściowe
Centrum IoT Wyzwalacz
Dane wyjściowe
HTTP Wyzwalacz Link
Protokół kontekstu modelu Wyzwalacz narzędzia
Wyzwalacz zasobu
Wyzwalacz monitu
Link
Queue Storage Wyzwalacz
Dane wyjściowe
RabbitMQ Wyzwalacz
Dane wyjściowe
SendGrid Dane wyjściowe
Magistrala usług Wyzwalacz
Dane wyjściowe
Link
Azure SignalR Service Wyzwalacz
Wejście
Dane wyjściowe
Magazyn tabel Wejście
Dane wyjściowe
Czasomierz Wyzwalacz
Twilio Dane wyjściowe
Łączniki zarządzane Wyzwalacz Link

Visual Studio Code

Gdy używasz Visual Studio Code do opracowywania funkcji, a funkcja używa pliku function.json, rozszerzenie Azure Functions może automatycznie dodać powiązanie do istniejącego pliku function.json. Aby dowiedzieć się więcej, zobacz Dodawanie powiązań wejściowych i wyjściowych.

Azure Portal

Podczas opracowywania funkcji w Azure portal należy dodać powiązania wejściowe i wyjściowe w Integrate dla danej funkcji. Nowe powiązania są dodawane do pliku function.json lub atrybutów metody w zależności od języka. W poniższych artykułach przedstawiono przykłady dodawania powiązań do istniejącej funkcji w portalu:

Dalsze kroki