WebPubSubServiceClient.RemoveConnectionFromAllGroupsAsync Method

Reference

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Package:: Azure.Messaging.WebPubSub v1.3.0

Source:: WebPubSubServiceClient.cs

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.

Remove a connection from all groups.

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 with required parameters.

var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");

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

Applies to

Share via