Aliases - Create Or Update

Tjänst:: Search Service

API-version:: 2026-08-01-preview

Skapar ett nytt sökalias eller uppdaterar ett alias om det redan finns.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
aliasName	path	True	string	Namnet på aliaset.
endpoint	path	True	string (uri)	Slutpunkts-URL:en för söktjänsten.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
x-ms-client-request-id		string (uuid)	En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.
Accept		Accept	Acceptera-rubriken.
If-Match		string	Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet.
If-None-Match		string	Definierar villkoret If-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet.
Prefer	True	Prefer	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Begärandetext

Name	Obligatorisk	Typ	Description
indexes	True	string[]	Namnet på det index som det här aliaset mappar till. Endast ett indexnamn får anges.
name	True	string	Namnet på aliaset.
@odata.etag		string	ETag för aliaset.

Svar

Name	Typ	Description
200 OK	SearchAlias	Begäran har slutförts.
201 Created	SearchAlias	Begäran har slutförts och en ny resurs har skapats som ett resultat.
Other Status Codes	ErrorResponse	Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

SearchServiceCreateOrUpdateAlias

Exempelbegäran

HTTP

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






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

Exempelsvar

Statuskod:: 200

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

Statuskod:: 201

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

Definitioner

Name	Description
Accept	Acceptera-rubriken.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
Prefer	För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.
SearchAlias	Representerar ett indexalias som beskriver en mappning från aliasnamnet till ett index. Aliasnamnet kan användas i stället för indexnamnet för åtgärder som stöds.

Accept

Uppräkning

Acceptera-rubriken.

Värde	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info		Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error	ErrorDetail	Felobjektet.

Prefer

Uppräkning

För HTTP PUT-begäranden instruerar tjänsten att returnera den skapade/uppdaterade resursen när den lyckas.

Värde	Description
return=representation

SearchAlias

Objekt

Representerar ett indexalias som beskriver en mappning från aliasnamnet till ett index. Aliasnamnet kan användas i stället för indexnamnet för åtgärder som stöds.

Name	Typ	Description
@odata.etag	string	ETag för aliaset.
indexes	string[]	Namnet på det index som det här aliaset mappar till. Endast ett indexnamn får anges.
name	string	Namnet på aliaset.