Services - Check Name Availability

서비스:

Search Management

API 버전:

2024-03-01-preview

지정된 검색 서비스 이름을 사용할 수 있는지 여부를 확인합니다. Search Service 이름은 서비스 URI()의 일부이므로 전역적으로 고유해야 합니다.https://.search.windows.net).

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
subscriptionId	path	True	string	Microsoft Azure 구독의 고유 식별자입니다. Azure 리소스 관리자 API 또는 포털에서 이 값을 가져올 수 있습니다.
api-version	query	True	string	각 요청에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
x-ms-client-request-id		string uuid	이 요청을 식별하는 클라이언트에서 생성한 GUID 값입니다. 지정된 경우 요청을 추적하는 방법으로 응답 정보에 포함됩니다.

요청 본문

Name	필수	형식	Description
name	True	string	유효성을 검사할 검색 서비스 이름입니다. Search Service 이름은 소문자, 숫자 또는 대시만 포함해야 하며, 처음 두 문자 또는 마지막 한 문자로 대시를 사용할 수 없고, 연속 대시를 포함할 수 없으며, 길이가 2~60자 사이여야 합니다.
type	True	ResourceType	이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다.

응답

Name	형식	Description
200 OK	CheckNameAvailabilityOutput	이름이 완료된 검사. 응답에는 이름이 유효하고 사용할 수 있는지 여부에 대한 세부 정보가 포함됩니다. 이름이 잘못된 경우 응답에는 이유를 설명하는 메시지도 포함됩니다.
Other Status Codes	CloudError	HTTP 400(잘못된 요청): 지정된 리소스 종류가 'searchServices'가 아닙니다.

보안

azure_auth

Microsoft ID 플랫폼에서 지원되는 암시적 허용 흐름을 지정합니다.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

SearchCheckNameAvailability

샘플 요청

HTTP

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

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

Go

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

JavaScript

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

dotnet

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": ""
}

정의

Name	Description
CheckNameAvailabilityInput	검사 이름 가용성 API의 입력입니다.
CheckNameAvailabilityOutput	검사 이름 가용성 API의 출력입니다.
CloudError	API 오류에 대한 정보를 포함합니다.
CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.
ResourceType	이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다.
UnavailableNameReason	이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다.

CheckNameAvailabilityInput

검사 이름 가용성 API의 입력입니다.

Name	형식	Description
name	string	유효성을 검사할 검색 서비스 이름입니다. Search Service 이름은 소문자, 숫자 또는 대시만 포함해야 하며, 처음 두 문자 또는 마지막 한 문자로 대시를 사용할 수 없고, 연속 대시를 포함할 수 없으며, 길이가 2~60자 사이여야 합니다.
type	ResourceType	이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다.

CheckNameAvailabilityOutput

검사 이름 가용성 API의 출력입니다.

Name	형식	Description
message	string	이름이 잘못된 이유를 설명하고 리소스 명명 요구 사항을 제공하는 메시지입니다. 'reason' 속성에 'Invalid'가 반환된 경우에만 사용할 수 있습니다.
nameAvailable	boolean	이름을 사용할 수 있는지 여부를 나타내는 값입니다.
reason	UnavailableNameReason	이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다.

CloudError

API 오류에 대한 정보를 포함합니다.

Name	형식	Description
error	CloudErrorBody	오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.
message	string	무엇이 잘못되었는지를 암시하는 오류에 대한 간략한 설명입니다(세부 정보/디버깅 정보는 'error.message' 속성을 참조).

CloudErrorBody

오류 코드와 메시지가 있는 특정 API 오류를 설명합니다.

Name	형식	Description
code	string	HTTP 상태 코드보다 오류 조건을 보다 정확하게 설명하는 오류 코드입니다. 프로그래밍 방식으로 특정 오류 사례를 처리하는 데 사용할 수 있습니다.
details	CloudErrorBody[]	이 오류와 관련된 중첩된 오류를 포함합니다.
message	string	오류를 자세히 설명하고 디버깅 정보를 제공하는 메시지입니다.
target	string	특정 오류의 대상입니다(예: 오류에 있는 속성의 이름).

ResourceType

이름의 유효성을 검사할 리소스의 형식입니다. 이 값은 항상 'searchServices'여야 합니다.

Name	형식	Description
searchServices	string	'searchServices'는 이름의 유효성을 검사할 수 있는 유일한 리소스 유형입니다.

UnavailableNameReason

이름을 사용할 수 없는 이유입니다. 'Invalid'는 제공된 이름이 명명 요구 사항(잘못된 길이, 지원되지 않는 문자 등)과 일치하지 않음을 나타냅니다. 'AlreadyExists'는 이름이 이미 사용 중이므로 사용할 수 없음을 나타냅니다.

Name	형식	Description
AlreadyExists	string	검색 서비스 이름은 이미 다른 검색 서비스에 할당되어 있습니다.
Invalid	string	검색 서비스 이름이 명명 요구 사항과 일치하지 않습니다.