WebPubSubServiceClient.CloseConnectionAsync Method

Definition

Namespace:

Azure.Messaging.WebPubSub

Assembly:

Azure.Messaging.WebPubSub.dll

Package:

Azure.Messaging.WebPubSub v1.4.0

Source:

WebPubSubServiceClient.cs

[Protocol Method] Close the client connection.

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

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

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

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

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

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

Console.WriteLine(response.Status);

This sample shows how to call CloseConnectionAsync with all parameters.

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

Response response = await client.CloseConnectionAsync("<connectionId>", reason: "<reason>");

Console.WriteLine(response.Status);

Remarks

Schema for Response Error:

{
              code: string,
              message: string,
              target: string,
              details: [ErrorDetail],
              inner: {
                code: string,
                inner: InnerError
              }
            }