Share via


ConfigurationsClient.CreateAsync(Configuration, CancellationToken) Method

Definition

Creates a new configuration for Azure IoT Edge in IoT hub.

public virtual System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration> CreateAsync (Microsoft.Azure.Devices.Configuration configuration, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateAsync : Microsoft.Azure.Devices.Configuration * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>
override this.CreateAsync : Microsoft.Azure.Devices.Configuration * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Devices.Configuration>
Public Overridable Function CreateAsync (configuration As Configuration, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Configuration)

Parameters

configuration
Configuration

The configuration object being created.

cancellationToken
CancellationToken

The token which allows the operation to be canceled.

Returns

The configuration object.

Exceptions

Thrown when the provided configuration is null.

Thrown if IoT hub responded to the request with a non-successful status code. For example, if the provided request was throttled, IotHubServiceException with ThrottlingException is thrown. For a complete list of possible error cases, see IotHubServiceErrorCode.

If the HTTP request fails due to an underlying issue such as network connectivity, DNS failure, or server certificate validation.

If the provided cancellationToken has requested cancellation.

Applies to