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

Services - Check Name Availability

参考

服务:: Search Management

API 版本:: 2024-03-01-preview

检查给定的搜索服务名称是否可供使用。搜索服务名称必须全局唯一，因为它们是服务 URI (https://.search.windows.net).

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

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。可以从 Azure 资源管理器 API 或门户获取此值。
api-version	query	True	string	要用于每个请求的 API 版本。

请求头

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

请求正文

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

响应

名称	类型	说明
200 OK	CheckNameAvailabilityOutput	名称检查完成。响应包含有关名称是否有效且可用的详细信息。如果名称无效，响应还包含一条消息，说明原因。
Other Status Codes	CloudError	HTTP 400 (错误请求) ：给定的资源类型不是“searchServices”。

安全性

azure_auth

指定 Microsoft 标识平台上支持的隐式授权流。

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

SearchCheckNameAvailability

示例请求

POST https://management.azure.com/subscriptions/subid/providers/Microsoft.Search/checkNameAvailability?api-version=2024-03-01-preview

{
  "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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/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("<subscription-id>", 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"),
	}, &armsearch.SearchManagementRequestOptions{ClientRequestID: nil}, 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.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

const { SearchManagementClient } = require("@azure/arm-search");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
 *
 * @summary Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).
 * x-ms-original-file: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCheckNameAvailability.json
 */
async function searchCheckNameAvailability() {
  const subscriptionId = process.env["SEARCH_SUBSCRIPTION_ID"] || "subid";
  const name = "mysearchservice";
  const credential = new DefaultAzureCredential();
  const client = new SearchManagementClient(credential, subscriptionId);
  const result = await client.services.checkNameAvailability(name);
  console.log(result);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search.Models;
using Azure.ResourceManager.Search;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/preview/2024-03-01-preview/examples/SearchCheckNameAvailability.json
// this example is just showing the usage of "Services_CheckNameAvailability" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "subid";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation
SearchServiceNameAvailabilityContent content = new SearchServiceNameAvailabilityContent("mysearchservice");
SearchServiceNameAvailabilityResult result = await subscriptionResource.CheckSearchServiceNameAvailabilityAsync(content);

Console.WriteLine($"Succeeded: {result}");

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

示例响应

状态代码:: 200

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

定义

名称	说明
CheckNameAvailabilityInput	检查名称可用性 API 的输入。
CheckNameAvailabilityOutput	检查名称可用性 API 的输出。
CloudError	包含有关 API 错误的信息。
CloudErrorBody	描述具有错误代码和消息的特定 API 错误。
ResourceType	要验证其名称的资源的类型。此值必须始终为“searchServices”。
UnavailableNameReason	名称不可用的原因。 “无效”表示提供的名称与命名要求不匹配， (不正确的长度、不支持的字符等 ) 。 “AlreadyExists”表示该名称已在使用中，因此不可用。

CheckNameAvailabilityInput

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

名称	类型	说明
name	string	要验证的搜索服务名称。搜索服务名称必须仅包含小写字母、数字或短划线，不能使用短划线作为前两个字符或最后一个字符，不能包含连续短划线，并且长度必须介于 2 到 60 个字符之间。
type	ResourceType	要验证其名称的资源的类型。此值必须始终为“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	特定错误的目标 (例如，错误) 中的属性的名称。

ResourceType

要验证其名称的资源的类型。此值必须始终为“searchServices”。

名称	类型	说明
searchServices	string	“searchServices”是唯一可以验证其名称的资源类型。

UnavailableNameReason

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

名称	类型	说明
AlreadyExists	string	搜索服务名称已分配给其他搜索服务。
Invalid	string	搜索服务名称不符合命名要求。

通过

Services - Check Name Availability

URI 参数

请求头

请求正文

响应

安全性

azure_auth

作用域

示例

SearchCheckNameAvailability

示例请求

示例响应

定义

CheckNameAvailabilityInput

CheckNameAvailabilityOutput

CloudError

CloudErrorBody

ResourceType

UnavailableNameReason

其他资源