Aliases - Create Or Update

Service:: Search Service

API-versie:: 2023-10-01-Preview

Hiermee maakt u een nieuwe zoekalias of werkt u een alias bij als deze al bestaat.

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

URI-parameters

Name	In	Vereist	Type	Description
aliasName	path	True	string	De definitie van de alias die moet worden gemaakt of bijgewerkt.
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string (uuid)	De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.
If-Match		string	Hiermee definieert u de voorwaarde If-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server overeenkomt met deze waarde.
If-None-Match		string	Definieert de voorwaarde If-None-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server niet overeenkomt met deze waarde.
Prefer	True	string	Voor HTTP PUT-aanvragen geeft u de service de opdracht om de gemaakte/bijgewerkte resource te retourneren bij succes.

Aanvraagbody

Name	Vereist	Type	Description
indexes	True	string[]	De naam van de index waaraan deze alias is toegewezen. Er kan slechts één indexnaam worden opgegeven.
name	True	string	De naam van de alias.
@odata.etag		string	De ETag van de alias.

Antwoorden

Name	Type	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	Foutreactie.

Voorbeelden

SearchServiceCreateOrUpdateAlias

Voorbeeldaanvraag

HTTP

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


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

Voorbeeldrespons

Statuscode:: 200

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

Statuscode:: 201

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

Definities

Name	Description
SearchAlias	Vertegenwoordigt een indexalias, waarmee een toewijzing van de aliasnaam aan een index wordt beschreven. De aliasnaam kan worden gebruikt in plaats van de indexnaam voor ondersteunde bewerkingen.
SearchError	Beschrijft een foutvoorwaarde voor de API.

SearchAlias

Object

Vertegenwoordigt een indexalias, waarmee een toewijzing van de aliasnaam aan een index wordt beschreven. De aliasnaam kan worden gebruikt in plaats van de indexnaam voor ondersteunde bewerkingen.

Name	Type	Description
@odata.etag	string	De ETag van de alias.
indexes	string[]	De naam van de index waaraan deze alias is toegewezen. Er kan slechts één indexnaam worden opgegeven.
name	string	De naam van de alias.

SearchError

Object

Beschrijft een foutvoorwaarde voor de API.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	SearchError[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
message	string	Een leesbare weergave van de fout.