Azure Service Bus-Ausgabebindung für Azure Functions

Mit dem Python v2-Programmiermodell können Sie Bindungen mithilfe von Decorators direkt im Python-Funktionscode definieren. Weitere Informationen finden Sie im Python Developer-Leitfaden.

Für das Python v1-Programmiermodell müssen Sie Bindungen in einer separaten function.json-Datei im Funktionsordner definieren. Weitere Informationen finden Sie im Python Developer-Leitfaden.

Mit diesem Code wird ILogger definiert und initialisiert:

private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

public ServiceBusReceivedMessageFunctions(ILogger<ServiceBusReceivedMessageFunctions> logger)
{
    _logger = logger;
}

Dieses Beispiel zeigt eine C#-Funktion, die eine Nachricht empfängt und sie in eine zweite Warteschlange schreibt:

[Function(nameof(ServiceBusReceivedMessageFunction))]
[ServiceBusOutput("outputQueue", Connection = "ServiceBusConnection")]
public string ServiceBusReceivedMessageFunction(
    [ServiceBusTrigger("queue", Connection = "ServiceBusConnection")] ServiceBusReceivedMessage message)
{
    _logger.LogInformation("Message ID: {id}", message.MessageId);
    _logger.LogInformation("Message Body: {body}", message.Body);
    _logger.LogInformation("Message Content-Type: {contentType}", message.ContentType);

    var outputMessage = $"Output message created at {DateTime.Now}";
    return outputMessage;
}

In diesem Beispiel wird ein HTTP-Trigger mit einem OutputType Objekt verwendet, um eine HTTP-Antwort zu senden und die Ausgabenachricht zu schreiben.

[Function("HttpSendMsg")]
public async Task<OutputType> Run([HttpTrigger(AuthorizationLevel.Function, "get", "post")] HttpRequestData req, FunctionContext context)
{
   _logger.LogInformation($"C# HTTP trigger function processed a request for {context.InvocationId}.");

   HttpResponseData response = req.CreateResponse(HttpStatusCode.OK);
   await response.WriteStringAsync("HTTP response: Message sent");

   return new OutputType()
   {
       OutputEvent = "MyMessage",
       HttpResponse = response
   };
}

Dieser Code definiert den mehrfachen Ausgabetyp OutputType, der die Definition der ServiceBus-Ausgabebindung für OutputEventFolgendes enthält:

 public class OutputType
{
   [ServiceBusOutput("TopicOrQueueName", Connection = "ServiceBusConnection")]
   public string OutputEvent { get; set; }

   public HttpResponseData HttpResponse { get; set; }
}

Das folgende Beispiel zeigt eine C#-Funktion, die eine Service Bus-Warteschlangennachricht sendet:

[FunctionName("ServiceBusOutput")]
[return: ServiceBus("myqueue", Connection = "ServiceBusConnection")]
public static string ServiceBusOutput([HttpTrigger] dynamic input, ILogger log)
{
    log.LogInformation($"C# function processed: {input.Text}");
    return input.Text;
}

Anstatt die Return-Anweisung zum Senden der Nachricht zu verwenden, gibt diese HTTP-Triggerfunktion eine HTTP-Antwort zurück, die sich von der Ausgabenachricht unterscheidet.

[FunctionName("HttpTrigger1")]
public static async Task<IActionResult> Run(
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post", Route = null)] HttpRequest req, 
[ServiceBus("TopicOrQueueName", Connection = "ServiceBusConnection")] IAsyncCollector<string> message, ILogger log)
{
    log.LogInformation("C# HTTP trigger function processed a request.");

    await message.AddAsync("MyMessage");
    await message.AddAsync("MyMessage2");

    string responseMessage = "This HTTP triggered sent a message to Service Bus.";

    return new OkObjectResult(responseMessage);
}

Das folgende Beispiel zeigt eine durch einen Timer ausgelöste TypeScript-Funktion, die alle 5 Minuten eine Warteschlangennachricht sendet.

import { app, InvocationContext, output, Timer } from '@azure/functions';

