WebPubSubServiceClient.CloseGroupConnectionsAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Close connections in the specific group.
public virtual System.Threading.Tasks.Task<Azure.Response> CloseGroupConnectionsAsync (string group, System.Collections.Generic.IEnumerable<string> excluded = default, string reason = default, Azure.RequestContext context = default);
abstract member CloseGroupConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.CloseGroupConnectionsAsync : string * seq<string> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function CloseGroupConnectionsAsync (group As String, Optional excluded As IEnumerable(Of String) = Nothing, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of 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 CloseGroupConnectionsAsync with required parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseGroupConnectionsAsync("<group>");
Console.WriteLine(response.Status);
This sample shows how to call CloseGroupConnectionsAsync with all parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseGroupConnectionsAsync("<group>", new String[]{"<excluded>"}, "<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
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for