Aliases - Create Or Update

Dienst:: Search Service

API-Version:: 2026-08-01-preview

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
aliasName	path	True	string	Der Name des Alias.
endpoint	path	True	string (uri)	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Accept		Accept	Die Überschrift "Annehmen".
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 If-None-Match-Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer	True	Prefer	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
x-ms-client-request-id		string (uuid)	Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

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	Die Anforderung ist erfolgreich.
201 Created	SearchAlias	Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

api-key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiche

Name	Beschreibung
https://search.azure.com/.default

Beispiele

SearchServiceCreateOrUpdateAlias

Beispielanforderung

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-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
Accept	Die Überschrift "Annehmen".
ErrorAdditionalInfo	Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
Prefer	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
SearchAlias	Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann anstelle des Indexnamens für unterstützte Vorgänge verwendet werden.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert	Beschreibung
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name	Typ	Beschreibung
info		Zusätzliche Informationen.
type	string	Typ der Zusatzinformationen.

ErrorDetail

Objekt

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die Zusatzinformationen zum Fehler.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Der Fehlerzielwert.

ErrorResponse

Objekt

Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

Prefer

Enumeration

Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Wert	Beschreibung
return=representation

SearchAlias

Objekt

Stellt einen Indexalias dar, der eine Zuordnung vom Aliasnamen zu einem Index beschreibt. Der Aliasname kann anstelle des Indexnamens für unterstützte Vorgänge 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.