Share via

Apps - Check Name Availability

Service:
IoT Central
API Version:
2021-06-01

Check if an IoT Central application name is available.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

URI Parameters

Name In Required Type Description
subscriptionId
 path True

string

The subscription identifier.
api-version
 query True

string

The version of the API.

Request Body

Name Required Type Description
name True

string

The name of the IoT Central application instance to check.
type

string

The type of the IoT Central resource to query.

Responses

Name Type Description
200 OK

AppAvailabilityInfo

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.
Other Status Codes

CloudError

DefaultErrorResponse

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Apps_CheckNameAvailability

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.IoTCentral/checkNameAvailability?api-version=2021-06-01

{
  "name": "myiotcentralapp",
  "type": "IoTApps"
}

Sample response

Status code:
200 
code: 200
{
  "nameAvailable": true
}
Status code:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

Definitions

Name Description
AppAvailabilityInfo

The properties indicating whether a given IoT Central application name or subdomain is available.
CloudError

Error details.
CloudErrorBody

Details of error response.
OperationInputs

Input values.

AppAvailabilityInfo

Object

The properties indicating whether a given IoT Central application name or subdomain is available.

Name Type Description
message

string

The detailed reason message.
nameAvailable

boolean

The value which indicates whether the provided name is available.
reason

string

The reason for unavailability.

CloudError

Object

Error details.

Name Type Description
error.code

string

The error code.
error.details

CloudErrorBody[]

A list of additional details about the error.
error.message

string

The error message.
error.target

string

The target of the particular error.

CloudErrorBody

Object

Details of error response.

Name Type Description
code

string

The error code.
details

CloudErrorBody[]

A list of additional details about the error.
message

string

The error message.
target

string

The target of the particular error.

OperationInputs

Object

Input values.

Name Type Default value Description
name

string

The name of the IoT Central application instance to check.
type

string

IoTApps

The type of the IoT Central resource to query.