v2

latestSwagger 2.0raw.githubusercontent.com2021-04-273265113.0 KB
POST

Check if an IoT hub name is available

Check if an IoT hub name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability

Path parameters

subscriptionIdstring required

The subscription identifier.

Query parameters

api-versionstring required

The version of the API.

Request body

namestring required

The name of the IoT hub to check.

Response

This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.

nameAvailableboolean

The value which indicates whether the provided name is available.

reason'Invalid' | 'AlreadyExists'

The reason for unavailability.

messagestring

The detailed reason message.