Aliases - Create Or Update

Servizio:
Search Service
Versione API:
2023-10-01-Preview

Crea un nuovo alias di ricerca o aggiorna un alias, se già esistente.

PUT {endpoint}/aliases('{aliasName}')?api-version=2023-10-01-Preview

Parametri dell'URI

Nome In Necessario Tipo Descrizione
aliasName
 path True

string

Definizione dell'alias da creare o aggiornare.
endpoint
 path True

string

URL dell'endpoint del servizio di ricerca.
api-version
 query True

string

Versione dell'API client.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
x-ms-client-request-id

string (uuid)

ID di rilevamento inviato con la richiesta per facilitare il debug.
If-Match

string

Definisce la condizione di If-Match. L'operazione verrà eseguita solo se l'ETag nel server corrisponde a questo valore.
If-None-Match

string

Definisce la condizione If-None-Match. L'operazione verrà eseguita solo se l'ETag nel server non corrisponde a questo valore.
Prefer True

string

Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.

Corpo della richiesta

Nome Necessario Tipo Descrizione
indexes True

string[]

Nome dell'indice a cui viene mappato questo alias. È possibile specificare un solo nome di indice.
name True

string

Nome dell'alias.
@odata.etag

string

ETag dell'alias.

Risposte

Nome Tipo Descrizione
200 OK

SearchAlias

201 Created

SearchAlias

Other Status Codes

SearchError

Risposta di errore.

Esempio

SearchServiceCreateOrUpdateAlias

Esempio di richiesta

PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Risposta di esempio

Codice di stato:
200 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}
Codice di stato:
201 
{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Definizioni

Nome Descrizione
SearchAlias

Rappresenta un alias di indice, che descrive un mapping dal nome alias a un indice. Il nome alias può essere usato al posto del nome dell'indice per le operazioni supportate.
SearchError

Descrive una condizione di errore per l'API.

SearchAlias

Oggetto

Rappresenta un alias di indice, che descrive un mapping dal nome alias a un indice. Il nome alias può essere usato al posto del nome dell'indice per le operazioni supportate.

Nome Tipo Descrizione
@odata.etag

string

ETag dell'alias.
indexes

string[]

Nome dell'indice a cui viene mappato questo alias. È possibile specificare un solo nome di indice.
name

string

Nome dell'alias.

SearchError

Oggetto

Descrive una condizione di errore per l'API.

Nome Tipo Descrizione
code

string

Uno di un set definito dal server di codici di errore.
details

SearchError[]

Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
message

string

Rappresentazione leggibile dell'errore.