Aliases - List

Service:: Search Service

API-versie:: 2026-04-01

Een lijst met alle aliassen die beschikbaar zijn voor een zoekservice.

GET {endpoint}/aliases?api-version=2026-04-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Accept		Accept	De Accepteer kop.
x-ms-client-request-id		string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Antwoorden

Name	Type	Description
200 OK	ListAliasesResult	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

SearchServiceListAliases

Voorbeeldaanvraag

HTTP

GET https://exampleservice.search.windows.net/aliases?api-version=2026-04-01

Voorbeeldrespons

Statuscode:: 200

{
  "value": [
    {
      "name": "myalias",
      "indexes": [
        "example-index"
      ]
    }
  ]
}

Definities

Name	Description
Accept	De Accepteer kop.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
ListAliasesResult	Antwoord op een verzoek voor een lijst aliassen. Als dit lukt, worden de bijbehorende indextoewijzingen voor alle aliassen opgenomen.
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.

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error	ErrorDetail	Het foutobject.

ListAliasesResult

Object

Antwoord op een verzoek voor een lijst aliassen. Als dit lukt, worden de bijbehorende indextoewijzingen voor alle aliassen opgenomen.

Name	Type	Description
value	SearchAlias[]	De aliassen in de zoekservice.

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 waarnaar deze alias verwijst. Er mag slechts één indexnaam worden opgegeven.
name	string	De naam van de alias.