Creación o actualización de alias (API REST de versión preliminar)
Se aplica a: 2023-07-01-Preview, 2021-04-30-Preview
Importante
2023-07-01-Preview (sin cambios).
2021-04-30-Preview agrega la API.
En Azure AI Search, un alias es un nombre secundario que se puede usar para hacer referencia a un índice para consultar, indexar y otras operaciones.
Puede usar POST o PUT en una solicitud de creación. Para cualquiera de ellos, el documento JSON del cuerpo de la solicitud proporciona la definición de objeto.
POST https://[service name].search.windows.net/aliases?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Para las solicitudes de actualización, use PUT y especifique el nombre de alias en el URI.
PUT https://[service name].search.windows.net/aliases/[alias name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
HTTPS es necesario para todas las solicitudes de servicio. En el caso de PUT, si el alias no existe, se crea. Si ya existe, se actualiza a la nueva definición.
La creación de un alias establece una asignación entre un nombre de alias y un nombre de índice. Si la solicitud se realiza correctamente, el alias se puede usar para la indexación, la consulta y otras operaciones.
La actualización de un alias le permite asignar ese alias a un índice de búsqueda diferente. Al actualizar un alias existente, toda la definición se reemplaza por el contenido del cuerpo de la solicitud. En general, el mejor patrón que se debe usar para las actualizaciones es recuperar la definición de alias con get, modificarla y, a continuación, actualizarla con PUT.
Nota
Una actualización de un alias puede tardar hasta 10 segundos en propagarse por el sistema, por lo que debe esperar al menos 10 segundos antes de eliminar el índice al que se asignó anteriormente el alias.
Nota
El número máximo de alias que puede crear varía según el plan de tarifa. Para más información, consulte los límites del servicio.
Parámetros de identificador URI
| Parámetro | Descripción |
|---|---|
| nombre del servicio | Necesario. Establezca este valor en el nombre único definido por el usuario del servicio de búsqueda. |
| nombre de alias | Obligatorio en el URI si usa PUT. El nombre debe estar en minúsculas, empezar con una letra o un número, no tener barras diagonales ni puntos y tener menos de 128 caracteres. Después de comenzar el nombre con una letra o un número, el resto del nombre puede incluir cualquier letra, número y guiones, siempre y cuando los guiones no sean consecutivos. |
| api-version | Necesario. La versión preliminar actual es 2023-07-01-Preview. Consulte Versiones de API para obtener más versiones. |
Encabezados de solicitud
En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.
| Campos | Descripción |
|---|---|
| Content-Type | Necesario. Establezca este valor en . application/json |
| api-key | Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes de creación deben incluir un api-key encabezado establecido en la clave de administrador (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene una definición de alias, que incluye el nombre de un alias y una matriz con el nombre de un único índice.
El siguiente JSON es una representación de alto nivel de las partes principales de la definición.
{
"name" : (optional on PUT; required on POST) "The name of the alias",
"indexes" : (required) ["The name of the index the alias is mapped to"]
}
La solicitud contiene las siguientes propiedades:
| Propiedad | Descripción |
|---|---|
| name | Necesario. Nombre del alias. Un nombre de alias solo debe contener letras minúsculas, dígitos o guiones, no puede iniciar ni terminar con guiones y está limitado a 128 caracteres. |
| índices | Necesario. Nombre del índice al que se asigna el alias. Solo se puede incluir un nombre de índice único en la matriz. |
Response
Para obtener una solicitud de creación correcta, debería ver el código de estado "201 Created".
Para obtener una solicitud de actualización correcta, debería ver "204 Sin contenido".
Ejemplos
Ejemplo: un alias de índice
{
"name" : "my-alias",
"indexes" : ["my-index"]
}