Indexers - Create Or Update
Crea un nuevo indexador o actualiza un indexador si ya existe.
PUT {endpoint}/indexers('{indexerName}')?api-version=2026-04-01
Parámetros de identificador URI
| Nombre | En | Requerido | Tipo | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
La dirección URL del punto de conexión del servicio de búsqueda. |
|
indexer
|
path | True |
string |
Nombre del indizador. |
|
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 |
El encabezado Aceptar. |
||
| If-Match |
string |
Define la condición If-Match. La operación se realizará solo si la ETag en el servidor coincide con este valor. |
|
| If-None-Match |
string |
Define la condición If-None-Match. La operación se realizará solo si la ETag en el servidor no coincide con este valor. |
|
| Prefer | True |
Para las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado/actualizado en caso de éxito. |
|
| x-ms-client-request-id |
string (uuid) |
Identificador de cadena globalmente único y generado por el cliente para la solicitud. |
Cuerpo de la solicitud
| Nombre | Requerido | Tipo | Description |
|---|---|---|---|
| dataSourceName | True |
string |
Nombre del origen de datos del que este indexador lee los datos. |
| name | True |
string |
Nombre del indizador. |
| targetIndexName | True |
string |
Nombre del índice en el que este indexador escribe datos. |
| @odata.etag |
string |
ETag del indexador. |
|
| description |
string |
Descripción del indexador. |
|
| disabled |
boolean |
Valor que indica si el indexador está deshabilitado. El valor predeterminado es falso. |
|
| encryptionKey |
Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del indexador (así como el estado de ejecución del indexador) cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del indexador, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; La definición del indexador (y el estado de ejecución del indexador) no se verán afectadas. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios pagos creados a partir del 1 de enero de 2019. |
||
| fieldMappings |
Define las asignaciones entre campos del origen de datos y los campos de destino correspondientes del índice. |
||
| outputFieldMappings |
Las asignaciones de campos de salida se aplican después del enriquecimiento e inmediatamente antes de la indexación. |
||
| parameters |
Parámetros para la ejecución del indexador. |
||
| schedule |
Programación de este indexador. |
||
| skillsetName |
string |
Nombre del conjunto de aptitudes que se ejecuta con este indexador. |
Respuestas
| Nombre | Tipo | Description |
|---|---|---|
| 200 OK |
La solicitud se ha realizado correctamente. |
|
| 201 Created |
La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado. |
|
| Other Status Codes |
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
SearchServiceCreateOrUpdateIndexer
Solicitud de ejemplo
PUT https://exampleservice.search.windows.net/indexers('myaclindexer')?api-version=2026-04-01
{
"name": "myaclindexer",
"description": "Description of the indexer",
"dataSourceName": "indexertestacldatasource",
"targetIndexName": "indexer-test-index",
"schedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"parameters": {
"batchSize": 10,
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [
{
"sourceFieldName": "metadata_storage_title",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
},
{
"sourceFieldName": "metadata_user_ids",
"targetFieldName": "permissionFilters"
}
],
"outputFieldMappings": [
{
"sourceFieldName": "/document",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
}
],
"disabled": false,
"@odata.etag": "0x1234568AE7E58A1"
}
Respuesta de muestra
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "myaclindexer",
"description": "Description of the indexer",
"dataSourceName": "indexertestacldatasource",
"targetIndexName": "indexer-test-index",
"disabled": false,
"schedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"parameters": {
"batchSize": 10,
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5,
"configuration": {}
},
"fieldMappings": [
{
"sourceFieldName": "metadata_storage_title",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
},
{
"sourceFieldName": "metadata_user_ids",
"targetFieldName": "permissionFilters"
}
],
"outputFieldMappings": [
{
"sourceFieldName": "/document",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
}
]
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "myaclindexer",
"description": "Description of the indexer",
"dataSourceName": "indexertestacldatasource",
"targetIndexName": "indexer-test-index",
"disabled": false,
"schedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"parameters": {
"batchSize": 10,
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5,
"configuration": {}
},
"fieldMappings": [
{
"sourceFieldName": "metadata_storage_title",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
},
{
"sourceFieldName": "metadata_user_ids",
"targetFieldName": "permissionFilters"
}
],
"outputFieldMappings": [
{
"sourceFieldName": "/document",
"targetFieldName": "name",
"mappingFunction": {
"name": "base64Encode"
}
}
]
}
Definiciones
| Nombre | Description |
|---|---|
| Accept |
El encabezado Aceptar. |
|
Blob |
Especifica los datos que se van a extraer de Azure Blob Storage e indica al indexador qué datos extraer del contenido de la imagen cuando "imageAction" se establece en un valor distinto de "none". Esto se aplica al contenido de imagen incrustado en una .PDF u otra aplicación, o a archivos de imagen como .jpg y .png, en blobs de Azure. |
|
Blob |
Determina cómo procesar imágenes incrustadas y archivos de imagen en Azure Blob Storage. Establecer la configuración "imageAction" en cualquier valor distinto de "none" requiere que también se asocie un conjunto de aptitudes a ese indexador. |
|
Blob |
Representa el modo de análisis para la indexación desde un origen de datos de blob de Azure. |
|
Blob |
Determina el algoritmo para la extracción de texto de archivos PDF en Azure Blob Storage. |
|
Error |
Información adicional sobre el error de administración de recursos. |
|
Error |
Detalle del error. |
|
Error |
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData). |
|
Field |
Define una asignación entre un campo de un origen de datos y un campo de destino en un índice. |
|
Field |
Representa una función que transforma un valor de un origen de datos antes de la indexación. |
|
Indexer |
Especifica el entorno en el que se debe ejecutar el indexador. |
|
Indexing |
Representa parámetros para la ejecución del indexador. |
|
Indexing |
Diccionario de propiedades de configuración específicas del indexador. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
|
Indexing |
Representa una programación para la ejecución del indexador. |
| Prefer |
Para las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado/actualizado en caso de éxito. |
|
Search |
Representa un indexador. |
|
Search |
Borra la propiedad de identidad de un origen de datos. |
|
Search |
Especifica la identidad de un origen de datos que se va a usar. |
|
Search |
Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos. |
Accept
El encabezado Aceptar.
| Valor | Description |
|---|---|
| application/json;odata.metadata=minimal |
BlobIndexerDataToExtract
Especifica los datos que se van a extraer de Azure Blob Storage e indica al indexador qué datos extraer del contenido de la imagen cuando "imageAction" se establece en un valor distinto de "none". Esto se aplica al contenido de imagen incrustado en una .PDF u otra aplicación, o a archivos de imagen como .jpg y .png, en blobs de Azure.
| Valor | Description |
|---|---|
| storageMetadata |
Indexa solo las propiedades de blob estándar y los metadatos especificados por el usuario. |
| allMetadata |
Extrae los metadatos proporcionados por el subsistema de Azure Blob Storage y los metadatos específicos del tipo de contenido (por ejemplo, los metadatos únicos para solo .png archivos se indexan). |
| contentAndMetadata |
Extrae todos los metadatos y el contenido textual de cada blob. |
BlobIndexerImageAction
Determina cómo procesar imágenes incrustadas y archivos de imagen en Azure Blob Storage. Establecer la configuración "imageAction" en cualquier valor distinto de "none" requiere que también se asocie un conjunto de aptitudes a ese indexador.
| Valor | Description |
|---|---|
| none |
Omite las imágenes incrustadas o los archivos de imagen del conjunto de datos. Este es el valor predeterminado. |
| generateNormalizedImages |
Extrae texto de imágenes (por ejemplo, la palabra "STOP" de un signo de detención de tráfico) e la inserta en el campo de contenido. Esta acción requiere que "dataToExtract" esté establecido en "contentAndMetadata". Una imagen normalizada hace referencia al procesamiento adicional, lo que da lugar a una salida uniforme de imagen, cuyo tamaño y se gira para promover una representación coherente cuando se incluyen imágenes en los resultados de búsqueda visual. Esta información se genera para cada imagen cuando se usa esta opción. |
| generateNormalizedImagePerPage |
Extrae texto de imágenes (por ejemplo, la palabra "STOP" de un signo de detención de tráfico) e la inserta en el campo de contenido, pero trata los archivos PDF de forma diferente en que cada página se representará como una imagen y se normalizará en consecuencia, en lugar de extraer imágenes incrustadas. Los tipos de archivo no PDF se tratarán igual que si se estableció "generateNormalizedImages". |
BlobIndexerParsingMode
Representa el modo de análisis para la indexación desde un origen de datos de blob de Azure.
| Valor | Description |
|---|---|
| default |
Establézcalo en predeterminado para el procesamiento normal de archivos. |
| text |
Establézcalo en texto para mejorar el rendimiento de la indexación en archivos de texto sin formato en Blob Storage. |
| delimitedText |
Establézcalo en delimitedText cuando los blobs son archivos CSV sin formato. |
| json |
Establézcalo en json para extraer contenido estructurado de archivos JSON. |
| jsonArray |
Establézcalo en jsonArray para extraer elementos individuales de una matriz JSON como documentos independientes. |
| jsonLines |
Establezca en jsonLines para extraer entidades JSON individuales, separadas por una nueva línea, como documentos independientes. |
| markdown |
Establezca en markdown para extraer contenido de los archivos markdown. |
BlobIndexerPDFTextRotationAlgorithm
Determina el algoritmo para la extracción de texto de archivos PDF en Azure Blob Storage.
| Valor | Description |
|---|---|
| none |
Aprovecha la extracción de texto normal. Este es el valor predeterminado. |
| detectAngles |
Puede producir una extracción de texto mejor y más legible de los archivos PDF que han girado texto dentro de ellos. Tenga en cuenta que puede haber un pequeño impacto en la velocidad de rendimiento cuando se usa este parámetro. Este parámetro solo se aplica a los archivos PDF y solo a archivos PDF con texto incrustado. Si el texto girado aparece dentro de una imagen insertada en el PDF, este parámetro no se aplica. |
ErrorAdditionalInfo
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
Detalle del error.
| Nombre | Tipo | Description |
|---|---|---|
| additionalInfo |
Información adicional del error. |
|
| code |
string |
Código de error. |
| details |
Detalles del error. |
|
| message |
string |
El mensaje de error. |
| target |
string |
Destino del error. |
ErrorResponse
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).
| Nombre | Tipo | Description |
|---|---|---|
| error |
Objeto de error. |
FieldMapping
Define una asignación entre un campo de un origen de datos y un campo de destino en un índice.
| Nombre | Tipo | Description |
|---|---|---|
| mappingFunction |
Una función que se aplica a cada valor de campo de origen antes de la indexación. |
|
| sourceFieldName |
string |
El nombre del campo en la fuente de datos. |
| targetFieldName |
string |
El nombre del campo de destino en el índice. Igual que el nombre del campo de origen de forma predeterminada. |
FieldMappingFunction
Representa una función que transforma un valor de un origen de datos antes de la indexación.
| Nombre | Tipo | Description |
|---|---|---|
| name |
string |
El nombre de la función de asignación de campos. |
| parameters |
Un diccionario de pares de nombre/valor de parámetro para pasar a la función. Cada valor debe ser de un tipo primitivo. |
IndexerExecutionEnvironment
Especifica el entorno en el que se debe ejecutar el indexador.
| Valor | Description |
|---|---|
| standard |
Indica que el servicio de búsqueda puede determinar dónde se debe ejecutar el indexador. Este es el entorno predeterminado cuando no se especifica nada y es el valor recomendado. |
| private |
Indica que el indexador debe ejecutarse con el entorno aprovisionado específicamente para el servicio de búsqueda. Esto solo debe especificarse como entorno de ejecución si el indexador necesita acceder a los recursos de forma segura a través de recursos de vínculo privado compartido. |
IndexingParameters
Representa parámetros para la ejecución del indexador.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| batchSize |
integer (int32) |
El número de elementos que se leen desde el origen de datos y se indexan como un solo lote para mejorar el rendimiento. El valor predeterminado depende del tipo de origen de datos. |
|
| configuration |
Diccionario de propiedades de configuración específicas del indexador. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo. |
||
| maxFailedItems |
integer (int32) |
0 |
Número máximo de elementos que pueden producir un error en la indexación para que la ejecución del indexador se siga considerando correcta. -1 significa que no hay límite. El valor predeterminado es 0. |
| maxFailedItemsPerBatch |
integer (int32) |
0 |
El número máximo de elementos de un solo lote que pueden producir un error en la indexación para que el lote se considere correcto. -1 significa que no hay límite. El valor predeterminado es 0. |
IndexingParametersConfiguration
Diccionario de propiedades de configuración específicas del indexador. Cada nombre es el nombre de una propiedad específica. Cada valor debe ser de un tipo primitivo.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| allowSkillsetToReadFileData |
boolean |
False |
Si es true, creará una ruta de acceso //document//file_data que es un objeto que representa los datos de archivo originales descargados del origen de datos de blob. Esto le permite pasar los datos de archivo originales a una aptitud personalizada para su procesamiento dentro de la canalización de enriquecimiento o a la aptitud Extracción de documentos. |
| dataToExtract | contentAndMetadata |
Especifica los datos que se van a extraer de Azure Blob Storage e indica al indexador qué datos extraer del contenido de la imagen cuando "imageAction" se establece en un valor distinto de "none". Esto se aplica al contenido de imagen incrustado en una .PDF u otra aplicación, o a archivos de imagen como .jpg y .png, en blobs de Azure. |
|
| delimitedTextDelimiter |
string |
En el caso de los blobs CSV, especifica el delimitador de un solo carácter de final de línea para los archivos CSV donde cada línea inicia un nuevo documento (por ejemplo, "|"). |
|
| delimitedTextHeaders |
string |
En el caso de los blobs CSV, especifica una lista delimitada por comas de encabezados de columna, útil para asignar campos de origen a campos de destino en un índice. |
|
| documentRoot |
string |
En el caso de las matrices JSON, dado un documento estructurado o semiestructurado, puede especificar una ruta de acceso a la matriz mediante esta propiedad. |
|
| excludedFileNameExtensions |
string |
Lista delimitada por comas de extensiones de nombre de archivo que se omitirán al procesar desde Azure Blob Storage. Por ejemplo, podría excluir ".png, .mp4" para omitir esos archivos durante la indexación. |
|
| executionEnvironment | standard |
Especifica el entorno en el que se debe ejecutar el indexador. |
|
| failOnUnprocessableDocument |
boolean |
False |
En el caso de los blobs de Azure, establezca en false si desea continuar la indexación si se produce un error en la indexación de un documento. |
| failOnUnsupportedContentType |
boolean |
False |
En el caso de los blobs de Azure, establezca en false si desea seguir indexando cuando se encuentra un tipo de contenido no admitido y no conoce todos los tipos de contenido (extensiones de archivo) de antemano. |
| firstLineContainsHeaders |
boolean |
True |
En el caso de los blobs CSV, indica que la primera línea (no en blanco) de cada blob contiene encabezados. |
| imageAction | none |
Determina cómo procesar imágenes incrustadas y archivos de imagen en Azure Blob Storage. Establecer la configuración "imageAction" en cualquier valor distinto de "none" requiere que también se asocie un conjunto de aptitudes a ese indexador. |
|
| indexStorageMetadataOnlyForOversizedDocuments |
boolean |
False |
En el caso de los blobs de Azure, establezca esta propiedad en true para indexar los metadatos de almacenamiento para el contenido de blobs demasiado grande para procesar. Los blobs sobredimensionados se tratan como errores de forma predeterminada. Para conocer los límites del tamaño del blob, consulte https://mms.heiai.top/azure/search/search-limits-quotas-capacity. |
| indexedFileNameExtensions |
string |
Lista delimitada por comas de extensiones de nombre de archivo que se van a seleccionar al procesar desde Azure Blob Storage. Por ejemplo, podría centrar la indexación en archivos de aplicación específicos ".docx, .pptx, .msg" para incluir específicamente esos tipos de archivo. |
|
| markdownHeaderDepth |
enum:
|
h6 |
Especifica la profundidad máxima del encabezado que se tendrá en cuenta al agrupar el contenido de Markdown. El valor predeterminado es |
| markdownParsingSubmode |
enum:
|
oneToMany |
Especifica el submodo que determinará si un archivo Markdown se analizará exactamente en un documento de búsqueda o en varios documentos de búsqueda. El valor predeterminado es |
| parsingMode | default |
Representa el modo de análisis para la indexación desde un origen de datos de blob de Azure. |
|
| pdfTextRotationAlgorithm | none |
Determina el algoritmo para la extracción de texto de archivos PDF en Azure Blob Storage. |
|
| queryTimeout |
string |
00:05:00 |
Aumenta el tiempo de espera más allá del valor predeterminado de 5 minutos para los orígenes de datos de Azure SQL Database, especificados en el formato "hh:mm:ss". |
IndexingSchedule
Representa una programación para la ejecución del indexador.
| Nombre | Tipo | Description |
|---|---|---|
| interval |
string (duration) |
Intervalo de tiempo entre ejecuciones del indexador. |
| startTime |
string (date-time) |
Hora en la que un indexador debe comenzar a ejecutarse. |
Prefer
Para las solicitudes HTTP PUT, indica al servicio que devuelva el recurso creado/actualizado en caso de éxito.
| Valor | Description |
|---|---|
| return=representation |
SearchIndexer
Representa un indexador.
| Nombre | Tipo | Valor predeterminado | Description |
|---|---|---|---|
| @odata.etag |
string |
ETag del indexador. |
|
| dataSourceName |
string |
Nombre del origen de datos del que este indexador lee los datos. |
|
| description |
string |
Descripción del indexador. |
|
| disabled |
boolean |
False |
Valor que indica si el indexador está deshabilitado. El valor predeterminado es falso. |
| encryptionKey |
Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para la definición del indexador (así como el estado de ejecución del indexador) cuando desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrarlos. Una vez que haya cifrado la definición del indexador, siempre permanecerá cifrada. El servicio de búsqueda omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; La definición del indexador (y el estado de ejecución del indexador) no se verán afectadas. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios pagos creados a partir del 1 de enero de 2019. |
||
| fieldMappings |
Define las asignaciones entre campos del origen de datos y los campos de destino correspondientes del índice. |
||
| name |
string |
Nombre del indizador. |
|
| outputFieldMappings |
Las asignaciones de campos de salida se aplican después del enriquecimiento e inmediatamente antes de la indexación. |
||
| parameters |
Parámetros para la ejecución del indexador. |
||
| schedule |
Programación de este indexador. |
||
| skillsetName |
string |
Nombre del conjunto de aptitudes que se ejecuta con este indexador. |
|
| targetIndexName |
string |
Nombre del índice en el que este indexador escribe datos. |
SearchIndexerDataNoneIdentity
Borra la propiedad de identidad de un origen de datos.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de identidad. |
SearchIndexerDataUserAssignedIdentity
Especifica la identidad de un origen de datos que se va a usar.
| Nombre | Tipo | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragmento de URI que especifica el tipo de identidad. |
| userAssignedIdentity |
string |
El identificador de recurso de Azure completo de una identidad administrada asignada por el usuario normalmente con el formato "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" que se debe haber asignado al servicio de búsqueda. |
SearchResourceEncryptionKey
Una clave de cifrado administrada por el cliente en Azure Key Vault. Las claves que crea y administra se pueden usar para cifrar o descifrar datos en reposo, como índices y mapas de sinónimos.
| Nombre | Tipo | Description |
|---|---|---|
| accessCredentials.applicationId |
string |
Un identificador de aplicación de AAD al que se concedieron los permisos de acceso necesarios a Azure Key Vault que se va a usar al cifrar los datos en reposo. El identificador de aplicación no debe confundirse con el id. de objeto de la aplicación de AAD. |
| accessCredentials.applicationSecret |
string |
Clave de autenticación de la aplicación de AAD especificada. |
| identity | SearchIndexerDataIdentity: |
Una identidad administrada explícita que se va a usar para esta clave de cifrado. Si no se especifica y la propiedad de credenciales de acceso es null, se usa la identidad administrada asignada por el sistema. Al actualizar al recurso, si la identidad explícita no está especificada, permanece sin cambios. Si se especifica "none", se borra el valor de esta propiedad. |
| keyVaultKeyName |
string |
Nombre de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. |
| keyVaultKeyVersion |
string |
Versión de la clave de Azure Key Vault que se usará para cifrar los datos en reposo. |
| keyVaultUri |
string |
El URI de Azure Key Vault, también denominado nombre DNS, que contiene la clave que se va a usar para cifrar los datos en reposo. Un URI de ejemplo podría ser |