Azure Functions における Azure Service Bus の出力バインド

Python v2 プログラミング モデルでは、Python 関数コードでデコレーターを使用してバインドを直接定義できます。 詳細については、「Python 開発者ガイド」を参照してください。

Python v1 プログラミング モデルでは、関数フォルダー内の個別の function.json ファイルでバインドを定義する必要があります。 詳細については、「Python 開発者ガイド」を参照してください。

このコードにより、ILogger が定義され初期化されます。

private readonly ILogger<ServiceBusReceivedMessageFunctions> _logger;

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

この例では、メッセージを受信して 2 番目のキューに書き込む C# 関数を示します。

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

この例では、HTTP トリガーと OutputType オブジェクトを使用して、HTTP 応答を送信し、出力メッセージを書き込みます。

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

このコードでは、OutputEventの Service Bus 出力バインド定義を含む複数の出力の種類OutputTypeを定義します。

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

   public HttpResponseData HttpResponse { get; set; }
}

次の例は、Service Bus キュー メッセージを送信する C# 関数を示しています。

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

return ステートメントを使用してメッセージを送信する代わりに、この HTTP トリガー関数は出力メッセージとは異なる HTTP 応答を返します。

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

次の例は、タイマーでトリガーされた、5 分ごとにキュー メッセージを送信する TypeScript 関数を示しています。

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

複数のメッセージを出力するには、1 つのオブジェクトではなく配列を返します。 次に例を示します。

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

TypeScript のサンプルは、モデル v3 については記載されていません。

次の例は、タイマーでトリガーされた、5 分ごとにキュー メッセージを送信する JavaScript 関数を示しています。

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

複数のメッセージを出力するには、1 つのオブジェクトではなく配列を返します。 次に例を示します。

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

次の例は、function.json ファイルの Service Bus 出力バインドと、そのバインドを使用する JavaScript スクリプト関数を示しています。 この関数は、タイマー トリガーを使用して、15 秒ごとにキュー メッセージを送信します。

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
}

単一のメッセージを作成する JavaScript スクリプト コードを次に示します。

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

複数のメッセージを作成する JavaScript スクリプト コードを次に示します。

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'

Service Bus のバインディング定義は function.json で定義され、そこで type は 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"
    }
  ]
}

_init_.py で、値を 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'

C# クラス ライブラリでは、ServiceBusOutputAttribute を使って、出力によって書き込まれるキューまたはトピックを定義します。

次の表では、この属性を使用して設定できるプロパティについて説明します。

C# クラス ライブラリでは、ServiceBusAttribute 属性を使用します。

次の表では、この属性を使用して設定できるプロパティについて説明します。

関数の戻り値に適用される属性に適用される属性を示す例は次のとおりです。

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

次の例で示すように、Connection プロパティを設定して、使用する Service Bus 接続文字列を含むアプリ設定の名前を指定できます。

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

完全な例については、「例」を参照してください。

ServiceBusAccount 属性を使用して、クラス、メソッド、またはパラメーターのレベルで使用する Service Bus アカウントを指定できます。 詳細については、トリガー リファレンスの「属性」を参照してください。

次の表では、output.serviceBusQueue() メソッドに渡される options オブジェクトに対して設定できるプロパティについて説明します。

次の表では、output.serviceBusTopic() メソッドに渡される options オブジェクトに対して設定できるプロパティについて説明します。

次の表は、function.json ファイルで設定したバインド構成のプロパティを説明しています。

メタデータを含むメッセージを送信する場合は、ServiceBusMessage 型を使います。 パラメーターは return 型の属性として定義されます。 複数のメッセージを書き込むには、ICollector<T> または IAsyncCollector<T> を使います。 Add メソッドを呼び出すときに、メッセージが作成されます。

関数が終了したときにパラメーター値が null の場合、Functions はメッセージを作成しません。

ServiceBusAccountAttribute 属性を使用して、使用する Service Bus アカウントを指定することもできます。 コンストラクターは、Service Bus 接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

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

