Výstupní vazba služby Azure Service Bus pro Azure Functions

Programovací model Pythonu v2 umožňuje definovat vazby pomocí dekorátorů přímo v kódu funkce Pythonu. Další informace najdete v příručce pro vývojáře Pythonu.

Programovací model Pythonu v1 vyžaduje, abyste definovali vazby v samostatném souboru function.json ve složce funkce. Další informace najdete v příručce pro vývojáře Pythonu.

Tento kód definuje a inicializuje ILogger:

private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

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

Tento příklad ukazuje funkci jazyka C#, která obdrží zprávu a zapíše ji do druhé fronty:

[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;
}

Tento příklad používá trigger HTTP s OutputType objektem k odeslání odpovědi HTTP i zápisu výstupní zprávy.

[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
   };
}

Tento kód definuje více výstupních typů OutputType, které zahrnují definici výstupní vazby služby Service Bus na OutputEvent:

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

   public HttpResponseData HttpResponse { get; set; }
}

Následující příklad ukazuje funkci jazyka C#, která odesílá zprávu fronty služby Service Bus:

[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;
}

Místo použití příkazu return k odeslání zprávy vrátí tato funkce triggeru HTTP odpověď HTTP, která se liší od výstupní zprávy.

[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);
}

Následující příklad ukazuje časovač aktivovanou funkci TypeScript, která každých 5 minut odesílá zprávu fronty.

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,
});

Pokud chcete vytvořit výstup více zpráv, vraťte místo jednoho objektu pole. Příklad:

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

Ukázky TypeScriptu nejsou zdokumentované pro model v3.

