IIotHubResourceOperations.CheckNameAvailabilityWithHttpMessagesAsync Method

Definition

Namespace:

Microsoft.Azure.Management.IotHub

Assembly:

Microsoft.Azure.Management.IotHub.dll

Package:

Microsoft.Azure.Management.IotHub v4.2.0

Check if an IoT hub name is available

public System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.IotHub.Models.IotHubNameAvailabilityInfo>> CheckNameAvailabilityWithHttpMessagesAsync (string name, System.Collections.Generic.Dictionary<string,System.Collections.Generic.List<string>> customHeaders = default, System.Threading.CancellationToken cancellationToken = default);

abstract member CheckNameAvailabilityWithHttpMessagesAsync : string * System.Collections.Generic.Dictionary<string, System.Collections.Generic.List<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Rest.Azure.AzureOperationResponse<Microsoft.Azure.Management.IotHub.Models.IotHubNameAvailabilityInfo>>

Public Function CheckNameAvailabilityWithHttpMessagesAsync (name As String, Optional customHeaders As Dictionary(Of String, List(Of String)) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AzureOperationResponse(Of IotHubNameAvailabilityInfo))

Parameters

name

String

The name of the IoT hub to check.

customHeaders

Dictionary<String,List<String>>

The headers that will be added to request.

cancellationToken

CancellationToken

The cancellation token.

Returns

Task<AzureOperationResponse<IotHubNameAvailabilityInfo>>

Exceptions

ErrorDetailsException

Thrown when the operation returned an invalid status code

SerializationException

Thrown when unable to deserialize the response

ValidationException

Thrown when a required parameter is null

Remarks

Check if an IoT hub name is available.