Services - Check Name Availability
Controlla se il nome del servizio di ricerca specificato è disponibile per l'uso. I nomi dei servizi di ricerca devono essere univoci a livello globale poiché fanno parte dell'URI del servizio (https://< name.search.windows.net>).
POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Search/checkNameAvailability?api-version=2025-05-01
Parametri dell'URI
| Nome | In | Necessario | Tipo | Descrizione |
|---|---|---|---|---|
|
subscription
|
path | True |
string (uuid) |
ID della sottoscrizione di destinazione. Il valore deve essere un UUID. |
|
api-version
|
query | True |
string minLength: 1 |
Versione dell'API da usare per questa operazione. |
Intestazione della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Valore GUID generato dal client che identifica questa richiesta. Se specificato, verrà incluso nelle informazioni di risposta come modo per tenere traccia della richiesta. |
Corpo della richiesta
| Nome | Necessario | Tipo | Descrizione |
|---|---|---|---|
| name | True |
string |
Nome del servizio di ricerca da convalidare. I nomi dei servizi di ricerca devono contenere solo lettere minuscole, cifre o trattini, non possono usare trattini come primi due o ultimi caratteri, non possono contenere trattini consecutivi e devono avere una lunghezza compresa tra 2 e 60 caratteri. |
| type | True |
enum:
search |
Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve essere sempre 'searchServices'. |
Risposte
| Nome | Tipo | Descrizione |
|---|---|---|
| 200 OK |
La richiesta ha avuto esito positivo. |
|
| Other Status Codes |
Risposta di errore imprevista. |
Sicurezza
azure_auth
Flusso OAuth2 di Azure Active Directory.
Tipo:
oauth2
Flow:
implicit
URL di autorizzazione:
https://login.microsoftonline.com/common/oauth2/authorize
Ambiti
| Nome | Descrizione |
|---|---|
| user_impersonation | rappresentare l'account utente |
Esempio
SearchCheckNameAvailability
Esempio di richiesta
Risposta di esempio
{
"message": "",
"nameAvailable": false,
"reason": "AlreadyExists"
}
Definizioni
| Nome | Descrizione |
|---|---|
|
Check |
Input dell'API di disponibilità del nome check. |
|
Check |
Output dell'API di disponibilità del nome check. |
|
Cloud |
Contiene informazioni su un errore dell'API. |
|
Cloud |
Descrive un particolare errore dell'API con un codice di errore e un messaggio. |
|
Unavailable |
Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza non corretta, caratteri non supportati e così via). 'AlreadyExists' indica che il nome è già in uso e pertanto non è disponibile. |
CheckNameAvailabilityInput
Input dell'API di disponibilità del nome check.
| Nome | Tipo | Descrizione |
|---|---|---|
| name |
string |
Nome del servizio di ricerca da convalidare. I nomi dei servizi di ricerca devono contenere solo lettere minuscole, cifre o trattini, non possono usare trattini come primi due o ultimi caratteri, non possono contenere trattini consecutivi e devono avere una lunghezza compresa tra 2 e 60 caratteri. |
| type |
enum:
search |
Tipo della risorsa il cui nome deve essere convalidato. Questo valore deve essere sempre 'searchServices'. |
CheckNameAvailabilityOutput
Output dell'API di disponibilità del nome check.
| Nome | Tipo | Descrizione |
|---|---|---|
| message |
string |
Messaggio che spiega perché il nome non è valido e fornisce i requisiti di denominazione delle risorse. Disponibile solo se la proprietà 'Invalid' viene restituita nella proprietà 'reason'. |
| nameAvailable |
boolean |
Valore che indica se il nome è disponibile. |
| reason |
Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza non corretta, caratteri non supportati e così via). 'AlreadyExists' indica che il nome è già in uso e pertanto non è disponibile. |
CloudError
Contiene informazioni su un errore dell'API.
| Nome | Tipo | Descrizione |
|---|---|---|
| error |
Descrive un particolare errore dell'API con un codice di errore e un messaggio. |
|
| message |
string |
Breve descrizione dell'errore che indica cosa è andato storto (per informazioni dettagliate/debug fare riferimento alla proprietà 'error.message'). |
CloudErrorBody
Descrive un particolare errore dell'API con un codice di errore e un messaggio.
| Nome | Tipo | Descrizione |
|---|---|---|
| code |
string |
Codice di errore che descrive più precisamente la condizione di errore rispetto a un codice di stato HTTP. Può essere usato per gestire casi di errore specifici a livello di codice. |
| details |
Contiene errori annidati correlati a questo errore. |
|
| message |
string |
Messaggio che descrive l'errore in dettaglio e fornisce informazioni di debug. |
| target |
string |
Destinazione dell'errore specifico, ad esempio il nome della proprietà in errore. |
UnavailableNameReason
Motivo per cui il nome non è disponibile. 'Invalid' indica che il nome specificato non corrisponde ai requisiti di denominazione (lunghezza non corretta, caratteri non supportati e così via). 'AlreadyExists' indica che il nome è già in uso e pertanto non è disponibile.
| Valore | Descrizione |
|---|---|
| Invalid |
Il nome del servizio di ricerca non corrisponde ai requisiti di denominazione. |
| AlreadyExists |
Il nome del servizio di ricerca è già assegnato a un servizio di ricerca diverso. |