WebPubSubServiceClient.RemoveConnectionFromAllGroups Method

Reference

Definition

Namespace:: Azure.Messaging.WebPubSub

Assembly:: Azure.Messaging.WebPubSub.dll

Package:: Azure.Messaging.WebPubSub v1.4.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.

[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 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.

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

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

Console.WriteLine(response.Status);

This sample shows how to call RemoveConnectionFromAllGroups with all parameters.

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

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

Console.WriteLine(response.Status);

Applies to

Share via