Azure Functions の Azure Queue storage トリガー

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

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

次の例は、キュー項目が処理されるたびに キューをポーリングし、いくつかのメッセージを出力キューに書き込む input-queueを示しています。

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)
{
    // Use a string array to return more than one message.
    string[] messages = {
        $"Album name = {myQueueItem.Name}",
        $"Album songs = {myQueueItem.Songs}"};

    _logger.LogInformation("{msg1},{msg2}", messages[0], messages[1]);

    // Queue Output messages
    return messages;
}

次の例は、キュー項目が処理されるたびに キューをポーリングし、ログを書き込む myqueue-itemsを示しています。

public static class QueueFunctions
{
    [FunctionName("QueueTrigger")]
    public static void QueueTrigger(
        [QueueTrigger("myqueue-items")] string myQueueItem, 
        ILogger log)
    {
        log.LogInformation($"C# function processed: {myQueueItem}");
    }
}

次の例は、キュー トリガーの TypeScript 関数を示しています。 この関数は、キュー項目が処理されるたびに myqueue-items キューをポーリングし、ログを書き込みます。

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

export async function storageQueueTrigger1(queueItem: unknown, context: InvocationContext): Promise<void> {
    context.log('Storage queue function processed work item:', queueItem);
    context.log('expirationTime =', context.triggerMetadata.expirationTime);
    context.log('insertionTime =', context.triggerMetadata.insertionTime);
    context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
    context.log('id =', context.triggerMetadata.id);
    context.log('popReceipt =', context.triggerMetadata.popReceipt);
    context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
}

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: storageQueueTrigger1,
});

ここに表示されているその他すべての変数については、「メッセージのメタデータ」セクションを参照してください。

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

次の例は、キュー トリガーの JavaScript 関数を示しています。 この関数は、キュー項目が処理されるたびに myqueue-items キューをポーリングし、ログを書き込みます。

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

app.storageQueue('storageQueueTrigger1', {
    queueName: 'myqueue-items',
    connection: 'MyStorageConnectionAppSetting',
    handler: (queueItem, context) => {
        context.log('Storage queue function processed work item:', queueItem);
        context.log('expirationTime =', context.triggerMetadata.expirationTime);
        context.log('insertionTime =', context.triggerMetadata.insertionTime);
        context.log('nextVisibleTime =', context.triggerMetadata.nextVisibleTime);
        context.log('id =', context.triggerMetadata.id);
        context.log('popReceipt =', context.triggerMetadata.popReceipt);
        context.log('dequeueCount =', context.triggerMetadata.dequeueCount);
    },
});

使用セクションでは queueItem について説明しています。 ここに表示されているその他すべての変数については、「メッセージのメタデータ」セクションを参照してください。

次の例は、function.json ファイルのキュー トリガー バインドと、そのバインドを使用する JavaScript 関数を示しています。 この関数は、キュー項目が処理されるたびに myqueue-items キューをポーリングし、ログを書き込みます。

function.json ファイルを次に示します。

{
    "disabled": false,
    "bindings": [
        {
            "type": "queueTrigger",
            "direction": "in",
            "name": "myQueueItem",
            "queueName": "myqueue-items",
            "connection":"MyStorageConnectionAppSetting"
        }
    ]
}

これらのプロパティについては、「構成」セクションを参照してください。

JavaScript コードを次に示します。

module.exports = async function (context, message) {
    context.log('Node.js queue trigger function processed work item', message);
    // OR access using context.bindings.<name>
    // context.log('Node.js queue trigger function processed work item', context.bindings.myQueueItem);
    context.log('expirationTime =', context.bindingData.expirationTime);
    context.log('insertionTime =', context.bindingData.insertionTime);
    context.log('nextVisibleTime =', context.bindingData.nextVisibleTime);
    context.log('id =', context.bindingData.id);
    context.log('popReceipt =', context.bindingData.popReceipt);
    context.log('dequeueCount =', context.bindingData.dequeueCount);
};

function.json の プロパティで名前が指定された myQueueItem については、「name」セクションを参照してください。 ここに表示されているその他すべての変数については、「メッセージのメタデータ」セクションを参照してください。

import logging
import azure.functions as func

app = func.FunctionApp()

@app.function_name(name="QueueFunc")
@app.queue_trigger(arg_name="msg", queue_name="inputqueue",
                   connection="storageAccountConnectionString")  # Queue trigger
@app.queue_output(arg_name="outputQueueItem", queue_name="outqueue",
                 connection="storageAccountConnectionString")  # Queue output binding
def test_function(msg: func.QueueMessage,
                  outputQueueItem: func.Out[str]) -> None:
    logging.info('Python queue trigger function processed a queue item: %s',
                 msg.get_body().decode('utf-8'))
    outputQueueItem.set('hello')

ストレージ キュー トリガーは function.json で定義され、そこで type は queueTrigger に設定されます。

{
  "scriptFile": "__init__.py",
  "bindings": [
    {
      "name": "msg",
      "type": "queueTrigger",
      "direction": "in",
      "queueName": "messages",
      "connection": "AzureStorageQueuesConnectionString"
    }
  ]
}

_init_.py のコードによってパラメーターが func.QueueMessage として宣言され、関数でキュー メッセージを読み取ることができるようになります。

import logging
import json

import azure.functions as func

def main(msg: func.QueueMessage):
    logging.info('Python queue trigger function processed a queue item.')

    result = json.dumps({
        'id': msg.id,
        'body': msg.get_body().decode('utf-8'),
        'expiration_time': (msg.expiration_time.isoformat()
                            if msg.expiration_time else None),
        'insertion_time': (msg.insertion_time.isoformat()
                           if msg.insertion_time else None),
        'time_next_visible': (msg.time_next_visible.isoformat()
                              if msg.time_next_visible else None),
        'pop_receipt': msg.pop_receipt,
        'dequeue_count': msg.dequeue_count
    })

    logging.info(result)