使用する Service Bus アカウントは、次の順序で決定されます。

• ServiceBusTrigger 属性の Connection プロパティ。
• ServiceBusTrigger 属性と同じパラメーターに適用された ServiceBusAccount 属性。
• 関数に適用される ServiceBusAccount 属性。
• クラスに適用される ServiceBusAccount 属性。
• AzureWebJobsServiceBus アプリ設定。

メタデータを含むメッセージを送信する場合は、Message 型を使います。 パラメーターは return 型の属性として定義されます。 複数のメッセージを書き込むには、ICollector<T> または IAsyncCollector<T> を使います。 Add メソッドを呼び出すときに、メッセージが作成されます。

2026 年 9 月 30 日に、Azure SDK ガイドラインに準拠していない Azure Service Bus SDK ライブラリ WindowsAzure.ServiceBus、Microsoft.Azure.ServiceBus、および com.microsoft.azure.servicebus は廃止されます。 SBMP プロトコルのサポートも終了するため、2026 年 9 月 30 日以降はこのプロトコルを使用できなくなります。 この日付より前に、重要なセキュリティ更新プログラムと強化された機能が提供される、最新の Azure SDK ライブラリに移行してください。

古いライブラリは 2026 年 9 月 30 日以降も引き続き使用できますが、Microsoft から公式のサポートと更新プログラムは提供されなくなります。 詳細については、サポート廃止のお知らせに関するページを参照してください。

関数が終了したときにパラメーター値が null の場合、Functions はメッセージを作成しません。

ServiceBusAccountAttribute 属性を使用して、使用する Service Bus アカウントを指定することもできます。 コンストラクターは、Service Bus 接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

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

使用する Service Bus アカウントは、次の順序で決定されます。

• ServiceBusTrigger 属性の Connection プロパティ。
• ServiceBusTrigger 属性と同じパラメーターに適用された ServiceBusAccount 属性。
• 関数に適用される ServiceBusAccount 属性。
• クラスに適用される ServiceBusAccount 属性。
• AzureWebJobsServiceBus アプリ設定。

メタデータを含むメッセージを送信する場合は、BrokeredMessage 型を使います。 パラメーターは return 型の属性として定義されます。 関数が終了したときにパラメーター値が null の場合、Functions はメッセージを作成しません。

ServiceBusAccountAttribute 属性を使用して、使用する Service Bus アカウントを指定することもできます。 コンストラクターは、Service Bus 接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

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

使用する Service Bus アカウントは、次の順序で決定されます。

• ServiceBusTrigger 属性の Connection プロパティ。
• ServiceBusTrigger 属性と同じパラメーターに適用された ServiceBusAccount 属性。
• 関数に適用される ServiceBusAccount 属性。
• クラスに適用される ServiceBusAccount 属性。
• AzureWebJobsServiceBus アプリ設定。

関数で 1 つのメッセージを書き込む場合、Service Bus の出力バインドは次の型にバインドできます

関数で複数のメッセージを書き込む場合、Service Bus の出力バインドは次の型にバインドできます。

その他の出力シナリオでは、 ServiceBusClient Azure.Messaging.ServiceBus の他の型 を直接作成して使用します。 依存関係の挿入を使用して Azure SDK からクライアントの種類を作成する例については Azure クライアントの登録に関するページを参照してください。

分離ワーカー プロセスのこれまでのバージョンの拡張機能では、メッセージング固有の型へのバインドのみがサポートされています。 Extension 5.x 以降では、その他のオプションを使用できます

Functions バージョン 1.x では、分離ワーカー プロセスはサポートされていません。 分離ワーカー モデルを使用するには、アプリケーションを Functions 4.x にアップグレードしてください。

値を直接返すか、context.extraOutputs.set() を使って、出力メッセージにアクセスします。

context.bindings.<name> を使って出力メッセージにアクセスします。ここで、<name> は、function.json の name プロパティで指定された値です。