Aliases - Get

Servicio:: Search Service

Versión de la API:: 2026-08-01-preview

Recupera una definición de alias.

GET {endpoint}/aliases('{aliasName}')?api-version=2026-08-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
aliasName	path	True	string	Nombre del alias.
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
x-ms-client-request-id		string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Respuestas

Nombre	Tipo	Description
200 OK	SearchAlias	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

SearchServiceGetAlias

Solicitud de ejemplo

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/aliases('myalias')?api-version=2026-08-01-preview

Respuesta de muestra

status code:: 200

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

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
SearchAlias	Representa un alias de índice, que describe una asignación del nombre del alias a un índice. El nombre del alias se puede usar en lugar del nombre de índice para las operaciones admitidas.

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

SearchAlias

Objeto

Representa un alias de índice, que describe una asignación del nombre del alias a un índice. El nombre del alias se puede usar en lugar del nombre de índice para las operaciones admitidas.

Nombre	Tipo	Description
@odata.etag	string	La ETag del alias.
indexes	string[]	Nombre del índice al que se asigna este alias. Solo se puede especificar un nombre de índice.
name	string	Nombre del alias.