Aliases - Create Or Update

Referencia

Servicio:: Search Service

Versión de la API:: 2023-10-01-Preview

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

PUT {endpoint}/aliases('{aliasName}')?api-version=2023-10-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 de If-Match. La operación solo se realizará si la 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	SearchError	Respuesta de error.

Ejemplos

SearchServiceCreateOrUpdateAlias

Solicitud de ejemplo

HTTP

PUT https://myservice.search.windows.net/aliases('production')?api-version=2023-10-01-Preview


{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Respuesta de muestra

status code:: 200

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

status code:: 201

{
  "name": "production",
  "indexes": [
    "hotels"
  ]
}

Definiciones

Nombre	Description
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 del índice para las operaciones admitidas.
SearchError	Describe una condición de error para la API.

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

SearchError

Describe una condición de error para la API.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	SearchError[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
message	string	Representación legible del error.

Compartir a través de