Aliases - Create

Serviço:: Search Service

Versão da API:: 2026-08-01-preview

Cria um novo alias de pesquisa.

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

Parâmetros de URI

Nome	Em	Obrigató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 ser usada para esta operação.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Accept		Accept	O cabeçalho Aceitar.
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

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
201 Created	SearchAlias	A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

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

Escopos

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

Exemplos

SearchServiceCreateAlias

Solicitação de exemplo

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/aliases?api-version=2026-08-01-preview



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

Resposta de exemplo

Código de status:: 201

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

Definições

Nome	Description
Accept	O cabeçalho Aceitar.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (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 com suporte.

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Informações adicionais do erro.
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

Objeto

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

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SearchAlias

Objeto

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.