WebPubSubServiceClient で Azure Identity を使用する

この記事では、Microsoft Entra IDを使ってAzure Web PubSubへのリクエストを承認するWebPubSubServiceClientの作成方法を紹介します。

前提条件

• Azure サブスクリプション。
• 既存のAzure Web PubSubリソースです。
• Microsoft Entraのアイデンティティ、例えばアプリケーションやマネージドアイデンティティなどです。

Important

Microsoft EntraのIDに、アプリケーションが呼び出すSDK操作に必要なデータプレーン権限を含むAzureロールを割り当てます。 クライアントアクセストークンを生成し接続するためには、アイデンティティには Microsoft.SignalRService/WebPubSub/clientConnection/generateToken/action と Microsoft.SignalRService/WebPubSub/clientConnection/writeの両方が必要です。 組み込みの Web PubSubサービスオーナー の役割は両方の権限を持ちながら、すべてのデータプレーンAPIへのアクセス権を付与します。 より狭い組み込みロールには両方の権限が含まれることはありません。 最小権限アクセスの場合は、アプリケーションが必要とする権限のみを含むカスタムロールを使いましょう。

サービス クライアントを作成する

言語を選びましょう:

C#

Azure Identity パッケージと Azure Web PubSub パッケージをインストールします:

dotnet add package Azure.Identity
dotnet add package Azure.Messaging.WebPubSub

DefaultAzureCredentialを作成し、WebPubSubServiceClientに渡します:

using Azure.Identity;
using Azure.Messaging.WebPubSub;

var credential = new DefaultAzureCredential();
var client = new WebPubSubServiceClient(
    new Uri("<endpoint>"),
    "<hub>",
    credential);

その他の認証情報の種類については、Azure Identityクライアントライブラリ(.NET)を参照してください。

依存関係の挿入を使用する

依存性注入パッケージをインストールしてください:

dotnet add package Microsoft.Extensions.Azure

サービス コレクションに WebPubSubServiceClient を登録します:

using Azure.Identity;
using Microsoft.Extensions.Azure;
using Microsoft.Extensions.DependencyInjection;

void ConfigureServices(IServiceCollection services)
{
    services.AddAzureClients(builder =>
    {
        builder.AddWebPubSubServiceClient(
            new Uri("<endpoint>"),
            "<hub>",
            new DefaultAzureCredential());
    });
}

詳細については、.NETのAzure Web PubSubサービスクライアントライブラリおよび完全なサンプルをご覧ください。

Java

AzureアイデンティティとAzure Web PubSub依存関係をpom.xmlに追加してください:

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-identity</artifactId>
  <version>1.4.1</version>
</dependency>
<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-messaging-webpubsub</artifactId>
  <version>1.0.0</version>
</dependency>

DefaultAzureCredentialを作成し、WebPubSubServiceClientBuilderに渡します:

import com.azure.core.credential.TokenCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;
import com.azure.messaging.webpubsub.WebPubSubServiceClient;
import com.azure.messaging.webpubsub.WebPubSubServiceClientBuilder;

public class App {
    public static void main(String[] args) {
        TokenCredential credential = new DefaultAzureCredentialBuilder().build();
        WebPubSubServiceClient client = new WebPubSubServiceClientBuilder()
            .endpoint("<endpoint>")
            .credential(credential)
            .hub("<hub>")
            .buildClient();
    }
}

その他の認証情報の種類については、Java用のAzure Identityクライアントライブラリを参照してください。 サービスクライアントの詳細については、JavaのAzure Web PubSubサービスクライアントライブラリをご覧ください。

JavaScript

Azure Identity パッケージと Azure Web PubSub パッケージをインストールします:

npm install @azure/identity @azure/web-pubsub

DefaultAzureCredentialを作成し、WebPubSubServiceClientに渡します:

const { DefaultAzureCredential } = require("@azure/identity");
const { WebPubSubServiceClient } = require("@azure/web-pubsub");

const credential = new DefaultAzureCredential();
const serviceClient = new WebPubSubServiceClient(
  "<endpoint>",
  credential,
  "<hub>"
);

その他の認証情報の種類については、JavaScriptのAzure Identityクライアントライブラリを参照してください。 サービスクライアントの詳細については、JavaScriptのサービスクライアントライブラリAzure Web PubSubを参照してください。

Python

Azure Identity パッケージと Azure Web PubSub パッケージをインストールします:

python -m pip install azure-identity azure-messaging-webpubsubservice

DefaultAzureCredentialを作成し、WebPubSubServiceClientに渡します:

from azure.identity import DefaultAzureCredential
from azure.messaging.webpubsubservice import WebPubSubServiceClient

credential = DefaultAzureCredential()
client = WebPubSubServiceClient(
    hub="<hub>",
    endpoint="<endpoint>",
    credential=credential,
)

その他の資格情報の種類については、PythonのAzure Identityクライアントライブラリを参照してください。 サービスクライアントの詳細については、PythonのAzure Web PubSubサービスクライアントライブラリをご覧ください。

関連するコンテンツ

• Microsoft Entra ID を使用してアクセスを認可する
• クライアントアクセスURLを生成します