WebPubSubServiceClient.CloseConnection(String, String, RequestContext) 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.

Close the client connection.

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

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

Public Overridable Function CloseConnection (connectionId As String, Optional reason As String = Nothing, Optional context As RequestContext = Nothing) As Response

Parameters

connectionId: String

Target connection Id.

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

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

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

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

This sample shows how to call CloseConnection with all parameters.

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

Response response = client.CloseConnection("<connectionId>", "<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

Share via