IotHubBaseClient.CloseAsync(CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.Azure.Devices.Client

Assembly:: Microsoft.Azure.Devices.Client.dll

Package:: Microsoft.Azure.Devices.Client v2.0.0-preview002

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

public System.Threading.Tasks.Task CloseAsync (System.Threading.CancellationToken cancellationToken = default);

member this.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function CloseAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

cancellationToken: CancellationToken

A cancellation token to cancel the operation.

Returns

Task

Exceptions

OperationCanceledException

Thrown when the operation has been canceled.

Remarks

The instance can be re-opened after closing and before disposing. However, subscriptions to cloud to device messages/twin/methods do not persist when re-opening a client.

Applies to