Поделиться через

Iot Hub Resource - Check Name Availability

Служба:
IoT Hub
Версия API:
2023-06-30

Проверьте, доступно ли имя центра Интернета вещей.

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
 path True

string

Идентификатор подписки.
api-version
 query True

string

Версия API.

Текст запроса

Имя Обязательно Тип Описание
name True

string

Имя центра Интернета вещей для проверки.

Ответы

Имя Тип Описание
200 OK

IotHubNameAvailabilityInfo

Это синхронная операция. Текст содержит сериализованный в формате JSON ответ, указывающий, доступно ли имя центра Интернета вещей. Если имя недоступно, текст содержит причину.
Other Status Codes

ErrorDetails

DefaultErrorResponse

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя Описание
user_impersonation олицетворения учетной записи пользователя

Примеры

IotHubResource_CheckNameAvailability

Образец запроса

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkNameAvailability?api-version=2023-06-30

{
  "name": "test-request"
}

Пример ответа

Код состояния:
200 
{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": ""
}

Определения

Имя Описание
ErrorDetails

Сведения об ошибке.
IotHubNameAvailabilityInfo

Свойства, указывающие, доступно ли заданное имя центра Интернета вещей.
IotHubNameUnavailabilityReason

Причина недоступности.
OperationInputs

Входные значения.

ErrorDetails

Object

Сведения об ошибке.

Имя Тип Описание
code

string

Код ошибки.
details

string

Сведения об ошибке.
httpStatusCode

string

Код состояния HTTP.
message

string

Сообщение об ошибке.

IotHubNameAvailabilityInfo

Object

Свойства, указывающие, доступно ли заданное имя центра Интернета вещей.

Имя Тип Описание
message

string

Подробное сообщение о причине.
nameAvailable

boolean

Значение, указывающее, доступно ли указанное имя.
reason

IotHubNameUnavailabilityReason

Причина недоступности.

IotHubNameUnavailabilityReason

Перечисление

Причина недоступности.

Значение Описание
Invalid
AlreadyExists

OperationInputs

Object

Входные значения.

Имя Тип Описание
name

string

Имя центра Интернета вещей для проверки.