Services - Check Name Availability

Başvuru

Service:: Search Management

API Version:: 2023-11-01

Verilen arama hizmeti adının kullanılabilir olup olmadığını denetler. hizmet URI'sinin parçası olduklarından Arama hizmeti adları genel olarak benzersiz olmalıdır (https://.search.windows.net).

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
subscriptionId	path	True	string	Microsoft Azure aboneliğinin benzersiz tanımlayıcısı. Bu değeri Azure Resource Manager API'sinden, komut satırı araçlarından veya portaldan alabilirsiniz.
api-version	query	True	string	Her istek için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string uuid	Bu isteği tanımlayan istemci tarafından oluşturulan GUID değeri. Belirtilirse, isteği izlemenin bir yolu olarak yanıt bilgilerine eklenir.

İstek Gövdesi

Name	Gerekli	Tür	Description
name	True	string	Doğrulanması gereken arama hizmeti adı. Arama hizmeti adları yalnızca küçük harf, rakam veya kısa çizgi içermelidir, ilk iki veya son bir karakter olarak tire kullanamaz, ardışık tire içeremez ve 2 ile 60 karakter uzunluğunda olmalıdır.
type	True	ResourceType	Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

Yanıtlar

Name	Tür	Description
200 OK	CheckNameAvailabilityOutput	Ad denetimi tamamlandı. Yanıt, adın geçerli ve kullanılabilir olup olmadığının ayrıntılarını içerir. Ad geçersizse, yanıtta neden olmadığını açıklayan bir ileti de bulunur.
Other Status Codes	CloudError	HTTP 400 (Hatalı İstek): Verilen kaynak türü 'searchServices' değil.

Güvenlik

azure_auth

OAuth2 yetkilendirme akışını Microsoft Entra ID.

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

Scopes

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

SearchCheckNameAvailability

Sample Request

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

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


import com.azure.resourcemanager.search.models.CheckNameAvailabilityInput;

/** Samples for Services CheckNameAvailability. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/examples/SearchCheckNameAvailability.
     * json
     */
    /**
     * Sample code: SearchCheckNameAvailability.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void searchCheckNameAvailability(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.searchServices().manager().serviceClient().getServices().checkNameAvailabilityWithResponse(
            new CheckNameAvailabilityInput().withName("mysearchservice"), null, com.azure.core.util.Context.NONE);
    }
}

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

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/7e29dd59eef13ef347d09e41a63f2585be77b3ca/specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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/stable/2023-11-01/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 System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.Search;
using Azure.ResourceManager.Search.Models;

// Generated from example definition: specification/search/resource-manager/Microsoft.Search/stable/2023-11-01/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

Sample Response

Status code:: 200

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

Tanımlar

Name	Description
CheckNameAvailabilityInput	Denetim adı kullanılabilirlik API'sinin girişi.
CheckNameAvailabilityOutput	Denetim adı kullanılabilirlik API'sinin çıktısı.
CloudError	API hatası hakkında bilgi içerir.
CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.
ResourceType	Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.
UnavailableNameReason	Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists', adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

CheckNameAvailabilityInput

Denetim adı kullanılabilirlik API'sinin girişi.

Name	Tür	Description
name	string	Doğrulanması gereken arama hizmeti adı. Arama hizmeti adları yalnızca küçük harf, rakam veya kısa çizgi içermelidir, ilk iki veya son bir karakter olarak tire kullanamaz, ardışık tire içeremez ve 2 ile 60 karakter uzunluğunda olmalıdır.
type	ResourceType	Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

CheckNameAvailabilityOutput

Denetim adı kullanılabilirlik API'sinin çıktısı.

Name	Tür	Description
message	string	Adın neden geçersiz olduğunu açıklayan ve kaynak adlandırma gereksinimleri sağlayan bir ileti. Yalnızca 'reason' özelliğinde 'Invalid' döndürülürse kullanılabilir.
nameAvailable	boolean	Adın kullanılabilir olup olmadığını gösteren değer.
reason	UnavailableNameReason	Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists', adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

CloudError

API hatası hakkında bilgi içerir.

Name	Tür	Description
error	CloudErrorBody	Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

CloudErrorBody

Hata kodu ve ileti içeren belirli bir API hatası açıklanır.

Name	Tür	Description
code	string	Http durum kodundan daha kesin bir şekilde hata koşulunu açıklayan bir hata kodu. Belirli hata durumlarını program aracılığıyla işlemek için kullanılabilir.
details	CloudErrorBody[]	Bu hatayla ilgili iç içe hatalar içerir.
message	string	Hatayı ayrıntılı olarak açıklayan ve hata ayıklama bilgileri sağlayan bir ileti.
target	string	Belirli bir hatanın hedefi (örneğin, hatadaki özelliğin adı).

ResourceType

Adı doğrulanacak kaynağın türü. Bu değer her zaman 'searchServices' olmalıdır.

Name	Tür	Description
searchServices	string	Adı doğrulanabilen tek kaynak türü 'searchServices'tir.

UnavailableNameReason

Adın kullanılamama nedeni. 'Geçersiz', sağlanan adın adlandırma gereksinimleriyle (yanlış uzunluk, desteklenmeyen karakterler vb.) eşleşmediğini gösterir. 'AlreadyExists', adın zaten kullanımda olduğunu ve bu nedenle kullanılamadığını gösterir.

Name	Tür	Description
AlreadyExists	string	Arama hizmeti adı zaten farklı bir arama hizmetine atanmış.
Invalid	string	Arama hizmeti adı adlandırma gereksinimleriyle eşleşmiyor.

Aracılığıyla paylaş

Services - Check Name Availability

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Scopes

Örnekler

SearchCheckNameAvailability

Sample Request

Sample Response

Tanımlar

CheckNameAvailabilityInput

CheckNameAvailabilityOutput

CloudError

CloudErrorBody

ResourceType

UnavailableNameReason

Ek kaynaklar