Azure Functions における SignalR Service のトリガー バインド

SignalR トリガー バインドを使用して、Azure SignalR Service から送信されたメッセージに応答します。 関数がトリガーされると、関数に渡されるメッセージは JSON オブジェクトとして解析されます。

SignalR Service サーバーレス モードでは、SignalR Service はアップストリーム機能を使用して、クライアントから関数アプリにメッセージを送信します。 また関数アプリでは、SignalR Service トリガー バインドを使用してこれらのメッセージを処理します。 一般的なアーキテクチャを次に示します。

セットアップと構成の詳細については、概要に関するページをご覧ください。

例

[Function(nameof(OnClientMessage))]
public static void OnClientMessage(
    [SignalRTrigger("Hub", "messages", "sendMessage", "content", ConnectionStringSetting = "SignalRConnection")]
        SignalRInvocationContext invocationContext, string content, FunctionContext functionContext)
{
    var logger = functionContext.GetLogger(nameof(OnClientMessage));
    logger.LogInformation("Connection {connectionId} sent a message. Message content: {content}", invocationContext.ConnectionId, content);
}

public class HubName1 : ServerlessHub
{
    [FunctionName("SignalRTest")]
    public Task SendMessage([SignalRTrigger]InvocationContext invocationContext, string message, ILogger logger)
    {
        logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
    }
}

[FunctionName("SignalRTest")]
public static Task Run([SignalRTrigger("SignalRTest", "messages", "SendMessage", parameterNames: new string[] {"message"})]InvocationContext invocationContext, string message, ILogger logger)
{
    logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
}

[FunctionName("SignalRTest")]
public static Task Run([SignalRTrigger("SignalRTest", "messages", "SendMessage")]InvocationContext invocationContext, [SignalRParameter]string message, ILogger logger)
{
    logger.LogInformation($"Receive {message} from {invocationContext.ConnectionId}.");
}

{
    "type": "signalRTrigger",
    "name": "invocation",
    "hubName": "hubName1",
    "category": "messages",
    "event": "SendMessage",
    "parameterNames": [
        "message"
    ],
    "direction": "in"
}

app.generic("function1",
    {
        trigger: { "type": "signalRTrigger", "name": "invocation", "direction": "in", "hubName": "hubName1", "event": "SendMessage", "category": "messages" },
        handler: (triggerInput, context) => {
            context.log(`Receive ${triggerInput.Arguments[0]} from ${triggerInput.ConnectionId}.`)
        }
    })

{
    "type": "signalRTrigger",
    "name": "invocation",
    "hubName": "hubName1",
    "category": "messages",
    "event": "SendMessage",
    "parameterNames": [
        "message"
    ],
    "direction": "in"
}

module.exports = function (context, invocation) {
    context.log(`Receive ${context.bindingData.message} from ${invocation.ConnectionId}.`)
};

import logging
import json
import azure.functions as func

def main(invocation) -> None:
    invocation_json = json.loads(invocation)
    logging.info("Receive {0} from {1}".format(invocation_json['Arguments'][0], invocation_json['ConnectionId']))

完全な例については、セクションの例を参照してください。

使用方法

接続

connectionStringSettingプロパティはアプリケーション設定でキーに設定されており、Functionsランタイムが拡張で使うAzure SignalR Serviceインスタンスに接続するために使う値を返します。 この接続プロパティ設定の値は接続の種類によって異なります。

• マネージド・アイデンティティ接続: connectionStringSetting プロパティは、複数の設定が共有する <CONNECTION_NAME_PREFIX> であり、これらが共にサービスエンドポイントへのアイデンティティベースの接続を定義します。 詳細については、「 同一性接続の定義」を参照してください。
• Key Vault参照:connectionStringSettingプロパティ設定は、接続文字列が中央管理されている場所への参照Azure Key Vaultを返します。 詳細については、「Key Vault connectionsの定義」をご覧ください。
• App Configuration reference:connectionStringSettingプロパティ設定は接続文字列またはKey Vault参照を返すAzure App Configuration参照を返します。 詳細については、接続記事のAzure App Configurationをご覧ください。
• Connection string:connectionStringSettingプロパティ設定は実際のSignalRサービス接続文字列を返します。 接続文字列には共有の秘密鍵が含まれているため、可能であれば管理型アイデンティティ接続の使用を検討すべきです。 詳細については、「 接続の定義」を参照してください。