export async function timerTrigger1(myTimer: Timer, context: InvocationContext): Promise<string> {
    const timeStamp = new Date().toISOString();
    return `Message created at: ${timeStamp}`;
}

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: output.serviceBusQueue({
        queueName: 'testqueue',
        connection: 'MyServiceBusConnection',
    }),
    handler: timerTrigger1,
});

Um mehrere Nachrichten auszugeben, geben Sie ein Array anstelle eines einzelnen Objekts zurück. Beispiel:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

TypeScript-Beispiele sind für Modell v3 nicht dokumentiert.

Das folgende Beispiel zeigt eine durch einen Timer ausgelöste JavaScript-Funktion, die alle 5 Minuten eine Warteschlangennachricht sendet.

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

const serviceBusOutput = output.serviceBusQueue({
    queueName: 'testqueue',
    connection: 'MyServiceBusConnection',
});

app.timer('timerTrigger1', {
    schedule: '0 */5 * * * *',
    return: serviceBusOutput,
    handler: (myTimer, context) => {
        const timeStamp = new Date().toISOString();
        return `Message created at: ${timeStamp}`;
    },
});

Um mehrere Nachrichten auszugeben, geben Sie ein Array anstelle eines einzelnen Objekts zurück. Beispiel:

const timeStamp = new Date().toISOString();
const message = `Message created at: ${timeStamp}`;
return [`1: ${message}`, `2: ${message}`];

Das folgende Beispiel zeigt eine Service Bus-Ausgabebindung in einer Datei vom Typ function.json sowie eine JavaScript-Funktion, die die Bindung verwendet. Die Funktion verwendet einen Timertrigger, um alle 15 Sekunden eine Warteschlangennachricht zu senden.

Bindungsdaten in der Datei function.json:

{
    "bindings": [
        {
            "schedule": "0/15 * * * * *",
            "name": "myTimer",
            "runsOnStartup": true,
            "type": "timerTrigger",
            "direction": "in"
        },
        {
            "name": "outputSbQueue",
            "type": "serviceBus",
            "queueName": "testqueue",
            "connection": "MyServiceBusConnection",
            "direction": "out"
        }
    ],
    "disabled": false
}

Der folgende JavaScript-Skriptcode erstellt eine einzelne Nachricht:

module.exports = async function (context, myTimer) {
    var message = 'Service Bus queue message created at ' + timeStamp;
    context.log(message);   
    context.bindings.outputSbQueue = message;
};

Der folgende JavaScript-Skriptcode mehrere Nachrichten:

module.exports = async function (context, myTimer) {
    var message = 'Service Bus queue message created at ' + timeStamp;
    context.log(message);   
    context.bindings.outputSbQueue = [];
    context.bindings.outputSbQueue.push("1 " + message);
    context.bindings.outputSbQueue.push("2 " + message);
};

import logging
import azure.functions as func

app = func.FunctionApp()

@app.route(route="put_message")
@app.service_bus_topic_output(arg_name="message",
                              connection="<CONNECTION_SETTING>",
                              topic_name="<TOPIC_NAME>")
def main(req: func.HttpRequest, message: func.Out[str]) -> func.HttpResponse:
    input_msg = req.params.get('message')
    message.set(input_msg)
    return 'OK'

Eine Service Bus-Bindungsdefinition ist in function.json definiert, wobei type auf serviceBus festgelegt ist.

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "authLevel": "function",
      "type": "httpTrigger",
      "direction": "in",
      "name": "req",
      "methods": [
        "get",
        "post"
      ]
    },
    {
      "type": "http",
      "direction": "out",
      "name": "$return"
    },
    {
      "type": "serviceBus",
      "direction": "out",
      "connection": "AzureServiceBusConnectionString",
      "name": "msg",
      "queueName": "outqueue"
    }
  ]
}

In _init_.py können Sie eine Nachricht in die Warteschlange schreiben, indem Sie einen Wert an die set-Methode übergeben.

import azure.functions as func

def main(req: func.HttpRequest, msg: func.Out[str]) -> func.HttpResponse:

    input_msg = req.params.get('message')

    msg.set(input_msg)

    return 'OK'

Verwenden Sie in C#-Klassenbibliotheken das Attribut ServiceBusOutputAttribute, um die Warteschlange oder das Thema zu definieren, in die bzw. in das von der Ausgabe geschrieben wird.

