.NET 用 Azure Web PubSub サービス クライアント ライブラリ

Azure Web PubSub サービスは、開発者がリアルタイムの機能とパブリッシュ-サブスクライブ パターンを使って Web アプリケーションを簡単に作成できるようにするための Azure マネージド サービスです。 サーバーとクライアント間、またはクライアント間で、リアルタイムのパブリッシュ-サブスクライブ メッセージングを必要とするあらゆるシナリオに、Azure Web PubSub サービスを使用できます。 従来のリアルタイム機能は、多くの場合、サーバーからのポーリングや HTTP 要求の送信を必要としますが、そのようなリアルタイム機能にも Azure Web PubSub サービスを使用できます。

次の図に示すように、このライブラリをアプリ サーバー側で使用して、WebSocket クライアント接続を管理できます。

このライブラリは次のことに使うことができます。

• ハブとグループにメッセージを送信します。
• 特定のユーザーと接続にメッセージを送信します。
• ユーザーと接続をグループに整理します。
• 接続を終了します
• 既存の接続のアクセス許可を付与、取り消し、確認します

ソース コード | パッケージ | API リファレンス ドキュメント | 製品ドキュメント | サンプル

作業の開始

パッケージをインストールする

NuGet からクライアント ライブラリをインストールします:

dotnet add package Azure.Messaging.WebPubSub

前提条件

• Azure サブスクリプション
• 既存の Azure Web PubSub サービス インスタンス。

WebPubSubServiceClient を作成して認証する

サービスと対話するには、WebPubSubServiceClient クラスのインスタンスを作成する必要があります。 これを可能にするには、Microsoft Azure portal でアクセスできる接続文字列またはキーが必要です。

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

例

すべてのクライアントにテキスト メッセージをブロードキャストする

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll("Hello World!");

すべてのクライアントに JSON メッセージをブロードキャストする

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

serviceClient.SendToAll(RequestContent.Create(
        new
        {
            Foo = "Hello World!",
            Bar = 42
        }),
        ContentType.ApplicationJson);

すべてのクライアントにバイナリ メッセージをブロードキャストする

var serviceClient = new WebPubSubServiceClient(new Uri(endpoint), "some_hub", new AzureKeyCredential(key));

Stream stream = BinaryData.FromString("Hello World!").ToStream();
serviceClient.SendToAll(RequestContent.Create(stream), ContentType.ApplicationOctetStream);

トラブルシューティング

コンソール ログの設定

また、サービスに対して行う要求の詳細を確認する場合は、単にコンソールのログ記録を有効にすることも簡単にできます。

次のステップ

これらのリソースを使用して、独自のアプリケーションの構築を開始します。