Aliases - Create Or Update

Dienst:: Search Service

API-Version:: 2025-08-01-preview

Erstellt einen neuen Suchalias oder aktualisiert einen Alias, falls er bereits vorhanden ist.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
aliasName	path	True	string	Die Definition des Alias, der erstellt oder aktualisiert werden soll.
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string	Version der Client-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.
If-Match		string	Definiert die If-Match Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server mit diesem Wert übereinstimmt.
If-None-Match		string	Definiert die Bedingung Wenn-None-Match. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer	True	string	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
indexes	True	string[]	Der Name des Indexes, dem dieser Alias zugeordnet ist. Es kann nur ein Indexname angegeben werden.
name	True	string	Der Name des Alias.
@odata.etag		string	Das ETag des Alias.

Antworten

Name	Typ	Beschreibung
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchServiceCreateOrUpdateAlias

Beispielanforderung

HTTP

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





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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
SearchAlias	Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann bei unterstützten Operationen anstelle des Indexnamens verwendet werden.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

SearchAlias

Objekt

Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann bei unterstützten Operationen anstelle des Indexnamens verwendet werden.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag des Alias.
indexes	string[]	Der Name des Indexes, dem dieser Alias zugeordnet ist. Es kann nur ein Indexname angegeben werden.
name	string	Der Name des Alias.