WebPubSubServiceClient.RemoveConnectionFromAllGroups Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.3.0

Source:

WebPubSubServiceClient.cs

Remove a connection from all groups.

public virtual Azure.Response RemoveConnectionFromAllGroups (string connectionId, Azure.RequestContext context = default);

abstract member RemoveConnectionFromAllGroups : string * Azure.RequestContext -> Azure.Response
override this.RemoveConnectionFromAllGroups : string * Azure.RequestContext -> Azure.Response

Public Overridable Function RemoveConnectionFromAllGroups (connectionId As String, Optional context As RequestContext = Nothing) As 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

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

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

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