WebPubSubServiceClient.CloseAllConnectionsAsync メソッド

定義

名前空間:

Azure.Messaging.WebPubSub

アセンブリ:

Azure.Messaging.WebPubSub.dll

パッケージ:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

ハブ内の接続を閉じます。

public virtual System.Threading.Tasks.Task<Azure.Response> CloseAllConnectionsAsync (System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

abstract member CloseAllConnectionsAsync : seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CloseAllConnectionsAsync : seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

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

パラメーター

excluded

IEnumerable<String>

ハブ内の接続を閉じるときに、これらの connectionId を除外します。

reason

String

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

context

RequestContext

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

戻り値

Task<Response>

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

例外

RequestFailedException

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

例

このサンプルでは、CloseAllConnectionsAsync を呼び出す方法を示します。

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

Response response = await client.CloseAllConnectionsAsync();
Console.WriteLine(response.Status);

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

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

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

注釈

の Response Errorスキーマ:

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