WebPubSubServiceClient.CloseUserConnections メソッド

定義

名前空間:

Azure.Messaging.WebPubSub

アセンブリ:

Azure.Messaging.WebPubSub.dll

パッケージ:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

特定のユーザーの接続を閉じます。

public virtual Azure.Response CloseUserConnections (string userId, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

abstract member CloseUserConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response
override this.CloseUserConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function CloseUserConnections (userId As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Response

パラメーター

userId

String

ユーザー ID。

excluded

IEnumerable<String>

ユーザーの接続を閉じるときに、これらの connectionId を除外します。

reason

String

クライアント接続を閉じる理由。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Response

サービスから返された応答。

例外

ArgumentNullException

userId が null です。

ArgumentException

userId は空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して CloseUserConnections を呼び出す方法を示します。

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = client.CloseUserConnections("<userId>");
Console.WriteLine(response.Status);

このサンプルでは、すべてのパラメーターを使用して CloseUserConnections を呼び出す方法を示します。

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

Response response = client.CloseUserConnections("<userId>", new String[]{"<excluded>"}, "<reason>");
Console.WriteLine(response.Status);

注釈

の Response Errorスキーマ:

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }