Modelos y API de rastreo de conectores de contratos del SDK de conectores de Microsoft Graph
Los modelos y la API de rastreo del conector de contratos del SDK de Microsoft Graph se llaman durante un rastreo.
API del rastreador de conectores
| Método | Parameters | Tipo de valor devuelto | Descripción |
|---|---|---|---|
| GetCrawlStream | GetCrawlStreamRequest | CrawlStreamBit como una secuencia | Lee los datos del origen de datos. Se llamará a este método durante los rastreos completos completos y periódicos, donde todos los elementos deben leerse desde el origen de datos y devolverse a la plataforma. |
| GetIncrementalCrawlStream | GetIncrementalCrawlStreamRequest | IncrementalCrawlStreamBit como una secuencia | Lee los datos del origen de datos. Este método es opcional y se llamará durante los rastreos incrementales y solo devolverá los cambios incrementales en los elementos desde el último rastreo incremental. |
Modelos de rastreador de conectores
A continuación se muestran los modelos de rastreador del conector.
GetCrawlStreamRequest
Modelo de solicitud para obtener elementos durante el rastreo.
| Propiedad | Tipo | Descripción |
|---|---|---|
| customConfiguration | CustomConfiguration | Proporciona datos de configuración para el conector. |
| authenticationData | AuthenticationData | Contiene la dirección URL de acceso al origen de datos y las credenciales para acceder a ella. |
| crawlProgressMarker | CrawlCheckpoint | Contiene datos para identificar los elementos que se procesaron en el último rastreo. El conector devuelve la información del elemento y la usa si la plataforma se bloquea durante el rastreo. |
| Esquema | DataSourceSchema | Muestra el esquema de la conexión. Esta propiedad también se puede usar para establecer el valor. |
CrawlStreamBit
Modelo de respuesta que contiene el estado del elemento que indica el éxito o error y el indicador o punto de comprobación del elemento que se rastrea durante el rastreo completo o periódico.
| Propiedad | Tipo | Descripción |
|---|---|---|
| status | OperationStatus | Muestra el estado de la operación y los detalles del error. |
| crawlItem | CrawlItem | Muestra un único elemento rastreado desde el origen de datos. |
| crawlProgressMarker | CrawlCheckpoint | Identifica el elemento rastreado desde el origen de datos. |
GetIncrementalCrawlStreamRequest
Modelo de solicitud para obtener elementos durante un rastreo incremental.
| Propiedad | Tipo | Descripción |
|---|---|---|
| customConfiguration | CustomConfiguration | Proporciona datos de configuración para el conector. |
| authenticationData | AuthenticationData | Contiene la dirección URL de acceso al origen de datos y las credenciales para acceder a ella. |
| crawlProgressMarker | CrawlCheckpoint | Contiene datos para identificar los elementos que se procesaron en el último rastreo. El conector devuelve la información del elemento y la usa si la plataforma se bloquea durante el rastreo. |
| Esquema | DataSourceSchema | Muestra el esquema de la conexión. Esta propiedad también se puede usar para establecer el valor. |
| previousCrawlStartTimeInUtc | Timestamp | Muestra la hora de inicio del rastreo anterior en UTC. Este valor se puede usar en el primer rastreo incremental, pero las llamadas posteriores deben usar el valor de punto de comprobación. |
IncrementalCrawlStreamBit
Modelo de respuesta que contiene el elemento, estado que indica si se ha realizado correctamente o no y el indicador o punto de comprobación del elemento que se rastrea durante el rastreo incremental.
| Propiedad | Tipo | Descripción |
|---|---|---|
| status | OperationStatus | Muestra el estado de la operación y los detalles del error. |
| crawlItem | IncrementalCrawlItem | Muestra un único elemento rastreado desde el origen de datos durante y el rastreo incremental. |
| crawlProgressMarker | CrawlCheckpoint | Identifica el último elemento rastreado desde el origen de datos durante el último rastreo incremental. |
Miembros de enumeración ItemType para CrawlItem
Campos de enumeración para elementos de rastreo.
| Miembro | Valor | Descripción |
|---|---|---|
| ContentItem | 0 | Elementos de datos con contenido que se va a ingerir. Por ejemplo: contenido del sitio web. |
| LinkItem | 1 | Vínculo a un elemento de contenido que se usará en rastreos posteriores. Por ejemplo: vínculos a un sitio web o una carpeta. |
CrawlItem
Representa una entidad en el origen de datos. El tamaño máximo permitido es de 4 MB. Por ejemplo: un archivo, una carpeta o un registro de una tabla.
| Propiedad | Tipo | Descripción |
|---|---|---|
| Itemid | string | Muestra el identificador único que representa el elemento en el origen de datos. |
| contentItem | ContentItem | Muestra un elemento de datos con contenido que se va a ingerir. Por ejemplo: el contenido de un sitio web. |
| linkItem | LinkItem | Vínculo a un elemento de contenido que se usará en rastreos posteriores. Por ejemplo: un vínculo a un sitio web o una carpeta. |
| itemType | ItemType | Muestra el tipo de elemento que se va a enviar. Este modelo debe tener un contentItem o un linkItem establecido y este campo de enumeración debe corresponder a ese elemento. |
Nota:
- Las propiedades linkItem y contentItem son mutuamente excluyentes.
Miembros de enumeración ItemType para IncrementalCrawlItem
Campos de enumeración para elementos de rastreo incremental.
| Miembro | Valor | Descripción |
|---|---|---|
| ContentItem | 0 | Elementos de datos con contenido que se va a ingerir. Por ejemplo: el contenido de un sitio web. |
| LinkItem | 1 | Vínculo a un elemento de contenido que se usará en rastreos posteriores. Por ejemplo: un vínculo a un sitio web o una carpeta. |
| DeletedItem | 2 | Elemento que se eliminó del origen de datos y que debe eliminarse del índice. |
IncrementalCrawlItem
Representa una entidad en el origen de datos. Por ejemplo: un archivo, una carpeta o un registro de una tabla.
| Propiedad | Tipo | Descripción |
|---|---|---|
| Itemid | string | Muestra el identificador único que representa el elemento en el origen de datos. |
| contentItem | ContentItem | Muestra un elemento de datos con contenido que se va a ingerir. Por ejemplo: el contenido de un sitio web. |
| linkItem | LinkItem | Vínculo a un elemento de contenido que se usará en rastreos posteriores. Por ejemplo: un vínculo a un sitio web o una carpeta. |
| deletedItem | DeletedItem | Elemento que se elimina del origen de datos y se debe quitar del índice. Si deletedItem está establecido, no se puede establecer contentItem o linkItem . |
| itemType | ItemType | Muestra el tipo de elemento que se va a enviar. Este modelo debe tener un contentItem o un linkItem establecido y este campo de enumeración debe corresponder a ese elemento. |
Nota:
- Las propiedades linkItem, contentItem y deletedItem son mutuamente excluyentes.
ContentItem
Elemento que contiene el contenido de la entidad de origen de datos que se va a ingerir. Por ejemplo: el contenido de un sitio web.
| Propiedad | Tipo | Descripción |
|---|---|---|
| propertyValues | SourcePropertyValueMap | Contiene la clave y los valores de cada propiedad del elemento. |
| accessList | AccessControlList | Restringe el acceso al elemento a usuarios o grupos específicos. |
| contenido | Contenido | Muestra la propiedad de contenido del elemento que se puede usar al mostrar los resultados de la búsqueda. |
LinkItem
Elemento que actúa como vínculo a otro elemento. Estos elementos de vínculo se enviarán de nuevo al conector para volver a rastrear; por ejemplo, en un contenido de carpeta, los archivos serán elementos de contenido y las subcarpetas serán elementos de vínculo.
| Propiedad | Tipo | Descripción |
|---|---|---|
| Metadatos | map<string, GenericType> | Contiene los metadatos necesarios para que el conector vuelva a rastrear el elemento. |
DeletedItem
Representa un elemento que se eliminó del origen de datos y tiene que quitarse del índice.
AccessControlList
Restringe los usuarios que pueden ver los resultados de la búsqueda.
| Propiedad | Tipo | Descripción |
|---|---|---|
| Entries | AccessControlEntry repetido | Muestra la matriz o colección de entradas de lista de control de acceso. |
Miembros de enumeración AclAccessType
Miembros de enumeración del tipo de lista de control de acceso.
| Miembro | Valor | Descripción |
|---|---|---|
| Ninguno | 0 | Indica el valor predeterminado: deny. |
| Conceder | 1 | La entrada es para usuarios o grupos con acceso al elemento. |
| Denegar | 2 | La entrada es para usuarios o grupos sin acceso al elemento y invalida la concesión para cualquier usuario o grupo. |
AccessControlEntry
Contiene entradas de control de acceso individuales.
| Propiedad | Tipo | Descripción |
|---|---|---|
| accessType | AclAccessType | Muestra el tipo de acceso de la entidad de concesión o denegación. |
| entidad de seguridad | Principal | Representa un grupo o usuario con acceso definido. |
Miembros de enumeración PrincipalType
Miembros de enumeración del tipo de entidad de seguridad.
| Miembro | Valor | Descripción |
|---|---|---|
| PT_None | 0 | Indica el valor predeterminado: user. |
| Usuario | 1 | Tipo de usuario. |
| Group | 2 | Tipo de grupo. |
| Todos | 3 | Grupo especial para conceder acceso a todos. |
| TodosExceptGuests | 4 | Grupo especial para conceder acceso a todos excepto a los invitados. |
Miembros de la enumeración IdentitySource
Miembros de enumeración del origen de identidad.
| Miembro | Valor | Descripción |
|---|---|---|
| IS_None | 0 | Indica el valor predeterminado: Microsoft Entra ID. |
| AzureActiveDirectory | 1 | El origen de identidad es Microsoft Entra ID. |
Miembros de enumeración IdentityType
Miembros de enumeración del tipo de identidad.
| Miembro | Valor | Descripción |
|---|---|---|
| IT_None | 0 | Indica el valor predeterminado: (Azure ADId). |
| ActiveDirectorySId | 1 | SID (identificador de seguridad local) proporcionado por Active Directory (AD). |
| UserPrincipalName | 2 | Nombre principal de usuario (UPN). |
| AadId | 3 | Azure ADId. |
Director
Estructura para almacenar atributos de la entidad de seguridad (usuario o grupo).
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | PrincipalType | Tipo de entidad de seguridad. |
| valor | string | Valor de entidad de seguridad: el valor del SID, UPN, Azure ADId, etc. |
| identitySource | IdentitySource | Origen de identidad. |
| identityType | IdentityType | Tipo de representación de identidad. |
| identitySourceProperties | cadena de mapa<, cadena> | Metadatos sobre el origen de identidad. |
SourcePropertyValueMap
Asignación de la clave de propiedad de origen y su valor en el origen de datos. Almacena el valor de propiedad de cada elemento.
| Propiedad | Tipo | Descripción |
|---|---|---|
| values | map<string, GenericType> | Contiene la clave y los valores de las propiedades del elemento. La clave es el nombre de la propiedad y el valor es el valor de la propiedad. Por ejemplo, el contenido del archivo tiene propiedades como title, modifiedDate, etc. Las claves de propiedades serán las propias propiedades y sus valores serán el título del archivo y la fecha de modificación del archivo respectivamente. |
Miembros de enumeración ContentType
Miembros de enumeración del tipo de contenido.
| Miembro | Valor | Descripción |
|---|---|---|
| Ninguno | 0 | Valor predeterminado. |
| Texto | 1 | Tipo de contenido de texto. |
| HTML | 2 | Tipo de contenido HTML. |
Contenido
Valor de la propiedad de contenido del elemento, que se usa para representar los resultados de la búsqueda.
| Propiedad | Tipo | Descripción |
|---|---|---|
| contentType | ContentType | Tipo del contenido. |
| contentValue | string | Valor de la propiedad de contenido. |
CrawlCheckpoint
Identifica el elemento que se rastreó por última vez. La plataforma lo guardará y el punto de control del último lote de elementos correcto se usará para reanudar el rastreo si se produce un error o un bloqueo. La plataforma enviará el punto de comprobación en la API GetCrawlStream .
| Propiedad | Tipo | Descripción |
|---|---|---|
| pagenumber | uint32 | Muestra el número de página para marcar el progreso del rastreo. |
| batchSize | uint32 | Contiene el número de elementos devueltos en cada lote. Tiene un valor constante de 1 porque cada elemento se transmite individualmente. |
| customMarkerData | string | Datos personalizados necesarios para identificar el último elemento rastreado desde el origen de datos. |
GenericType
Modelo para contener los tipos de valores admitidos por la plataforma en determinados campos, como los valores de propiedad de origen. Solo se debe establecer uno de los campos siguientes.
| Propiedad | Tipo | Descripción |
|---|---|---|
| stringValue | string | Representa un valor de cadena. |
| intValue | int64 | Representa un valor int64 (long). |
| doubleValue | double | Representa un valor doble. |
| dateTimeValue | google.protobuf.Timestamp | Representa un valor dateTime. |
| boolValue | bool | Representa un valor Boolean. |
| stingCollectionValue | StringCollectionType | Representa una colección de cadenas. |
| intCollectionValue | IntCollectionType | Representa una colección de int64 (long). |
| doubleCollectionValue | DoubleCollectionType | Representa una colección de double. |
| dateTimeCollectionValue | TimestampCollectionType | Representa una colección de dateTime. |
StringCollectionType
Colección de cadenas.
| Propiedad | Tipo | Descripción |
|---|---|---|
| values | cadena repetida | Colección o matriz de cadenas. |
IntCollectionType
Colección de valores enteros.
| Propiedad | Tipo | Descripción |
|---|---|---|
| values | repetido int64 | Colección o matriz de valores int64 (long). |
DoubleCollectionType
Colección de valores dobles.
| Propiedad | Tipo | Descripción |
|---|---|---|
| values | doble repetido | Colección o matriz de valores dobles. |
TimestampCollectionType
Colección de valores DateTime .
| Propiedad | Tipo | Descripción |
|---|---|---|
| values | repetido google.protobuf.Timestamp | Colección o matriz de valores dateTime . |