Share via


WebPubSubServiceClient.CloseAllConnectionsAsync Method

Definition

[Protocol Method] Close the connections in the hub.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
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)

Parameters

excluded
IEnumerable<String>

Exclude these connectionIds when closing the connections in the hub.

reason
String

The reason closing the client connection.

context
RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

The response returned from the service.

Exceptions

Service returned a non-success status code.

Examples

This sample shows how to call CloseAllConnectionsAsync.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

Response response = await client.CloseAllConnectionsAsync();

Console.WriteLine(response.Status);

This sample shows how to call CloseAllConnectionsAsync with all parameters.

WebPubSubServiceClient client = new WebPubSubServiceClient("<Endpoint>", "<Hub>");

Response response = await client.CloseAllConnectionsAsync(excluded: new string[] { "<excluded>" }, reason: "<reason>");

Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

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

Applies to