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

Check Name Availability - Check Name Availability

检查租户域名的可用性和有效性。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/checkNameAvailability?api-version=2023-05-17-preview

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

唯一标识 Microsoft Azure 订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True

string

要与客户端请求一起使用的 API 的版本。

请求正文

名称 必需 类型 说明
countryCode True

string

Azure 租户 (的国家/地区代码,例如“US”) 。 请参阅 aka.ms/B2CDataResidency ,查看有效的国家/地区代码和相应的数据驻留位置。 如果在有效的数据驻留位置中看不到国家/地区代码,请从列表中选择一个。

name True

string

要检查可用性的子域名。

响应

名称 类型 说明
200 OK

NameAvailabilityResponse

检查名称可用性的结果。

Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Check name availability - available
Check name availability - taken

Check name availability - available

示例请求

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/checkNameAvailability?api-version=2023-05-17-preview

{
  "name": "constoso",
  "countryCode": "US"
}

示例响应

{
  "nameAvailable": true,
  "reason": null,
  "message": null
}

Check name availability - taken

示例请求

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.AzureActiveDirectory/checkNameAvailability?api-version=2023-05-17-preview

{
  "name": "constoso",
  "countryCode": "US"
}

示例响应

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "A tenant with this sub domain name already exists. Please choose another."
}

定义

名称 说明
CheckNameAvailabilityRequestBody

检查租户子域名可用性所需的信息。

CloudError

资源管理请求的错误响应。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

错误响应

NameAvailabilityReasonType

描述“nameAvailable”值的原因。

NameAvailabilityResponse

CheckNameAvailability 操作的响应。

CheckNameAvailabilityRequestBody

检查租户子域名可用性所需的信息。

名称 类型 说明
countryCode

string

Azure 租户 (的国家/地区代码,例如“US”) 。 请参阅 aka.ms/B2CDataResidency ,查看有效的国家/地区代码和相应的数据驻留位置。 如果在有效的数据驻留位置中看不到国家/地区代码,请从列表中选择一个。

name

string

要检查可用性的子域名。

CloudError

资源管理请求的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应,可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式.) 。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetail

错误详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

details

ErrorDetail[]

错误详细信息。

message

string

错误消息。

target

string

错误目标。

ErrorResponse

错误响应

名称 类型 说明
error

ErrorDetail

错误对象。

NameAvailabilityReasonType

描述“nameAvailable”值的原因。

名称 类型 说明
AlreadyExists

string

该名称已在使用中,因此不可用。

Invalid

string

提供的名称与资源提供程序的命名要求不匹配, (长度不正确、字符不受支持等 ) 。

NameAvailabilityResponse

CheckNameAvailability 操作的响应。

名称 类型 说明
message

string

如果名称不可用,则说明原因。

nameAvailable

boolean

如果名称可用并且可用于创建新租户,则其值为 True。 否则为 false。

reason

NameAvailabilityReasonType

描述“nameAvailable”值的原因。