Services - Check Name Availability

Serviço:: Search Management

Versão da API:: 2024-03-01-preview

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=2024-03-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
subscriptionId	path	True	string	O identificador exclusivo de uma assinatura do Microsoft Azure. Você pode obter esse valor da API do Azure Resource Manager ou do portal.
api-version	query	True	string	A versão da API a ser usada para cada solicitaçã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	ResourceType	O tipo do recurso cujo nome deve ser validado. Este valor deve ser sempre 'searchServices'.

Respostas

Name	Tipo	Descrição
200 OK	CheckNameAvailabilityOutput	A verificação de nome foi concluída. A resposta contém detalhes sobre se o nome é válido e disponível. Se o nome for inválido, a resposta também conterá uma mensagem explicando por que não.
Other Status Codes	CloudError	HTTP 400 (Solicitação incorreta): O tipo de recurso fornecido não é 'searchServices'.

Segurança

azure_auth

Especifica um fluxo de concessão implícito, conforme suportado na plataforma Microsoft Identity.

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

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 200

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

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.
ResourceType	O tipo do recurso cujo nome deve ser validado. Este valor deve ser sempre 'searchServices'.
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	ResourceType	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).

ResourceType

Enumeração

O tipo do recurso cujo nome deve ser validado. Este valor deve ser sempre 'searchServices'.

Valor	Descrição
searchServices	'searchServices' é o único tipo de recurso cujo nome pode ser validado.

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.