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

Operations - Check Name Availability

检查配置存储名称是否可供使用。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability?api-version=2023-03-01

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

Microsoft Azure 订阅 ID。

api-version
query True

string

客户端 API 版本。

请求正文

名称 必需 类型 说明
name True

string

要检查可用性的名称。

type True

ConfigurationResourceType

要为名称可用性检查的资源类型。

响应

名称 类型 说明
200 OK

NameAvailabilityStatus

请求成功;请求格式正确,已正确接收。

Other Status Codes

ErrorResponse

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

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称 说明
user_impersonation 模拟用户帐户

示例

ConfigurationStores_CheckNameAvailable
ConfigurationStores_CheckNameNotAvailable

ConfigurationStores_CheckNameAvailable

Sample Request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.AppConfiguration/checkNameAvailability?api-version=2023-03-01

{
  "name": "contoso",
  "type": "Microsoft.AppConfiguration/configurationStores"
}

Sample Response

{
  "nameAvailable": true,
  "message": "The specified name is available.",
  "reason": null
}

ConfigurationStores_CheckNameNotAvailable

Sample Request

POST https://management.azure.com/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/providers/Microsoft.AppConfiguration/checkNameAvailability?api-version=2023-03-01

{
  "name": "contoso",
  "type": "Microsoft.AppConfiguration/configurationStores"
}

Sample Response

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "The specified name is already in use."
}

定义

名称 说明
CheckNameAvailabilityParameters

用于检查资源名称是否可用的参数。

ConfigurationResourceType

要为名称可用性检查的资源类型。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetails

错误的详细信息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

NameAvailabilityStatus

请求检查资源名称的可用性的结果。

CheckNameAvailabilityParameters

用于检查资源名称是否可用的参数。

名称 类型 说明
name

string

要检查可用性的名称。

type

ConfigurationResourceType

要为名称可用性检查的资源类型。

ConfigurationResourceType

要为名称可用性检查的资源类型。

名称 类型 说明
Microsoft.AppConfiguration/configurationStores

string

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。

type

string

其他信息类型。

ErrorDetails

错误的详细信息。

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。

code

string

错误代码。

message

string

指示操作失败原因的错误消息。

ErrorResponse

错误响应指示服务无法处理传入请求。 错误消息中提供了原因。

名称 类型 说明
error

ErrorDetails

错误的详细信息。

NameAvailabilityStatus

请求检查资源名称的可用性的结果。

名称 类型 说明
message

string

如果有,则为错误消息,该错误消息提供更详细的名称不可用的原因。

nameAvailable

boolean

指示资源名称是否可用的值。

reason

string

如果有,则为名称不可用的原因。