WebPubSubServiceClient.CloseConnectionAsync Method
Definition
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 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
The response returned from the service.
Exceptions
connectionId
is null.
connectionId
is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Examples
This sample shows how to call CloseConnectionAsync with required parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseConnectionAsync("<connectionId>");
Console.WriteLine(response.Status);
This sample shows how to call CloseConnectionAsync with all parameters.
var client = new WebPubSubServiceClient("<https://my-service.azure.com>", "<hub>");
Response response = await client.CloseConnectionAsync("<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
Azure SDK for .NET
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for