Services - Check Name Availability
Verifica se o nome do serviço de pesquisa fornecido está disponível ou não 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 de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
A ID da assinatura de destino. O valor deve ser uma UUID. |
|
api-version
|
query | True |
string minLength: 1 |
A versão da API a ser usada para esta operação. |
Cabeçalho da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| 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 maneira de acompanhar a solicitação. |
Corpo da solicitação
| Nome | Obrigatório | Tipo | Description |
|---|---|---|---|
| name | True |
string |
O nome do serviço de pesquisa a ser validado. Os nomes do serviço de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traços como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento. |
| type | True |
enum:
search |
O tipo do recurso cujo nome deve ser validado. Esse valor deve ser sempre 'searchServices'. |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
A solicitação foi bem-sucedida. |
|
| Other Status Codes |
Uma resposta de erro inesperada. |
Segurança
azure_auth
Fluxo do OAuth2 do Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL de Autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Escopos
| Nome | Description |
|---|---|
| user_impersonation | representar sua conta de usuário |
Exemplos
SearchCheckNameAvailability
Solicitação de exemplo
Resposta de exemplo
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Definições
| Nome | Description |
|---|---|
|
Check |
Entrada da API de disponibilidade de nome de verificação. |
|
Check |
Saída da API de disponibilidade de nome de verificação. |
|
Cloud |
Contém informações sobre um erro de API. |
|
Cloud |
Descreve um erro de API específico com um código de erro e uma mensagem. |
|
Unavailable |
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, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível. |
CheckNameAvailabilityInput
Entrada da API de disponibilidade de nome de verificação.
| Nome | Tipo | Description |
|---|---|---|
| name |
string |
O nome do serviço de pesquisa a ser validado. Os nomes do serviço de pesquisa devem conter apenas letras minúsculas, dígitos ou traços, não podem usar traços como os dois primeiros ou últimos caracteres, não podem conter traços consecutivos e devem ter entre 2 e 60 caracteres de comprimento. |
| type |
enum:
search |
O tipo do recurso cujo nome deve ser validado. Esse valor deve ser sempre 'searchServices'. |
CheckNameAvailabilityOutput
Saída da API de disponibilidade de nome de verificação.
| Nome | Tipo | Description |
|---|---|---|
| message |
string |
Uma mensagem que explica por que o nome é inválido e fornece requisitos de nomenclatura de recursos. Disponível somente se 'Invalid' for retornado na propriedade 'reason'. |
| nameAvailable |
boolean |
Um valor que indica se o nome está disponível. |
| reason |
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, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível. |
CloudError
Contém informações sobre um erro de API.
| Nome | Tipo | Description |
|---|---|---|
| error |
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 indica o que deu errado (para obter detalhes/informações de depuração, consulte a propriedade 'error.message'). |
CloudErrorBody
Descreve um erro de API específico com um código de erro e uma mensagem.
| Nome | 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 status HTTP. Pode ser usado para lidar programaticamente com casos de erro específicos. |
| details |
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
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, caracteres sem suporte etc.). 'AlreadyExists' indica que o nome já está em uso e, portanto, não está disponível.
| Valor | Description |
|---|---|
| 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. |