Share via


WebPubSubServiceClient.CloseGroupConnections Method

Definition

[Protocol Method] Close connections in the specific group.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual Azure.Response CloseGroupConnections (string group, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);
abstract member CloseGroupConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response
override this.CloseGroupConnections : string * seq<string> * string * Azure.RequestContext -> Azure.Response
Public Overridable Function CloseGroupConnections (group As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

group
String

Target group name, which length should be greater than 0 and less than 1025.

excluded
IEnumerable<String>

Exclude these connectionIds when closing the connections in the group.

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

group is null.

group is an empty string, and was expected to be non-empty.

Service returned a non-success status code.

Examples

This sample shows how to call CloseGroupConnections.

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

Response response = client.CloseGroupConnections("<group>");

Console.WriteLine(response.Status);

This sample shows how to call CloseGroupConnections with all parameters.

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

Response response = client.CloseGroupConnections("<group>", 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