Services - Check Name Availability

Serviço:

Search Management

Versão da API:

2023-11-01

Verifica se o nome do serviço de pesquisa especificado está ou não disponível para utilização. Serviço de pesquisa nomes têm de ser globalmente exclusivos, uma vez que fazem parte do URI do serviço (https://.search.windows.net).

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
subscriptionId	path	True	string	O identificador exclusivo de uma subscrição do Microsoft Azure. Pode obter este valor a partir da API de Resource Manager do Azure, das ferramentas de linha de comandos ou do portal.
api-version	query	True	string	A versão da API a utilizar para cada pedido.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
x-ms-client-request-id		string uuid	Um valor GUID gerado pelo cliente que identifica este pedido. Se for especificado, isto será incluído nas informações de resposta como forma de controlar o pedido.

Corpo do Pedido

Name	Necessário	Tipo	Description
name	True	string	O nome do serviço de pesquisa a validar. Serviço de pesquisa nomes só têm de conter letras minúsculas, dígitos ou traços, não podem utilizar traços como os dois primeiros ou últimos carateres, não podem conter traços consecutivos e têm de ter entre 2 e 60 carateres de comprimento.
type	True	ResourceType	O tipo de recurso cujo nome deve ser validado. Este valor tem de ser sempre "searchServices".

Respostas

Name	Tipo	Description
200 OK	CheckNameAvailabilityOutput	A verificação de nome foi concluída. A resposta contém detalhes sobre se o nome é válido e está disponível. Se o nome for inválido, a resposta também contém uma mensagem a explicar porque não.
Other Status Codes	CloudError	HTTP 400 (Pedido Incorreto): o tipo de recurso especificado não é "searchServices".

Segurança

azure_auth

Microsoft Entra ID fluxo de autorização OAuth2.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

SearchCheckNameAvailability

Pedido de amostra

HTTP

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

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

Java

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

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/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

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/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

dotnet

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

Resposta da amostra

Código de estado:

200

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

Definições

Name	Description
CheckNameAvailabilityInput	Entrada da API de disponibilidade de nomes de verificação.
CheckNameAvailabilityOutput	Saída da API de disponibilidade de nomes de verificação.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro específico da API com um código de erro e uma mensagem.
ResourceType	O tipo de recurso cujo nome deve ser validado. Este valor tem de ser sempre "searchServices".
UnavailableNameReason	O motivo pelo qual o nome não está disponível. "Inválido" indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, carateres não suportados, etc.). "AlreadyExists" indica que o nome já está a ser utilizado e, portanto, está indisponível.

CheckNameAvailabilityInput

Entrada da API de disponibilidade de nomes de verificação.

Name	Tipo	Description
name	string	O nome do serviço de pesquisa a validar. Serviço de pesquisa nomes só têm de conter letras minúsculas, dígitos ou traços, não podem utilizar traços como os dois primeiros ou últimos carateres, não podem conter traços consecutivos e têm de ter entre 2 e 60 carateres de comprimento.
type	ResourceType	O tipo de recurso cujo nome deve ser validado. Este valor tem de ser sempre "searchServices".

CheckNameAvailabilityOutput

Saída da API de disponibilidade de nomes de verificação.

Name	Tipo	Description
message	string	Uma mensagem que explica por que motivo o nome é inválido e fornece requisitos de nomenclatura de recursos. Disponível apenas se "Inválido" for devolvido na propriedade "reason".
nameAvailable	boolean	Um valor que indica se o nome está disponível.
reason	UnavailableNameReason	O motivo pelo qual o nome não está disponível. "Inválido" indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, carateres não suportados, etc.). "AlreadyExists" indica que o nome já está a ser utilizado e, portanto, está indisponível.

CloudError

Contém informações sobre um erro de API.

Name	Tipo	Description
error	CloudErrorBody	Descreve um erro específico da API com um código de erro e uma mensagem.

CloudErrorBody

Descreve um erro específico da API com um código de erro e uma mensagem.

Name	Tipo	Description
code	string	Um código de erro que descreve a condição de erro com mais precisão do que um código de estado HTTP. Pode ser utilizado para processar programaticamente casos de erro específicos.
details	CloudErrorBody[]	Contém erros aninhados relacionados com este erro.
message	string	Uma mensagem que descreve o erro em detalhe e fornece informações de depuração.
target	string	O destino do erro específico (por exemplo, o nome da propriedade em erro).

ResourceType

O tipo de recurso cujo nome deve ser validado. Este valor tem de ser sempre "searchServices".

Name	Tipo	Description
searchServices	string	"searchServices" é o único tipo de recurso cujo nome pode ser validado.

UnavailableNameReason

O motivo pelo qual o nome não está disponível. "Inválido" indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, carateres não suportados, etc.). "AlreadyExists" indica que o nome já está a ser utilizado e, portanto, está indisponível.

Name	Tipo	Description
AlreadyExists	string	O nome do serviço de pesquisa já está atribuído a um serviço de pesquisa diferente.
Invalid	string	O nome do serviço de pesquisa não corresponde aos requisitos de nomenclatura.