Aliases - Create Or Update

Servicio:: Search Service

Versión de la API:: 2025-05-01-preview

Crea un nuevo alias de búsqueda o actualiza un alias si ya existe.

PUT {endpoint}/aliases('{aliasName}')?api-version=2025-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
aliasName	path	True	string	Definición del alias que se va a crear o actualizar.
endpoint	path	True	string	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.
If-Match		string	Define la condición If-Match. La operación solo se realizará si el ETag del servidor coincide con este valor.
If-None-Match		string	Define la condición If-None-Match. La operación solo se realizará si la ETag del servidor no coincide con este valor.
Prefer	True	string	En el caso de las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado o actualizado si se ha realizado correctamente.

Cuerpo de la solicitud

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

Respuestas

Nombre	Tipo	Description
200 OK	SearchAlias
201 Created	SearchAlias
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

SearchServiceCreateOrUpdateAlias

Solicitud de ejemplo

HTTP

PUT https://previewexampleservice.search.windows.net/aliases('myalias')?api-version=2025-05-01-preview





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

Respuesta de muestra

status code:: 200

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

status code:: 201

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
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.

ErrorAdditionalInfo

Objeto

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

Nombre	Tipo	Description
info	object	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

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	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.