In der folgenden Tabelle werden die Eigenschaften erläutert, die mithilfe des Attributs festgelegt werden können:

In C#-Klassenbibliotheken verwenden Sie die ServiceBusAttribute.

In der folgenden Tabelle werden die Eigenschaften erläutert, die mithilfe des Attributs festgelegt werden können:

Das folgende Beispiel zeigt, wie das Attribut auf den Rückgabewert der Funktion angewendet wird:

[FunctionName("ServiceBusOutput")]
[return: ServiceBus("myqueue")]
public static string Run([HttpTrigger] dynamic input, ILogger log)
{
    ...
}

Sie können die Eigenschaft Connection festlegen, um den Namen einer App-Einstellung anzugeben, die die zu verwendende Service Bus-Verbindungszeichenfolge enthält, wie im folgenden Beispiel gezeigt:

[FunctionName("ServiceBusOutput")]
[return: ServiceBus("myqueue", Connection = "ServiceBusConnection")]
public static string Run([HttpTrigger] dynamic input, ILogger log)
{
    ...
}

Ein vollständiges Beispiel finden Sie unter Beispiel.

Mit dem Attribut ServiceBusAccount können Sie das zu verwendende Service Bus-Konto auf Klassen-, Methoden- oder Parameterebene angeben. Weitere Informationen finden Sie in der Triggerreferenz unter Attribute.

In der folgenden Tabelle werden die Eigenschaften erläutert, die Sie für das options-Objekt festlegen können, das an die output.serviceBusQueue()-Methode übergeben wurde.

In der folgenden Tabelle werden die Eigenschaften erläutert, die Sie für das options-Objekt festlegen können, das an die output.serviceBusTopic()-Methode übergeben wurde.

Die folgende Tabelle gibt Aufschluss über die Bindungskonfigurationseigenschaften, die Sie in der Datei function.json festlegen.

Verwenden Sie den Typ ServiceBusMessage, wenn Sie Nachrichten mit Metadaten senden. Parameter werden als Attribute vom Typ return definiert. Verwenden Sie ICollector<T> oder IAsyncCollector<T>, um mehrere Nachrichten zu schreiben. Beim Aufrufen der Add -Methode wird eine Nachricht erstellt.

Wenn der Parameterwert am Ende der Funktion NULL ist, wird keine Nachricht erstellt.

Sie können auch ServiceBusAccountAttribute verwenden, um das zu verwendende Service Bus-Konto anzugeben. Der Konstruktor nimmt den Namen einer App-Einstellung mit einer Service Bus-Verbindungszeichenfolge an. Das Attribut kann auf Parameter-, Methoden- oder Klassenebene angewendet werden. Das folgende Beispiel zeigt die Anwendung auf Klassen- und Methodenebene:

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

Das zu verwendende Service Bus-Konto wird in der folgendem Reihenfolge bestimmt:

• Die Eigenschaft Connection des Attributs ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf den gleichen Parameter angewendet wird wie das Attribut ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf die Funktion angewendet wird.
• Das Attribut ServiceBusAccount, das auf die Klasse angewendet wird.
• Die App-Einstellung AzureWebJobsServiceBus.

Verwenden Sie den Typ Message, wenn Sie Nachrichten mit Metadaten senden. Parameter werden als Attribute vom Typ return definiert. Verwenden Sie ICollector<T> oder IAsyncCollector<T>, um mehrere Nachrichten zu schreiben. Beim Aufrufen der Add -Methode wird eine Nachricht erstellt.

Am 30. September 2026 werden die Azure Service Bus SDK-Bibliotheken „WindowsAzure.ServiceBus“, „Microsoft.Azure.ServiceBus“ und „com.microsoft.azure.servicebus“ eingestellt, da sie nicht den Azure SDK-Richtlinien entsprechen. Außerdem wird die Unterstützung des SBMP-Protokolls beendet, sodass Sie dieses Protokoll nach dem 30. September 2026 nicht mehr verwenden können. Migrieren Sie vor diesem Datum zu den neuesten Azure SDK-Bibliotheken, die wichtige Sicherheitsupdates und verbesserte Funktionen bieten.

