v11

latestSwagger 2.0raw.githubusercontent.com2022-09-07101728.0 KB
Apps

Check if an IoT Central application name is available.

post/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/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 Central application instance to check.

typestring

The type of the IoT Central resource to query.

Response

This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT Central application 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.

reasonstring

The reason for unavailability.

messagestring

The detailed reason message.