Aliases - Create Or Update

Referência

Service:: Search Service

API Version:: 2023-10-01-Preview

Cria um novo alias de pesquisa ou atualiza um alias se ele já existir.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
aliasName	path	True	string	A definição do alias a ser criado ou atualizado.
endpoint	path	True	string	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string	Versão da API do cliente.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string uuid	A ID de rastreamento enviada com a solicitação para ajudar na depuração.
If-Match		string	Define a condição de If-Match. A operação será executada somente se a ETag no servidor corresponder a esse valor.
If-None-Match		string	Define a condição If-None-Match. A operação será executada somente se a ETag no servidor não corresponder a esse valor.
Prefer	True	string	Para solicitações HTTP PUT, instrui o serviço a retornar o recurso criado/atualizado com êxito.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
indexes	True	string[]	O nome do índice para o qual esse alias é mapeado. Somente um nome de índice pode ser especificado.
name	True	string	O nome do alias.
@odata.etag		string	A ETag do alias.

Respostas

Nome	Tipo	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	SearchError	Resposta de erro.

Exemplos

SearchServiceCreateOrUpdateAlias

Sample Request

HTTP

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


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

Sample Response

Status code:: 200

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

Status code:: 201

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

Definições

Nome	Description
SearchAlias	Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser usado no lugar do nome do índice para operações com suporte.
SearchError	Descreve uma condição de erro para a API.

SearchAlias

Representa um alias de índice, que descreve um mapeamento do nome do alias para um índice. O nome do alias pode ser usado no lugar do nome do índice para operações com suporte.

Nome	Tipo	Description
@odata.etag	string	A ETag do alias.
indexes	string[]	O nome do índice para o qual esse alias é mapeado. Somente um nome de índice pode ser especificado.
name	string	O nome do alias.

SearchError

Descreve uma condição de erro para a API.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	SearchError[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
message	string	Uma representação legível pelo homem do erro.

Compartilhar via