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 參數

名稱	位於	必要	類型	Description
subscriptionId	path	True	string	Microsoft Azure 訂用帳戶的唯一標識符。您可以從 Azure Resource Manager API 或入口網站取得此值。
api-version	query	True	string	每個要求所使用的 API 版本。

要求標頭

名稱	必要	類型	Description
x-ms-client-request-id		string (uuid)	用戶端產生的 GUID 值，可識別此要求。如果指定，則會以追蹤要求的方式包含在響應資訊中。

要求本文

名稱	必要	類型	Description
name	True	string	要驗證的搜尋服務名稱。搜尋服務名稱必須只包含小寫字母、數位或破折號，不能使用虛線做為前兩個或最後一個字元、不能包含連續連字元，而且長度必須介於 2 到 60 個字元之間。
type	True	ResourceType	要驗證其名稱的資源類型。此值一律必須是『searchServices』。

回應

名稱	類型	Description
200 OK	CheckNameAvailabilityOutput	名稱檢查已完成。回應包含名稱是否有效且可供使用的詳細數據。如果名稱無效，回應也會包含說明原因的訊息。
Other Status Codes	CloudError	HTTP 400 （不正確的要求）：指定的資源類型不是 'searchServices'。

安全性

azure_auth

指定Microsoft身分識別平台上支援的隱含授與流程。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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": ""
}

定義

名稱	Description
CheckNameAvailabilityInput	檢查名稱可用性 API 的輸入。
CheckNameAvailabilityOutput	檢查名稱可用性 API 的輸出。
CloudError	包含 API 錯誤的相關信息。
CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
ResourceType	要驗證其名稱的資源類型。此值一律必須是『searchServices』。
UnavailableNameReason	名稱無法使用的原因。 'Invalid' 表示所提供的名稱不符合命名需求（長度不正確、不支援的字元等）。 'AlreadyExists' 表示名稱已在使用中，因此無法使用。

CheckNameAvailabilityInput

Object

檢查名稱可用性 API 的輸入。

名稱	類型	Description
name	string	要驗證的搜尋服務名稱。搜尋服務名稱必須只包含小寫字母、數位或破折號，不能使用虛線做為前兩個或最後一個字元、不能包含連續連字元，而且長度必須介於 2 到 60 個字元之間。
type	ResourceType	要驗證其名稱的資源類型。此值一律必須是『searchServices』。

CheckNameAvailabilityOutput

Object

檢查名稱可用性 API 的輸出。

名稱	類型	Description
message	string	訊息，說明名稱無效的原因，並提供資源命名需求。只有在『reason』屬性中傳回 'Invalid' 時才可使用。
nameAvailable	boolean	值，指出名稱是否可用。
reason	UnavailableNameReason	名稱無法使用的原因。 'Invalid' 表示所提供的名稱不符合命名需求（長度不正確、不支援的字元等）。 'AlreadyExists' 表示名稱已在使用中，因此無法使用。

CloudError

Object

包含 API 錯誤的相關信息。

名稱	類型	Description
error	CloudErrorBody	描述具有錯誤碼和訊息的特定 API 錯誤。
message	string	錯誤簡短描述，其中提示發生錯誤的原因（如需詳細數據/偵錯資訊，請參閱 'error.message' 屬性。

CloudErrorBody

Object

描述具有錯誤碼和訊息的特定 API 錯誤。

名稱	類型	Description
code	string	比 HTTP 狀態代碼更精確地描述錯誤條件的錯誤碼。可用來以程式設計方式處理特定錯誤案例。
details	CloudErrorBody[]	包含與此錯誤相關的巢狀錯誤。
message	string	描述錯誤的詳細訊息，並提供偵錯資訊。
target	string	特定錯誤的目標（例如，錯誤中的屬性名稱）。

ResourceType

列舉型別

要驗證其名稱的資源類型。此值一律必須是『searchServices』。

值	Description
searchServices	'searchServices' 是唯一可以驗證其名稱的資源類型。

UnavailableNameReason

列舉型別

名稱無法使用的原因。 'Invalid' 表示所提供的名稱不符合命名需求（長度不正確、不支援的字元等）。 'AlreadyExists' 表示名稱已在使用中，因此無法使用。

值	Description
AlreadyExists	搜尋服務名稱已指派給不同的搜尋服務。
Invalid	搜尋服務名稱不符合命名需求。

共用方式為

Services - Check Name Availability

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

範例

SearchCheckNameAvailability

範例要求

範例回覆

定義

CheckNameAvailabilityInput

CheckNameAvailabilityOutput

CloudError

CloudErrorBody

ResourceType

UnavailableNameReason

其他資源