Services - Check Name Availability

Serviço:: Search Management

Versão da API:: 2025-05-01

Verifica se o nome do serviço de pesquisa fornecido está ou não disponível para uso. Os nomes de serviço de pesquisa devem ser globalmente exclusivos, pois fazem parte do URI do serviço (https://< name.search.windows.net>).

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Obrigatório	Tipo	Descrição
x-ms-client-request-id		string (uuid)	Um valor GUID gerado pelo cliente que identifica essa solicitação. Se especificado, isso será incluído nas informações de resposta como uma forma de rastrear a solicitação.

Corpo do Pedido

Name	Obrigatório	Tipo	Descrição
name	True	string	O nome do serviço de pesquisa a ser validado. Os nomes dos serviços de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres.
type	True	enum: searchServices	O tipo do recurso cujo nome deve ser validado. Este valor deve ser sempre 'searchServices'.

Respostas

Name	Tipo	Descrição
200 OK	CheckNameAvailabilityOutput	O pedido foi bem-sucedido.
Other Status Codes	CloudError	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Âmbitos

Name	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

SearchCheckNameAvailability

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01

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

// Generated from example definition: 2025-05-01/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("00000000-0000-0000-0000-000000000000", 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"),
	}, 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 = armsearch.ServicesClientCheckNameAvailabilityResponse{
	// 	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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Descrição
CheckNameAvailabilityInput	Entrada da API de disponibilidade de nome de verificação.
CheckNameAvailabilityOutput	Saída da API de disponibilidade de nome de verificação.
CloudError	Contém informações sobre um erro de API.
CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
UnavailableNameReason	A razão pela qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres não suportados, etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

CheckNameAvailabilityInput

Object

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

Name	Tipo	Descrição
name	string	O nome do serviço de pesquisa a ser validado. Os nomes dos serviços de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traço como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres.
type	enum: searchServices	O tipo do recurso cujo nome deve ser validado. Este valor deve ser sempre 'searchServices'.

CheckNameAvailabilityOutput

Object

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

Name	Tipo	Descrição
message	string	Uma mensagem que explica por que o nome é inválido e fornece requisitos de nomenclatura de recursos. Disponível somente se 'Inválido' for retornado na propriedade 'reason'.
nameAvailable	boolean	Um valor que indica se o nome está disponível.
reason	UnavailableNameReason	A razão pela qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres não suportados, etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

CloudError

Object

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

Name	Tipo	Descrição
error	CloudErrorBody	Descreve um erro de API específico com um código de erro e uma mensagem.
message	string	Uma breve descrição do erro que sugere o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message').

CloudErrorBody

Object

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

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

UnavailableNameReason

Enumeração

A razão pela qual o nome não está disponível. 'Inválido' indica que o nome fornecido não corresponde aos requisitos de nomenclatura (comprimento incorreto, caracteres não suportados, etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.

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