Obwohl die älteren Bibliotheken noch über den 30. September 2026 hinaus verwendet werden können, erhalten sie keinen offiziellen Support und keine Updates mehr von Microsoft. Weitere Informationen finden Sie in der Ankündigung der Supporteinstellung.

Wenn der Parameterwert am Ende der Funktion NULL ist, wird keine Nachricht erstellt.

Sie können auch ServiceBusAccountAttribute verwenden, um das zu verwendende Service Bus-Konto anzugeben. Der Konstruktor nimmt den Namen einer App-Einstellung mit einer Service Bus-Verbindungszeichenfolge an. Das Attribut kann auf Parameter-, Methoden- oder Klassenebene angewendet werden. Das folgende Beispiel zeigt die Anwendung auf Klassen- und Methodenebene:

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

Das zu verwendende Service Bus-Konto wird in der folgendem Reihenfolge bestimmt:

• Die Eigenschaft Connection des Attributs ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf den gleichen Parameter angewendet wird wie das Attribut ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf die Funktion angewendet wird.
• Das Attribut ServiceBusAccount, das auf die Klasse angewendet wird.
• Die App-Einstellung AzureWebJobsServiceBus.

Verwenden Sie den Typ BrokeredMessage, wenn Sie Nachrichten mit Metadaten senden. Parameter werden als Attribute vom Typ return definiert. Wenn der Parameterwert am Ende der Funktion NULL ist, wird keine Nachricht erstellt.

Sie können auch ServiceBusAccountAttribute verwenden, um das zu verwendende Service Bus-Konto anzugeben. Der Konstruktor nimmt den Namen einer App-Einstellung mit einer Service Bus-Verbindungszeichenfolge an. Das Attribut kann auf Parameter-, Methoden- oder Klassenebene angewendet werden. Das folgende Beispiel zeigt die Anwendung auf Klassen- und Methodenebene:

[ServiceBusAccount("ClassLevelServiceBusAppSetting")]
public static class AzureFunctions
{
    [ServiceBusAccount("MethodLevelServiceBusAppSetting")]
    [FunctionName("ServiceBusQueueTriggerCSharp")]
    public static void Run(
        [ServiceBusTrigger("myqueue", AccessRights.Manage)] 
        string myQueueItem, ILogger log)
{
    ...
}

Das zu verwendende Service Bus-Konto wird in der folgendem Reihenfolge bestimmt:

• Die Eigenschaft Connection des Attributs ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf den gleichen Parameter angewendet wird wie das Attribut ServiceBusTrigger.
• Das Attribut ServiceBusAccount, das auf die Funktion angewendet wird.
• Das Attribut ServiceBusAccount, das auf die Klasse angewendet wird.
• Die App-Einstellung AzureWebJobsServiceBus.

Wenn die Funktion eine einzelne Nachricht schreiben soll, kann die Service Bus-Ausgabebindung an die folgenden Typen gebunden werden:

Wenn die Funktion mehrere Nachrichten schreiben soll, kann die Service Bus-Ausgabebindung an die folgenden Typen gebunden werden:

Erstellen und verwenden Sie für andere Ausgabeszenarien einen ServiceBusClient mit anderen Typen von Azure.Messaging.ServiceBus direkt. Ein Beispiel für die Verwendung der Abhängigkeitsinjektion zum Erstellen eines Clienttyps aus dem Azure SDK finden Sie unter Registrieren von Azure-Clients .

Frühere Versionen dieser Erweiterung im isolierten Workerprozess haben nur die Bindung an nachrichtenspezifische Typen unterstützt. Weitere Optionen sind für die Erweiterung 5.x und höher verfügbar.

Die Azure Functions-Version 1.x unterstützt keine isolierten Workerprozesse. Um das isolierte Workermodell zu verwenden, aktualisieren Sie Ihre Anwendung auf Functions 4.x.

Auf die Ausgabemeldung greifen Sie zu, indem Sie den Wert direkt zurückgeben oder context.extraOutputs.set() verwenden.

Greifen Sie mithilfe von context.bindings.<name> auf die Ausgabemeldung zu, wobei <name> der in der Eigenschaft name von function.json angegebene Wert ist.