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

[アーティクル]
02/25/2025

SignalR 出力バインドを使用して、Azure SignalR Service で 1 つ以上のメッセージを送信します。次の宛先にメッセージをブロードキャストできます。

接続されているすべてのクライアント
指定したグループ内の接続済みクライアント
特定のユーザーに対して認証された接続されているクライアント

出力バインドを使用すると、グループを管理することもできます。たとえば、グループへのクライアントまたはユーザーの追加、グループからのクライアントまたはユーザーの削除などです。

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

例

すべてのクライアントにブロードキャストする

A C# 関数は、次の C# モードのいずれかを使用して作成できます。

分離されたワーカーモデル: ランタイムから分離されたワーカープロセスで実行されるコンパイル済みの C# 関数。分離ワーカープロセスは、LTS および非 LTS バージョンの .NET および .NET Framework で実行されている C# 関数をサポートするために必要です。
インプロセスモデル: Functions ランタイムと同じプロセスで実行されるコンパイル済みの C# 関数。
C# スクリプト: Azure portal で C# 関数を作成するときに主に使用されます。

重要

インプロセスモデルのサポートは 2026 年 11 月 10 日に終了します。完全なサポートのために、分離ワーカーモデルにアプリを移行することを強くお勧めします。

分離ワーカーモデル
インプロセスモデル

次の例は、出力バインドを使用してすべての接続済みクライアントにメッセージを送信する関数を示しています。 newMessage は、各クライアントで呼び出されるメソッドの名前です。

[Function(nameof(BroadcastToAll))]
[SignalROutput(HubName = "chat", ConnectionStringSetting = "SignalRConnection")]
public static SignalRMessageAction BroadcastToAll([HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequestData req)
{
    using var bodyReader = new StreamReader(req.Body);
    return new SignalRMessageAction("newMessage")
    {
        // broadcast to all the connected clients without specifying any connection, user or group.
        Arguments = new[] { bodyReader.ReadToEnd() },
    };
}

次の例は、出力バインドを使用してすべての接続済みクライアントにメッセージを送信する関数を示しています。 target は、各クライアントで呼び出されるメソッドの名前です。引数プロパティは、クライアントメソッドに渡される 0 個以上のオブジェクトの配列です。

[FunctionName("SendMessage")]
public static Task SendMessage(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post")]object message,
    [SignalR(HubName = "hubName1")]IAsyncCollector<SignalRMessage> signalROutput)
{
    return signalROutput.AddAsync(
        new SignalRMessage
        {
            Target = "newMessage",
            Arguments = new [] { message }
        });
}

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

モデル v4
モデル v3

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

const signalR = output.generic({
    type: 'signalR',
    name: 'signalR',
    hubName: 'hub',
    connectionStringSetting: 'AzureSignalRConnectionString',
});

// You can use any other trigger type instead.
app.http('broadcast', {
    methods: ['GET'],
    authLevel: 'anonymous',
    extraOutputs: [signalR],
    handler: (request, context) => {
        context.extraOutputs.set(signalR, {
            "target": "newMessage",
            "arguments": [request.body]
        });
    }
});

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

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

module.exports = async function (context, req) {
    context.bindings.signalROutput = [{
        "target": "newMessage",
        "arguments": [ req.body ]
    }];
};

PowerShell の完全な例は保留中です。

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

def main(req: func.HttpRequest, signalROutput: func.Out[str]) -> func.HttpResponse:
    message = req.get_json()
    signalROutput.set(json.dumps({
        'target': 'newMessage',
        'arguments': [ message ]
    }))

@FunctionName("sendMessage")
@SignalROutput(name = "$return", HubName = "hubName1")
public SignalRMessage sendMessage(
        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.POST },
            authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Object> req) {

    SignalRMessage message = new SignalRMessage();
    message.target = "newMessage";
    message.arguments.add(req.getBody());
    return message;
}

ユーザーに送信する

ユーザーに対して認証された接続だけにメッセージを送信するには、SignalR メッセージの user ID を設定します。

