IotHubExtensions.CheckIotHubNameAvailabilityAsync Method

Reference

Definition

Namespace:: Azure.ResourceManager.IotHub

Assembly:: Azure.ResourceManager.IotHub.dll

Package:: Azure.ResourceManager.IotHub v1.1.1

Source:: IotHubExtensions.cs

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.

Check if an IoT hub name is available.

Request Path: /subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability
Operation Id: IotHubResource_CheckNameAvailability

public static System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.Models.IotHubNameAvailabilityResponse>> CheckIotHubNameAvailabilityAsync (this Azure.ResourceManager.Resources.SubscriptionResource subscriptionResource, Azure.ResourceManager.IotHub.Models.IotHubNameAvailabilityContent content, System.Threading.CancellationToken cancellationToken = default);

static member CheckIotHubNameAvailabilityAsync : Azure.ResourceManager.Resources.SubscriptionResource * Azure.ResourceManager.IotHub.Models.IotHubNameAvailabilityContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.IotHub.Models.IotHubNameAvailabilityResponse>>

<Extension()>
Public Function CheckIotHubNameAvailabilityAsync (subscriptionResource As SubscriptionResource, content As IotHubNameAvailabilityContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IotHubNameAvailabilityResponse))

Parameters

subscriptionResource: SubscriptionResource

The SubscriptionResource instance the method will execute against.

content: IotHubNameAvailabilityContent

Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.

cancellationToken: CancellationToken

The cancellation token to use.

Returns

Task<Response<IotHubNameAvailabilityResponse>>

Exceptions

ArgumentNullException

subscriptionResource or content is null.

Applies to