通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Iot Hub Resource - Check Name Availability

服务:
IoT Hub
API 版本:
2023-06-30

检查 IoT 中心名称是否可用。

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

要检查的 IoT 中心的名称。

响应

名称 类型 说明
200 OK

IotHubNameAvailabilityInfo

这是一个同步作。 正文包含 JSON 序列化响应，指定 IoT 中心名称是否可用。 如果该名称不可用，正文将包含原因。
Other Status Codes

ErrorDetails

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: 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

指示给定 IoT 中心名称是否可用的属性。
IotHubNameUnavailabilityReason

不可用的原因。
OperationInputs

输入值。

ErrorDetails

Object

错误详细信息。

名称 类型 说明
code

string

错误代码。
details

string

错误详细信息。
httpStatusCode

string

HTTP 状态代码。
message

string

错误消息。

IotHubNameAvailabilityInfo

Object

指示给定 IoT 中心名称是否可用的属性。

名称 类型 说明
message

string

详细原因消息。
nameAvailable

boolean

指示提供的名称是否可用的值。
reason

IotHubNameUnavailabilityReason

不可用的原因。

IotHubNameUnavailabilityReason

枚举

不可用的原因。

值 说明
Invalid
AlreadyExists

OperationInputs

Object

输入值。

名称 类型 说明
name

string

要检查的 IoT 中心的名称。