Aliases - Create Or Update

Servizio:: Search Service

Versione API:: 2026-05-01-preview

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

PUT {endpoint}/aliases('{aliasName}')?api-version=2026-05-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
aliasName	path	True	string	Nome dell'alias.
endpoint	path	True	string (uri)	URL dell'endpoint del servizio di ricerca.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Accept		Accept	L'intestazione Accetta.
If-Match		string	Definisce la condizione di If-Match. L'operazione verrà eseguita solo se l'ETag sul 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	Prefer	Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.
x-ms-client-request-id		string (uuid)	Identificatore di stringa opaco, univoco a livello globale e generato dal client per la richiesta.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
indexes	True	string[]	Nome dell'indice a cui viene eseguito il mapping dell'alias. È possibile specificare un solo nome di indice.
name	True	string	Nome dell'alias.
@odata.etag		string	L'ETag dell'alias.

Risposte

Nome	Tipo	Descrizione
200 OK	SearchAlias	La richiesta ha avuto esito positivo.
201 Created	SearchAlias	La richiesta ha avuto esito positivo e di conseguenza è stata creata una nuova risorsa.
Other Status Codes	ErrorResponse	Risposta di errore imprevista.

Sicurezza

api-key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ambiti

Nome	Descrizione
https://search.azure.com/.default

Esempio

SearchServiceCreateOrUpdateAlias

Esempio di richiesta

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-05-01-preview





{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ],
  "@odata.etag": "0x1234568AE7E58A1"
}

Risposta di esempio

Codice di stato:: 200

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Codice di stato:: 201

{
  "name": "myalias",
  "indexes": [
    "preview-test"
  ]
}

Definizioni

Nome	Descrizione
Accept	L'intestazione Accetta.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
Prefer	Per le richieste HTTP PUT, indica al servizio di restituire la risorsa creata/aggiornata in caso di esito positivo.
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.

Accept

Enumerazione

L'intestazione Accetta.

Valore	Descrizione
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Oggetto

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info		Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Oggetto

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	La destinazione dell'errore.

ErrorResponse

Oggetto

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

Prefer

Enumerazione

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

Valore	Descrizione
return=representation

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	L'ETag dell'alias.
indexes	string[]	Nome dell'indice a cui viene eseguito il mapping dell'alias. È possibile specificare un solo nome di indice.
name	string	Nome dell'alias.