Následující příklad ukazuje časovač aktivovanou javascriptovou funkci , která každých 5 minut odesílá zprávu fronty.

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}`;
    },
});

Pokud chcete vytvořit výstup více zpráv, vraťte místo jednoho objektu pole. Příklad:

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

Následující příklad ukazuje výstupní vazbu služby Service Bus v souboru function.json a funkci JavaScriptu, která používá vazbu. Funkce používá trigger časovače k odeslání zprávy fronty každých 15 sekund.

Tady jsou data vazby v souboru 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
}

Tady je kód skriptu JavaScriptu, který vytvoří jednu zprávu:

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

Tady je kód skriptu JavaScriptu, který vytváří více zpráv:

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'

Definice vazby služby Service Bus je definována v function.json, kde je typ nastaven na serviceBus .

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

V _init_.py můžete do fronty zapsat zprávu předáním hodnoty metodě set .

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'

V knihovnách tříd jazyka C# použijte ServiceBusOutputAttribute k definování fronty nebo tématu zapsaného výstupem.

Následující tabulka vysvětluje vlastnosti, které můžete nastavit pomocí atributu:

V knihovnách tříd jazyka C# použijte ServiceBusAttribute.

Následující tabulka vysvětluje vlastnosti, které můžete nastavit pomocí atributu:

Tady je příklad, který ukazuje atribut použitý na návratovou hodnotu funkce:

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

Vlastnost můžete nastavit Connection tak, aby určila název nastavení aplikace, které obsahuje připojovací řetězec služby Service Bus, které se má použít, jak je znázorněno v následujícím příkladu:

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

Úplný příklad najdete v příkladu.

Atribut můžete použít ServiceBusAccount k určení účtu služby Service Bus, který se má použít na úrovni třídy, metody nebo parametru. Další informace naleznete v tématu Atributy v odkazu na aktivační událost.

Následující tabulka vysvětluje vlastnosti, které můžete nastavit u objektu předaného options metodě output.serviceBusQueue() .

Následující tabulka vysvětluje vlastnosti, které můžete nastavit u objektu předaného options metodě output.serviceBusTopic() .

Následující tabulka vysvětluje vlastnosti konfigurace vazby, které jste nastavili v souboru function.json .

Při odesílání zpráv s metadaty použijte typ ServiceBusMessage. Parametry jsou definovány jako return atributy typu. ICollector<T> Slouží k psaní více zpráv nebo IAsyncCollector<T> k psaní více zpráv. Při volání Add metody se vytvoří zpráva.

Pokud je hodnota parametru při ukončení funkce null, funkce nevytvoří zprávu.

Pomocí atributu ServiceBusAccountAttribute můžete také zadat účet služby Service Bus, který se má použít. Konstruktor přebírá název nastavení aplikace, které obsahuje připojovací řetězec služby Service Bus. Atribut lze použít na úrovni parametru, metody nebo třídy. Následující příklad ukazuje úroveň třídy a úroveň metody:

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

Účet služby Service Bus, který se má použít, se určuje v následujícím pořadí:

• Vlastnost ServiceBusTrigger atributu Connection .
• Atribut ServiceBusAccount použitý na stejný parametr jako ServiceBusTrigger atribut.
• Atribut ServiceBusAccount použitý na funkci.
• Atribut ServiceBusAccount použitý pro třídu.
• Nastavení AzureWebJobsServiceBus aplikace.

Při odesílání zpráv s metadaty použijte typ zprávy. Parametry jsou definovány jako return atributy typu. ICollector<T> Slouží k psaní více zpráv nebo IAsyncCollector<T> k psaní více zpráv. Při volání Add metody se vytvoří zpráva.

30. září 2026 vyřadíme knihovny sady SDK služby Azure Service Bus pro WindowsAzure.ServiceBus, Microsoft.Azure.ServiceBus a com.microsoft.azure.servicebus, které nevyhovují pokynům sady Azure SDK. Také ukončíme podporu protokolu SBMP, takže tento protokol už nebudete moct používat po 30. září 2026. Před tímto datem migrujte na nejnovější knihovny sady Azure SDK, které nabízejí důležité aktualizace zabezpečení a vylepšené funkce.

I když starší knihovny je možné používat i po 30. září 2026, nebudou už od Microsoftu dostávat oficiální podporu a aktualizace. Další informace najdete v oznámení o vyřazení podpory.

Pokud je hodnota parametru při ukončení funkce null, funkce nevytvoří zprávu.

Pomocí atributu ServiceBusAccountAttribute můžete také zadat účet služby Service Bus, který se má použít. Konstruktor přebírá název nastavení aplikace, které obsahuje připojovací řetězec služby Service Bus. Atribut lze použít na úrovni parametru, metody nebo třídy. Následující příklad ukazuje úroveň třídy a úroveň metody:

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

Účet služby Service Bus, který se má použít, se určuje v následujícím pořadí:

• Vlastnost ServiceBusTrigger atributu Connection .
• Atribut ServiceBusAccount použitý na stejný parametr jako ServiceBusTrigger atribut.
• Atribut ServiceBusAccount použitý na funkci.
• Atribut ServiceBusAccount použitý pro třídu.
• Nastavení AzureWebJobsServiceBus aplikace.

Při odesílání zpráv s metadaty použijte typ BrokeredMessage. Parametry jsou definovány jako return atributy typu. Pokud je hodnota parametru při ukončení funkce null, funkce nevytvoří zprávu.

Pomocí atributu ServiceBusAccountAttribute můžete také zadat účet služby Service Bus, který se má použít. Konstruktor přebírá název nastavení aplikace, které obsahuje připojovací řetězec služby Service Bus. Atribut lze použít na úrovni parametru, metody nebo třídy. Následující příklad ukazuje úroveň třídy a úroveň metody:

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

Účet služby Service Bus, který se má použít, se určuje v následujícím pořadí:

• Vlastnost ServiceBusTrigger atributu Connection .
• Atribut ServiceBusAccount použitý na stejný parametr jako ServiceBusTrigger atribut.
• Atribut ServiceBusAccount použitý na funkci.
• Atribut ServiceBusAccount použitý pro třídu.
• Nastavení AzureWebJobsServiceBus aplikace.

Pokud chcete, aby funkce zapisuje jednu zprávu, výstupní vazba služby Service Bus může svázat s následujícími typy:

Pokud chcete, aby funkce zapisuje více zpráv, výstupní vazba služby Service Bus může svázat s následujícími typy:

V případě jiných výstupních scénářů můžete přímo vytvářet a používat typy z Azure.Messaging.ServiceBus .

Starší verze tohoto rozšíření v izolovaném pracovním procesu podporují pouze vazbu na typy specifické pro zasílání zpráv. Další možnosti jsou k dispozici pro rozšíření 5.x a vyšší.

Funkce verze 1.x nepodporuje izolovaný pracovní proces. Pokud chcete použít izolovaný pracovní model, upgradujte aplikaci na Functions 4.x.

Přístup k výstupní zprávě vrácením hodnoty přímo nebo pomocí context.extraOutputs.set().

Přístup k výstupní zprávě pomocí where context.bindings.<name> <name> je hodnota zadaná ve name vlastnosti function.json.