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

Check Name Availability - Check Name Availability

Service:

Azure Data Manager for Agriculture

API Version:

2023-06-01-preview

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

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string uuid	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
name	string	需要检查其可用性的资源的名称。
type	string	资源类型。

响应

名称	类型	说明
200 OK	CheckNameAvailabilityResponse	Success
Other Status Codes	ErrorResponse	错误

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

CheckNameAvailability_CheckNameAvailability_AlreadyExists

CheckNameAvailability_CheckNameAvailability_Available

CheckNameAvailability_CheckNameAvailability_AlreadyExists

Sample Request

HTTP

POST https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/providers/Microsoft.AgFoodPlatform/checkNameAvailability?api-version=2023-06-01-preview

{
  "name": "existingaccountname",
  "type": "Microsoft.AgFoodPlatform/farmBeats"
}

Sample Response

Status code:

200

{
  "nameAvailable": false,
  "reason": "AlreadyExists",
  "message": "An account named 'existingaccountname' is already in use."
}

CheckNameAvailability_CheckNameAvailability_Available

Sample Request

HTTP

POST https://management.azure.com/subscriptions/11111111-2222-3333-4444-555555555555/providers/Microsoft.AgFoodPlatform/checkNameAvailability?api-version=2023-06-01-preview

{
  "name": "newaccountname",
  "type": "Microsoft.AgFoodPlatform/farmBeats"
}

Sample Response

Status code:

200

{
  "nameAvailable": true
}

定义

名称	说明
CheckNameAvailabilityReason	给定名称不可用的原因。
CheckNameAvailabilityRequest	检查可用性请求正文。
CheckNameAvailabilityResponse	检查可用性结果。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应

CheckNameAvailabilityReason

给定名称不可用的原因。

名称	类型	说明
AlreadyExists	string
Invalid	string

CheckNameAvailabilityRequest

检查可用性请求正文。

名称	类型	说明
name	string	需要检查其可用性的资源的名称。
type	string	资源类型。

CheckNameAvailabilityResponse

检查可用性结果。

名称	类型	说明
message	string	给定名称可用的详细原因。
nameAvailable	boolean	指示资源名称是否可用。
reason	CheckNameAvailabilityReason	给定名称不可用的原因。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。