Aliases - Create Or Update

Referenz

Dienst:: Search Service

API-Version:: 2023-10-01-Preview

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
aliasName	path	True	string	Die Definition des zu erstellenden oder zu aktualisierenden Alias.
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
api-version	query	True	string	Client-API-Version.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Die Tracking-ID, die mit der Anforderung gesendet wurde, beim Debuggen zu helfen.
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	string	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource nach 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	SearchError	Fehlerantwort.

Beispiele

SearchServiceCreateOrUpdateAlias

Beispielanforderung

HTTP

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


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

Beispiel für eine Antwort

Statuscode:: 200

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

Statuscode:: 201

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

Definitionen

Name	Beschreibung
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.
SearchError	Beschreibt eine Fehlerbedingung für die API.

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.

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.

SearchError

Beschreibt eine Fehlerbedingung für die API.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	SearchError[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.

Freigeben über