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

Services - Check Name Availability

服务:: Search Management

API 版本:: 2025-05-01

检查给定的搜索服务名称是否可用。搜索服务名称必须是全局唯一的，因为它们是服务 URI （https:// name.search.windows.net<>）的一部分。

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

URI 参数

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

请求头

名称	必需	类型	说明
x-ms-client-request-id		string (uuid)	一个客户端生成的 GUID 值，用于标识此请求。如果指定，响应信息中将包含此内容作为跟踪请求的一种方式。

请求正文

名称	必需	类型	说明
name	True	string	要验证的搜索服务名称。搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，长度必须介于 2 到 60 个字符之间。
type	True	enum: searchServices	要验证其名称的资源的类型。此值必须始终为“searchServices”。

响应

名称	类型	说明
200 OK	CheckNameAvailabilityOutput	请求已成功。
Other Status Codes	CloudError	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流程。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

SearchCheckNameAvailability

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

{
  "name": "mysearchservice",
  "type": "searchServices"
}

package armsearch_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/search/armsearch/v2"
)

// Generated from example definition: 2025-05-01/SearchCheckNameAvailability.json
func ExampleServicesClient_CheckNameAvailability() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsearch.NewClientFactory("00000000-0000-0000-0000-000000000000", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewServicesClient().CheckNameAvailability(ctx, armsearch.CheckNameAvailabilityInput{
		Name: to.Ptr("mysearchservice"),
		Type: to.Ptr("searchServices"),
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armsearch.ServicesClientCheckNameAvailabilityResponse{
	// 	CheckNameAvailabilityOutput: &armsearch.CheckNameAvailabilityOutput{
	// 		Message: to.Ptr(""),
	// 		IsNameAvailable: to.Ptr(false),
	// 		Reason: to.Ptr(armsearch.UnavailableNameReasonAlreadyExists),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:: 200

{
  "message": "",
  "nameAvailable": false,
  "reason": "AlreadyExists"
}

定义

名称	说明
CheckNameAvailabilityInput	检查名称可用性 API 的输入。
CheckNameAvailabilityOutput	检查名称可用性 API 的输出。
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
UnavailableNameReason	名称不可用的原因。 “无效”表示提供的名称与命名要求不匹配（长度不正确、字符不受支持等）。 “AlreadyExists”表示名称已在使用中，因此不可用。

CheckNameAvailabilityInput

对象

检查名称可用性 API 的输入。

名称	类型	说明
name	string	要验证的搜索服务名称。搜索服务名称只能包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，长度必须介于 2 到 60 个字符之间。
type	enum: searchServices	要验证其名称的资源的类型。此值必须始终为“searchServices”。

CheckNameAvailabilityOutput

对象

检查名称可用性 API 的输出。

名称	类型	说明
message	string	说明名称无效的原因并提供资源命名要求的消息。仅在“reason”属性中返回“Invalid”时才可用。
nameAvailable	boolean	一个值，该值指示名称是否可用。
reason	UnavailableNameReason	名称不可用的原因。 “无效”表示提供的名称与命名要求不匹配（长度不正确、字符不受支持等）。 “AlreadyExists”表示名称已在使用中，因此不可用。

CloudError

对象

包含有关 API 错误的信息。

名称	类型	说明
error	CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
message	string	提示出错的错误的简要说明（有关详细信息/调试信息，请参阅“error.message”属性）。

CloudErrorBody

对象

描述具有错误代码和消息的特定 API 错误。

名称	类型	说明
code	string	比 HTTP 状态代码更准确地描述错误条件的错误代码。可用于以编程方式处理特定错误案例。
details	CloudErrorBody[]	包含与此错误相关的嵌套错误。
message	string	详细说明错误并提供调试信息的消息。
target	string	特定错误的目标（例如，错误中属性的名称）。

UnavailableNameReason

枚举

名称不可用的原因。 “无效”表示提供的名称与命名要求不匹配（长度不正确、字符不受支持等）。 “AlreadyExists”表示名称已在使用中，因此不可用。

值	说明
Invalid	搜索服务名称与命名要求不匹配。
AlreadyExists	搜索服务名称已分配给其他搜索服务。