バインディング接続について詳しく知りたい方は、Azure Functionsの「Manage connection in Connection」をご覧ください。 接続文字列を取得するには、「How to get 接続文字列s」の手順に従ってください。

Functionsホストは、SignalRサービスに接続する際に AzureSignalRConnectionString という名前のキーまたはキープレフィックスを探します。 そうでなければ、 connectionStringSetting で設定されたキー値を用いて必要な接続情報を取得します。

ペイロード

トリガーの入力型は、InvocationContext またはカスタム型のいずれかとして宣言されています。 InvocationContextを選択すると、要求コンテンツへのフル アクセスが得られます。 カスタム型 の場合、ランタイムは JSON 要求本文を解析して、オブジェクトのプロパティを設定しようとします。

呼び出しコンテキスト

InvocationContext には、SignalR サービスから送信されるメッセージ内のすべてのコンテンツが含まれており、次のプロパティが含まれます:

ParameterNames の使用

ParameterNames のプロパティ SignalRTrigger を使用すると、呼び出しメッセージの引数を関数のパラメーターにバインドできます。 定義した名前は、他のバインドのバインド式の一部として、またはコードのパラメーターとして使用できます。 これにより、InvocationContext の引数へのアクセスがより便利になります。

たとえば、JavaScript SignalR クライアントが 2 つの引数 (broadcast、message1) を使用して Azure 関数でメソッド message2 を呼び出そうとしているとします。

await connection.invoke("broadcast", message1, message2);

parameterNames を設定すると、定義した名前が、クライアント側で送信される引数に対応します。

[SignalRTrigger(parameterNames: new string[] {"arg1, arg2"})]

次に、 arg1 には message1のコンテンツが含まれており、 arg2 には message2のコンテンツが含まれます。

ParameterNames の考慮事項

パラメーター バインドの場合、順序は重要です。 ParameterNames を使用している場合、ParameterNames の順序は、クライアントで呼び出した引数の順序と一致します。 C# で属性 [SignalRParameter] を使用している場合、Azure 関数メソッドの引数の順序は、クライアントの引数の順序と一致します。

ParameterNames と属性 [SignalRParameter]同時に使用することはできません 、または例外が発生します。

SignalR Service の統合

SignalR Service トリガー バインドを使用している場合、SignalR サービスには関数アプリにアクセスするための URL が必要です。 URL は、SignalR Service 側のアップストリームの設定で構成する必要があります。

SignalR Service トリガーを使用する場合、URL は単純で、次のように書式設定できます。

<Function_App_URL>/runtime/webhooks/signalr?code=<API_KEY>

Function_App_URLは Function App の [概要] ページにあり、API_KEYは Azure Function によって生成されます。 関数アプリの API_KEY ブレードで signalr_extension から API_KEY を取得できます。

1 つの SignalR サービスで複数の関数アプリを一緒に使用する場合は、アップストリームで複雑なルーティング規則をサポートすることもできます。 詳細については「アップストリームの設定」をご覧ください。

ステップ バイ ステップ サンプル

GitHub のサンプルに従って、SignalR Service トリガー バインドとアップストリーム機能を使用して関数アプリに関するチャット ルームをデプロイできます。双方向チャット ルームのサンプル

次のステップ

• Azure SignalR Service を使用した Azure Functions の開発と構成
• SignalR Service トリガー バインドのサンプル
• 分離ワーカー プロセスでの SignalR Service トリガーのバインド サンプル