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

Iot Dps Resource - Check Provisioning Service Name Availability

参考

Service:: IoT Hub Device Provisioning Service

API Version:: 2022-12-12

检查预配服务名称是否可用。这将验证名称在语法上是否有效以及名称是否可用

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	订阅标识符。
api-version	query	True	string	API 的版本。

请求正文

名称	必需	类型	说明
name	True	string	要检查的预配服务的名称。

响应

名称	类型	说明
200 OK	NameAvailabilityInfo	这是一个同步操作。正文包含 JSON 序列化响应，该响应指定预配服务名称是否可用。如果该名称不可用，则正文包含原因。
Other Status Codes	ErrorDetails	默认错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

DPSCheckName

Sample Request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/checkProvisioningServiceNameAvailability?api-version=2022-12-12

{
  "name": "test213123"
}

Sample Response

Status code:: 200

{
  "nameAvailable": true,
  "reason": "Invalid",
  "message": "name is valid"
}

定义

名称	说明
ErrorDetails	错误详细信息。
NameAvailabilityInfo	名称可用性的说明。
NameUnavailabilityReason	指定名称不可用的原因
OperationInputs	操作结果调用的输入值。

ErrorDetails

错误详细信息。

名称	类型	说明
code	integer	错误代码。
details	string	错误详细信息。
httpStatusCode	string	HTTP 状态代码。
message	string	错误消息。

NameAvailabilityInfo

名称可用性的说明。

名称	类型	说明
message	string	包含详细原因名称不可用的消息
nameAvailable	boolean	指定名称是否可用
reason	NameUnavailabilityReason	指定名称不可用的原因

NameUnavailabilityReason

指定名称不可用的原因

名称	类型	说明
AlreadyExists	string
Invalid	string

OperationInputs

操作结果调用的输入值。

名称	类型	说明
name	string	要检查的预配服务的名称。

通过