Aliases - Create Or Update

Usługa:: Search Service

Wersja interfejsu API:: 2026-04-01

Tworzy nowy alias wyszukiwania lub aktualizuje alias, jeśli już istnieje.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
aliasName	path	True	string	Nazwa aliasu.
endpoint	path	True	string (uri)	Adres URL punktu końcowego usługi wyszukiwania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Accept		Accept	Nagłówek Accept.
If-Match		string	Definiuje warunek If-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze jest zgodny z tą wartością.
If-None-Match		string	Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością.
Prefer	True	Prefer	W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwa	Wymagane	Typ	Opis
indexes	True	string[]	Nazwa indeksu, na który jest odwzorowywany alias. Można określić tylko jedną nazwę indeksu.
name	True	string	Nazwa aliasu.
@odata.etag		string	Element ETag aliasu.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SearchAlias	Żądanie zakończyło się pomyślnie.
201 Created	SearchAlias	Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://search.azure.com/.default

Przykłady

SearchServiceCreateOrUpdateAlias

Przykładowe żądanie

HTTP

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





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

Przykładowa odpowiedź

Kod stanu:: 200

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

Kod stanu:: 201

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

Definicje

Nazwa	Opis
Accept	Nagłówek Accept.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
Prefer	W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.
SearchAlias	Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

Accept

Wyliczenie

Nagłówek Accept.

Wartość	Opis
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info		Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Cel błędu.

ErrorResponse

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Prefer

Wyliczenie

W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.

Wartość	Opis
return=representation

SearchAlias

Objekt

Reprezentuje alias indeksu, który opisuje mapowanie z nazwy aliasu na indeks. Nazwa aliasu może być używana zamiast nazwy indeksu dla obsługiwanych operacji.

Nazwa	Typ	Opis
@odata.etag	string	Element ETag aliasu.
indexes	string[]	Nazwa indeksu, na który jest odwzorowywany alias. Można określić tylko jedną nazwę indeksu.
name	string	Nazwa aliasu.