分離ワーカーモデル
インプロセスモデル

[Function(nameof(SendToUser))]
[SignalROutput(HubName = "chat", ConnectionStringSetting = "SignalRConnection")]
public static SignalRMessageAction SendToUser([HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequestData req)
{
    using var bodyReader = new StreamReader(req.Body);
    return new SignalRMessageAction("newMessage")
    {
        Arguments = new[] { bodyReader.ReadToEnd() },
        UserId = "userToSend",
    };
}

[FunctionName("SendMessage")]
public static Task SendMessage(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post")]object message,
    [SignalR(HubName = "hubName1")]IAsyncCollector<SignalRMessage> signalROutput)
{
    return signalROutput.AddAsync(
        new SignalRMessage
        {
            // the message will only be sent to this user ID
            UserId = "userId1",
            Target = "newMessage",
            Arguments = new [] { message }
        });
}

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

PowerShell の完全な例は保留中です。

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

def main(req: func.HttpRequest, signalROutput: func.Out[str]) -> func.HttpResponse:
    message = req.get_json()
    signalROutput.set(json.dumps({
        #message will only be sent to this user ID
        'userId': 'userId1',
        'target': 'newMessage',
        'arguments': [ message ]
    }))

@FunctionName("sendMessage")
@SignalROutput(name = "$return", HubName = "hubName1")
public SignalRMessage sendMessage(
        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.POST },
            authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Object> req) {

    SignalRMessage message = new SignalRMessage();
    message.userId = "userId1";
    message.target = "newMessage";
    message.arguments.add(req.getBody());
    return message;
}

モデル v4
モデル v3

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

const signalR = output.generic({
    type: 'signalR',
    name: 'signalR',
    hubName: 'hub',
    connectionStringSetting: 'AzureSignalRConnectionString',
});

app.http('sendToUser', {
    methods: ['GET'],
    authLevel: 'anonymous',
    extraOutputs: [signalR],
    handler: (request, context) => {
        context.extraOutputs.set(signalR, {
            "target": "newMessage",
            "arguments": [request.body],
            "userId": "userId1",
        });
    }
});

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

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

module.exports = async function (context, req) {
    context.bindings.signalROutput = [{
        "target": "newMessage",
        "arguments": [ req.body ],
        "userId": "userId1",
    }];
};

グループに送信する

グループに追加された接続だけにメッセージを送信するには、SignalR メッセージの group name を設定します。

分離ワーカーモデル
インプロセスモデル

[Function(nameof(SendToGroup))]
[SignalROutput(HubName = "chat", ConnectionStringSetting = "SignalRConnection")]
public static SignalRMessageAction SendToGroup([HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequestData req)
{
    using var bodyReader = new StreamReader(req.Body);
    return new SignalRMessageAction("newMessage")
    {
        Arguments = new[] { bodyReader.ReadToEnd() },
        GroupName = "groupToSend"
    };
}

[FunctionName("SendMessage")]
public static Task SendMessage(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post")]object message,
    [SignalR(HubName = "hubName1")]IAsyncCollector<SignalRMessage> signalROutput)
{
    return signalROutput.AddAsync(
        new SignalRMessage
        {
            // the message will be sent to the group with this name
            GroupName = "myGroup",
            Target = "newMessage",
            Arguments = new [] { message }
        });
}

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

モデル v4
モデル v3

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

const signalR = output.generic({
    type: 'signalR',
    name: 'signalR',
    hubName: 'hub',
    connectionStringSetting: 'AzureSignalRConnectionString',
});

app.http('sendToGroup', {
    methods: ['GET'],
    authLevel: 'anonymous',
    extraOutputs: [signalR],
    handler: (request, context) => {
        context.extraOutputs.set(signalR, {
            "target": "newMessage",
            "arguments": [request.body],
            "groupName": "myGroup",
        });
    }
});

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

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

module.exports = async function (context, req) {
    context.bindings.signalROutput = [{
        "target": "newMessage",
        "arguments": [ req.body ],
        "groupName": "myGroup",
    }];
};

PowerShell の完全な例は保留中です。

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

def main(req: func.HttpRequest, signalROutput: func.Out[str]) -> func.HttpResponse:
    message = req.get_json()
    signalROutput.set(json.dumps({
        #message will only be sent to this group
        'groupName': 'myGroup',
        'target': 'newMessage',
        'arguments': [ message ]
    }))

@FunctionName("sendMessage")
@SignalROutput(name = "$return", HubName = "hubName1")
public SignalRMessage sendMessage(
        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.POST },
            authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Object> req) {

    SignalRMessage message = new SignalRMessage();
    message.groupName = "myGroup";
    message.target = "newMessage";
    message.arguments.add(req.getBody());
    return message;
}

