WebPubSubServiceClient.CloseAllConnections Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Source:

WebPubSubServiceClient.cs

[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 Azure.Response CloseAllConnections (System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);

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

Public Overridable Function CloseAllConnections (Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As 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

Response

The response returned from the service.

Exceptions

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call CloseAllConnections.

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

Response response = client.CloseAllConnections();

Console.WriteLine(response.Status);

This sample shows how to call CloseAllConnections with all parameters.

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

Response response = client.CloseAllConnections(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
              }
            }