C# クラス ライブラリでは、次の例のように、属性のコンストラクターは監視するキューの名前を受け取ります。

[Function(nameof(QueueInputOutputFunction))]
[QueueOutput("output-queue")]
public string[] QueueInputOutputFunction([QueueTrigger("input-queue")] Album myQueueItem, FunctionContext context)

この例では、属性自体に接続文字列設定を設定する方法も示しています。

C# クラス ライブラリでは、次の例のように、属性のコンストラクターは監視するキューの名前を受け取ります。

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items")] string myQueueItem, 
    ILogger log)
{
    ...
}

次の例で示すように、Connection プロパティを設定して、使用するストレージ アカウント接続ストリングを含むアプリ設定を指定できます。

[FunctionName("QueueTrigger")]
public static void Run(
    [QueueTrigger("myqueue-items", Connection = "StorageConnectionAppSetting")] string myQueueItem, 
    ILogger log)
{
    ....
}

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

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

分離ワーカー プロセス クラス ライブラリは、ランタイムから分離されたプロセスで実行されるコンパイル済みの C# 関数です。

インプロセス クラス ライブラリは、Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数です。

string paramName のようなメソッド パラメーターを使用してメッセージ データにアクセスします。 paramName は QueueTriggerAttribute で指定された値です。 次の型のいずれにでもバインドできます。

• Plain-old .NET CLR オブジェクト (POCO)
• string
• byte[]
• QueueMessage

オブジェクトにバインドすると、Functions ランタイムにより、JSON ペイロードを、コードに定義されている任意のクラスのインスタンスへと逆シリアル化する処理が試行されます。 QueueMessage の使用例については、拡張機能の GitHub リポジトリに関するページを参照してください。

属性は Connection プロパティを受け取りますが、 Connection を使用してストレージ アカウント接続を指定することもできます。 これは、ライブラリ内の他の関数とは異なるストレージ アカウントを使用する必要がある場合に実行できます。 コンストラクターは、ストレージ接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

使用するストレージ アカウントは、次の順序で決定されます。

• トリガーまたはバインド属性の Connection プロパティ。
• トリガーまたはバインド属性と同じパラメーターに適用された StorageAccount 属性。
• 関数に適用される StorageAccount 属性。
• クラスに適用される StorageAccount 属性。
• AzureWebJobsStorage アプリケーション設定で定義されている、関数アプリの既定のストレージ アカウント。

string paramName のようなメソッド パラメーターを使用してメッセージ データにアクセスします。 paramName は QueueTriggerAttribute で指定された値です。 次の型のいずれにでもバインドできます。

• プレーンオールド CLR オブジェクト (POCO)
• string
• byte[]
• CloudQueueMessage

オブジェクトにバインドすると、Functions ランタイムにより、JSON ペイロードを、コードに定義されている任意のクラスのインスタンスへと逆シリアル化する処理が試行されます。 CloudQueueMessage にバインドしようとしてエラー メッセージが表示された場合は、適切な Storage SDK バージョンへの参照があることを確認してください。

属性は Connection プロパティを受け取りますが、 Connection を使用してストレージ アカウント接続を指定することもできます。 これは、ライブラリ内の他の関数とは異なるストレージ アカウントを使用する必要がある場合に実行できます。 コンストラクターは、ストレージ接続文字列を含むアプリ設定の名前を受け取ります。 属性は、パラメーター、メソッド、またはクラス レベルで適用できます。 次の例では、クラス レベルとメソッド レベルを示します。

[StorageAccount("ClassLevelStorageAppSetting")]
public static class AzureFunctions
{
    [FunctionName("StorageTrigger")]
    [StorageAccount("FunctionLevelStorageAppSetting")]
    public static void Run( //...
{
    ...
}

使用するストレージ アカウントは、次の順序で決定されます。

• トリガーまたはバインド属性の Connection プロパティ。
• トリガーまたはバインド属性と同じパラメーターに適用された StorageAccount 属性。
• 関数に適用される StorageAccount 属性。
• クラスに適用される StorageAccount 属性。
• AzureWebJobsStorage アプリケーション設定で定義されている、関数アプリの既定のストレージ アカウント。

キュー トリガーは、次の型にバインドできます。

¹ これらの型を使用するには、Microsoft.Azure.Functions.Worker.Extensions.Storage.Queues 5.2.0 以降と SDK 型バインドの一般的な依存関係に関する記事を参照する必要があります。

分離ワーカー プロセスのこれまでのバージョンの拡張機能では、文字列へのバインドのみがサポートされていました。 Extension 5.x+ では、その他のオプションを使用できます。

関数の最初の引数としてキュー項目にアクセスします。 ペイロードが JSON の場合、値はオブジェクトに逆シリアル化されます。

キュー トリガーの入力を入力するには、 app.storageQueue<string>(...) のジェネリック型パラメーターを使用します。 ジェネリックを使用しない場合、入力パラメーターの既定値は unknown になります。値を使用するには、明示的な型の縮小が必要です。 ジェネリック型のサポートには、バージョン 4.11.0 以降 @azure/functions 必要があります。

context.bindings.<NAME> で定義されている値と <NAME> が 一致する を使用してキュー項目にアクセスします。 ペイロードが JSON の場合、値はオブジェクトに逆シリアル化されます。

関数の最初の引数としてキュー項目にアクセスします。 ペイロードが JSON の場合、値はオブジェクトに逆シリアル化されます。

context.bindings.<NAME> で定義されている値と <NAME> が 一致する を使用してキュー項目にアクセスします。 ペイロードが JSON の場合、値はオブジェクトに逆シリアル化されます。