Aliases - Create

Serviço:: Search Service

Versão da API:: 2026-04-01

Cria um novo alias de pesquisa.

POST {endpoint}/aliases?api-version=2026-04-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de string opaco, globalmente único e gerado pelo cliente para o pedido.

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
201 Created	SearchAlias	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

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

Exemplos

SearchServiceCreateAlias

Pedido de amostra

HTTP

POST https://exampleservice.search.windows.net/aliases?api-version=2026-04-01


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

Resposta da amostra

Código de estado:: 201

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

Definições

Name	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)
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.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

SearchAlias

Object

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.