グループ管理

SignalR Service を使用すると、ユーザーまたは接続をグループに追加できます。その後にメッセージをグループに送信できます。 SignalR 出力バインドを使ってグループを管理することができます。

分離ワーカーモデル
インプロセスモデル

メンバーを追加または削除する SignalRGroupActionType を指定します。次の例では、ユーザーをグループから削除します。

[Function(nameof(RemoveFromGroup))]
[SignalROutput(HubName = "chat", ConnectionStringSetting = "SignalRConnection")]
public static SignalRGroupAction RemoveFromGroup([HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequestData req)
{
    return new SignalRGroupAction(SignalRGroupActionType.Remove)
    {
        GroupName = "group1",
        UserId = "user1"
    };
}

メンバーを追加または削除する GroupAction を指定します。次の例では、ユーザーをグループに追加します。

[FunctionName("addToGroup")]
public static Task AddToGroup(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post")]HttpRequest req,
    ClaimsPrincipal claimsPrincipal,
    [SignalR(HubName = "hubName1")]
        IAsyncCollector<SignalRGroupAction> signalRGroupActions)
{
    var userIdClaim = claimsPrincipal.FindFirst(ClaimTypes.NameIdentifier);
    return signalRGroupActions.AddAsync(
        new SignalRGroupAction
        {
            UserId = userIdClaim.Value,
            GroupName = "myGroup",
            Action = GroupAction.Add
        });
}

Note

ClaimsPrincipal を正しくバインドするためには、Azure Functions で認証設定を構成しておく必要があります。

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

モデル v4
モデル v3

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

const signalR = output.generic({
    type: 'signalR',
    name: 'signalR',
    hubName: 'hub',
    connectionStringSetting: 'AzureSignalRConnectionString',
});

// The following function adds a user to a group
app.http('addUserToGroup', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [signalR],
    handler: (request, context) => {
        context.extraOutputs.set(signalR, {
            "userId": req.query.userId,
            "groupName": "myGroup",
            "action": "add"
        });
    }
});

// The following function removes a user from a group
app.http('removeUserFromGroup', {
    methods: ['POST'],
    authLevel: 'anonymous',
    extraOutputs: [signalR],
    handler: (request, context) => {
        context.extraOutputs.set(signalR, {
            "userId": req.query.userId,
            "groupName": "myGroup",
            "action": "remove"
        });
    }
});

function.json ファイルのバインドデータを次に示します。

function.json の例:

{
  "type": "signalR",
  "name": "signalROutput",
  "hubName": "hubName1",
  "connectionStringSetting": "<name of setting containing SignalR Service connection string>",
  "direction": "out"
}

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

次の例では、ユーザーをグループに追加します。

module.exports = async function (context, req) {
  context.bindings.signalROutput = [{
    "userId": req.query.userId,
    "groupName": "myGroup",
    "action": "add"
  }];
};

次の例では、ユーザーをグループから削除します。

module.exports = async function (context, req) {
  context.bindings.signalROutput = [{
    "userId": req.query.userId,
    "groupName": "myGroup",
    "action": "remove"
  }];
};

PowerShell の完全な例は保留中です。

次の例では、ユーザーをグループに追加します。

