WebPubSubServiceClient.RemoveConnectionFromAllGroupsAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Source:

WebPubSubServiceClient.cs

[Protocol Method] Remove a connection from all groups.

• 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> RemoveConnectionFromAllGroupsAsync (string connectionId, Azure.RequestContext context = default);

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

Public Overridable Function RemoveConnectionFromAllGroupsAsync (connectionId As String, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

connectionId

String

Target connection Id.

context

RequestContext

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

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

connectionId is null.

ArgumentException

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

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call RemoveConnectionFromAllGroupsAsync.

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

Response response = await client.RemoveConnectionFromAllGroupsAsync("<connectionId>");

Console.WriteLine(response.Status);

This sample shows how to call RemoveConnectionFromAllGroupsAsync with all parameters.

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

Response response = await client.RemoveConnectionFromAllGroupsAsync("<connectionId>");

Console.WriteLine(response.Status);