Aliases - Create Or Update
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 do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
alias
|
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 do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
x-ms-client-request-id |
string (uuid) |
O ID de rastreamento enviado com a solicitação para ajudar com a depuração. |
|
If-Match |
string |
Define a condição If-Match. A operação será executada somente se o 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 o 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 do Pedido
Name | Necessário | Tipo | Description |
---|---|---|---|
indexes | True |
string[] |
O nome do índice para o qual esse alias é mapeado. Apenas um nome de índice pode ser especificado. |
name | True |
string |
O nome do alias. |
@odata.etag |
string |
O ETag do alias. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK | ||
201 Created | ||
Other Status Codes |
Resposta de erro. |
Exemplos
SearchServiceCreateOrUpdateAlias
Pedido de amostra
PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview
{
"name": "production",
"indexes": [
"hotels"
]
}
Resposta da amostra
{
"name": "production",
"indexes": [
"hotels"
]
}
{
"name": "production",
"indexes": [
"hotels"
]
}
Definições
Name | Description |
---|---|
Search |
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 suportadas. |
Search |
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 suportadas.
Name | Tipo | Description |
---|---|---|
@odata.etag |
string |
O ETag do alias. |
indexes |
string[] |
O nome do índice para o qual esse alias é mapeado. Apenas um nome de índice pode ser especificado. |
name |
string |
O nome do alias. |
SearchError
Descreve uma condição de erro para a API.
Name | Tipo | Description |
---|---|---|
code |
string |
Um de um conjunto de códigos de erro definido pelo servidor. |
details |
Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado. |
|
message |
string |
Uma representação legível por humanos do erro. |