通过

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

Apps - Check Subdomain Availability

服务:
IoT Central
API 版本:
2021-06-01

检查 IoT Central 应用程序子域是否可用。

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

URI 参数

名称 在 必需 类型 说明
subscriptionId
 path True

string

订阅标识符。
api-version
 query True

string

API 的版本。

请求正文

名称 必需 类型 说明
name True

string

要检查的 IoT Central 应用程序实例的名称。
type

string

要查询的 IoT Central 资源的类型。

响应

名称 类型 说明
200 OK

AppAvailabilityInfo

这是一个同步作。 正文包含 JSON 序列化响应，指定 IoT Central 应用程序子域是否可用。 如果子域不可用，正文将包含原因。
Other Status Codes

CloudError

DefaultErrorResponse

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Apps_SubdomainAvailability

示例请求

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

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

示例响应

状态代码:
200 
code: 200
{
  "nameAvailable": true
}
状态代码:
default 
{
  "error": {
    "code": "Error code",
    "message": "Error message",
    "target": "Error target"
  }
}

定义

名称 说明
AppAvailabilityInfo

指示给定的 IoT Central 应用程序名称或子域是否可用的属性。
CloudError

错误详细信息。
CloudErrorBody

错误响应的详细信息。
OperationInputs

输入值。

AppAvailabilityInfo

Object

指示给定的 IoT Central 应用程序名称或子域是否可用的属性。

名称 类型 说明
message

string

详细原因消息。
nameAvailable

boolean

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

string

不可用的原因。

CloudError

Object

错误详细信息。

名称 类型 说明
error.code

string

错误代码。
error.details

CloudErrorBody[]

有关错误的其他详细信息的列表。
error.message

string

错误消息。
error.target

string

特定错误的目标。

CloudErrorBody

Object

错误响应的详细信息。

名称 类型 说明
code

string

错误代码。
details

CloudErrorBody[]

有关错误的其他详细信息的列表。
message

string

错误消息。
target

string

特定错误的目标。

OperationInputs

Object

输入值。

名称 类型 默认值 说明
name

string

要检查的 IoT Central 应用程序实例的名称。
type

string

IoTApps

要查询的 IoT Central 资源的类型。