def main(req: func.HttpRequest, signalROutput: func.Out[str]) -> func.HttpResponse:
    signalROutput.set(json.dumps({
        'userId': 'userId1',
        'groupName': 'myGroup',
        'action': 'add'
    }))

次の例では、ユーザーをグループから削除します。

def main(req: func.HttpRequest, signalROutput: func.Out[str]) -> func.HttpResponse:
    signalROutput.set(json.dumps({
        'userId': 'userId1',
        'groupName': 'myGroup',
        'action': 'remove'
    }))

次の例では、ユーザーをグループに追加します。

@FunctionName("addToGroup")
@SignalROutput(name = "$return", HubName = "hubName1")
public SignalRGroupAction addToGroup(
        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.POST },
            authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Object> req,
        @BindingName("userId") String userId) {

    SignalRGroupAction groupAction = new SignalRGroupAction();
    groupAction.action = "add";
    groupAction.userId = userId;
    groupAction.groupName = "myGroup";
    return action;
}

次の例では、ユーザーをグループから削除します。

@FunctionName("removeFromGroup")
@SignalROutput(name = "$return", HubName = "hubName1")
public SignalRGroupAction removeFromGroup(
        @HttpTrigger(
            name = "req",
            methods = { HttpMethod.POST },
            authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Object> req,
        @BindingName("userId") String userId) {

    SignalRGroupAction groupAction = new SignalRGroupAction();
    groupAction.action = "remove";
    groupAction.userId = userId;
    groupAction.groupName = "myGroup";
    return action;
}

属性

インプロセスと分離ワーカープロセスの C# ライブラリの両方で、属性を使用して関数を定義します。 C# スクリプトでは、代わりに function.json 構成ファイルを使います。

分離ワーカーモデル
インプロセスモデル

次の表では、SignalROutput 属性のプロパティについて説明します。

属性のプロパティ	説明
HubName	この値は、接続情報が生成される SignalR ハブの名前に設定する必要があります。
ConnectionStringSetting	SignalR Service 接続文字列を含むアプリ設定または設定コレクションの名前。既定では`AzureSignalRConnectionString`。

次の表では、SignalR 出力属性のプロパティについて説明します。

属性のプロパティ	説明
HubName	この値は、接続情報が生成される SignalR ハブの名前に設定する必要があります。
ConnectionStringSetting	SignalR Service 接続文字列を含むアプリ設定または設定コレクションの名前。既定では`AzureSignalRConnectionString`。

注釈

次の表では、SignalROutput 注釈でサポートされている設定について説明します。

設定	内容
name	接続情報オブジェクトの関数コードで使用される変数名。
hubName	この値は、接続情報が生成される SignalR ハブの名前に設定する必要があります。
connectionStringSetting	SignalR Service 接続文字列を含むアプリ設定または設定コレクションの名前。既定では`AzureSignalRConnectionString`。

構成

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

function.json のプロパティ	説明
type	`signalR` に設定する必要があります。
direction	`out` に設定する必要があります。
name	接続情報オブジェクトの関数コードで使用される変数名。
hubName	この値は、接続情報が生成される SignalR ハブの名前に設定する必要があります。
connectionStringSetting	SignalR Service 接続文字列を含むアプリ設定または設定コレクションの名前。既定では`AzureSignalRConnectionString`。

ローカルで開発する場合は、Values コレクション内の local.settings.json ファイルにアプリケーション設定を追加します。

使用方法

最適なセキュリティのために、関数アプリでは、共有秘密鍵を含む接続文字列を使用する代わりに、Azure SignalR サービスに接続するときにマネージド ID を使用する必要があります。詳細については、「 Microsoft Entra マネージド ID を使用して Azure SignalR Service リソースへの要求を認証するを参照してください。

次の方法で共有

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

例

すべてのクライアントにブロードキャストする

ユーザーに送信する

グループに送信する

グループ管理

属性

注釈

構成

使用方法

次のステップ

フィードバック

その他のリソース