Aliases - Create Or Update

Služba:: Search Service

Verze rozhraní API:: 2024-09-01-preview

Vytvoří nový alias vyhledávání nebo aktualizuje alias, pokud už existuje.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
aliasName	path	True	string	Definice aliasu pro vytvoření nebo aktualizaci
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem, které vám pomůže s laděním.
If-Match		string	Definuje podmínku If-Match. Operace bude provedena pouze v případě, že značky ETag na serveru odpovídají této hodnotě.
If-None-Match		string	Definuje podmínku If-None-Match. Operace bude provedena pouze v případě, že značky ETag na serveru neodpovídají této hodnotě.
Prefer	True	string	U požadavků HTTP PUT dává službě pokyn k vrácení vytvořeného nebo aktualizovaného prostředku při úspěchu.

Text požadavku

Name	Vyžadováno	Typ	Description
indexes	True	string[]	Název indexu, na který se tento alias mapuje. Je možné zadat pouze jeden název indexu.
name	True	string	Název aliasu.
@odata.etag		string	ETag aliasu.

Odpovědi

Name	Typ	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	ErrorResponse	Chybová odpověď.

Příklady

SearchServiceCreateOrUpdateAlias

Ukázkový požadavek

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2024-09-01-preview





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

Ukázková odpověď

Stavový kód:: 200

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

Stavový kód:: 201

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

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
SearchAlias	Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

SearchAlias

Objekt

Představuje alias indexu, který popisuje mapování z názvu aliasu na index. Název aliasu lze použít místo názvu indexu pro podporované operace.

Name	Typ	Description
@odata.etag	string	ETag aliasu.
indexes	string[]	Název indexu, na který se tento alias mapuje. Je možné zadat pouze jeden název indexu.
name	string	Název aliasu.