Modelos comunes del SDK de conectores de Microsoft Graph
En este artículo se describen los modelos comunes que se usan en el SDK de conectores de Microsoft Graph.
CustomConfiguration
La Administración de búsqueda proporciona la información de configuración personalizada específica del conector durante la creación de la conexión. La plataforma no administra la estructura y el formato de la configuración. Los desarrolladores de conectores pueden usar un formato de su elección.
| Propiedad | Tipo | Descripción |
|---|---|---|
| configuration | string | Contiene la información de configuración como una cadena. El conector debe tener la capacidad de interpretar el contenido de la cadena. |
Miembros de enumeración AuthenticationType
En la tabla siguiente se enumeran los miembros de la enumeración AuthenticationType .
| Miembro | Valor | Descripción |
|---|---|---|
| Anónimo | 0 | No se requiere autenticación para acceder al origen de datos. |
| Basic | 1 | Autenticación básica en forma de nombre de usuario y contraseña para acceder al origen de datos. |
| Windows | 2 | La autenticación basada en Windows Active Directory admite información de nombre de usuario, contraseña e dominio. |
| oAuth2ClientCredential | 3 | Autenticación basada en OAuth2 con credenciales de cliente. Admite el identificador de aplicación y el secreto de aplicación. |
AuthenticationData
Contiene las credenciales proporcionadas por el administrador para acceder al origen de datos, incluido el tipo de autenticación, la dirección URL del origen de datos y los datos de credenciales.
| Propiedad | Tipo | Descripción |
|---|---|---|
| authType | AuthenticationType | Tipo de información de autenticación contenida en este objeto. |
| DatasourceUrl | string | Dirección URL o ruta de acceso al origen de datos: ruta de acceso al recurso que se debe rastrear. Ejemplo: Cadena de conexión para una base de datos. |
| basicCredential | BasicCredential | Credenciales en forma de nombre de usuario y contraseña para acceder al origen de datos. Esta propiedad se establecerá exclusivamente en windowsCredential y authType se establecerá en Basic cuando se establezca esta propiedad. |
| windowsCredential | WindowsCredential | Credenciales en forma de nombre de usuario, contraseña y dominio de Windows AD para acceder al origen de datos. Esta propiedad se establecerá exclusivamente en basicCredential y authType se establecerá en Windows cuando se establezca esta propiedad. |
| oAuth2ClientCredential | oAuth2ClientCredential | Credenciales en forma de identificador de aplicación y secreto de aplicación para la autenticación basada en credenciales de cliente de OAuth para acceder al origen de datos. Esta propiedad se establecerá exclusivamente en oAuth2ClientCredential y authType se establecerá en oAuth2ClientCredential cuando se establezca esta propiedad. |
BasicCredential
Representa el modelo de credenciales básicas.
| Propiedad | Tipo | Descripción |
|---|---|---|
| usuario | string | Nombre de usuario para acceder al origen de datos. |
| secreto | string | Secreto que se usará con el nombre de usuario para acceder al origen de datos. |
WindowsCredential
Representa el modelo de credenciales de Windows.
| Propiedad | Tipo | Descripción |
|---|---|---|
| usuario | string | Nombre de usuario para acceder al origen de datos. |
| secreto | string | Secreto que se usará con el nombre de usuario para acceder al origen de datos. |
| domain | string | Dominio de Active Directory de la cuenta. Si el administrador no lo proporciona explícitamente, esta propiedad contiene el valor del nombre del equipo. |
oAuth2ClientCredential
Representa el modelo de credenciales para las credenciales de cliente de OAuth2.
| Propiedad | Tipo | Descripción |
|---|---|---|
| appId | string | Id. de aplicación o id. de cliente para la aplicación OAuth2. |
| appSecret | Cadena | Secreto de aplicación/secreto de cliente para la aplicación OAuth2. |
| oAuth2ClientCredentialResponse | oAuth2ClientCredentialResponse | Contiene detalles relacionados con el token de OAuth. Esta propiedad se establecerá en la respuesta que envía el conector después de que la primera llamada de autenticación de validación se realice correctamente. |
oAuth2ClientCredentialResponse
Representa el modelo de respuesta del servidor de autenticación para la solicitud de token de OAuth2. Los campos presentes en este modelo son los campos de respuesta comunes especificados en la documentación de OAuth2. Además, idToken se puede establecer cuando los servidores de autenticación admiten OpenIDConnect.
| Propiedad | Tipo | Descripción |
|---|---|---|
| accessToken | string | Token de acceso desde el servidor de autenticación. |
| refreshToken | string | Token de actualización si el servidor de autenticación lo envía. |
| tokenType | string | Tipo del token: normalmente token de portador para OAuth. |
| expiresIn | uint64 | Hora de expiración del token en la marca de tiempo de Unix. |
| ámbito | string | Ámbitos admitidos por el token si el servidor de autenticación lo envía. |
| idToken | string | El token de identificador si el servidor de autenticación admite la conexión de id. abierto. |
OperationResult
La enumeración OperationResult contiene los valores posibles para los resultados de la operación.
| Miembro | Valor | Descripción |
|---|---|---|
| Correcto | 0 | La operación se realizó correctamente sin ningún error. |
| PartialSuccess | 1 | La operación es correcta, pero hay un mensaje de advertencia que se va a procesar. |
| ValidationFailure | 2 | Error en una o varias validaciones. |
| AuthenticationIssue | 3 | Las credenciales proporcionadas no funcionaron. |
| DatasourceError | 4 | Error de lectura del origen de datos. |
| NetworkError | 5 | Error de operación de red. |
| Cancelado | 6 | El token de cancelación canceló la operación. |
| TokenExpired | 7 | Se usará en el flujo de OAuth cuando el token enviado al conector por la plataforma haya expirado. Durante el rastreo, al recibir este estado, la plataforma desencadenará el flujo del token de actualización y llamará al método RefreshAccessToken en ConnectorOAuthService. |
| SkipItem | 8 | Para usarse en el flujo de rastreo cuando se va a omitir el elemento. |
OperationStatus
Representa el estado de una operación, incluidos los errores o advertencias y los detalles de reintento. Este modelo forma parte de la respuesta de todas las API de ConnectionManagementService y ConnectorCrawlerService.
| Propiedad | Tipo | Descripción |
|---|---|---|
| result | OperationResult | Resultado de la operación. |
| statusMessage | string | Mensaje personalizado que se puede usar con fines de registro y supervisión. |
| retryInfo | RetryDetails | Información de reintento que usará el marco para volver a intentar la misma operación para una operación con errores. Si la operación se realiza correctamente o se realiza correctamente parcialmente, se omitirá. |
Miembros de enumeración RetryType
Esta enumeración se usa para definir la estrategia de reintento en caso de errores.
| Miembro | Valor | Descripción |
|---|---|---|
| NoRetry | 0 | No es necesario volver a intentarlo. |
| Estándar | 1 | Se realizará un reintento estándar con tiempo de espera lineal. |
| ExponentialBackOff | 2 | Se realizará un reintento por retroceso exponencial. |
RetryDetails
Este modelo se usa para comunicar la directiva de reintentos donde se requiere el reintento.
| Propiedad | Tipo | Descripción |
|---|---|---|
| type | RetryType | El tipo de reintento define el tipo de estrategia de reintento necesario para el error. |
| numberOfRetries | uint32 | Número de reintentos que se van a realizar para la excepción. |
| pauseBetweenRetriesInMilliseconds | uint64 | Obtiene una pausa entre reintentos en caso de reintentos estándar. |
| backoffCoefficient | float | Obtiene el coeficiente usado en el cálculo de retroceso exponencial. |
| backoffRate | float | Obtiene la backoffRate usada en el cálculo de retroceso exponencial. |
DataSourceSchema
Representa el esquema de las propiedades que representan una entidad de datos en el origen de datos. Para obtener más información, consulte tipo de recurso de esquema.
| Propiedad | Tipo | Descripción |
|---|---|---|
| PropertyList | sourcePropertyDefinition repetido | Representa la lista de propiedades que definen un elemento en el origen de datos. |
Miembros de enumeración SourcePropertyType
| Miembro | Valor | Descripción |
|---|---|---|
| Cadena | 0 | Propiedad de tipo string. |
| Int64 | 1 | Propiedad del tipo int64 (long). |
| Doble | 2 | Propiedad del tipo double. |
| DateTime | 3 | Propiedad del tipo DateTime. |
| Booleano | 4 | Propiedad de tipo Boolean. |
| StringCollection | 5 | Propiedad del tipo de matriz o colección de tipo de cadena. |
| Int64Collection | 6 | Propiedad del tipo de matriz o colección de tipo long. |
| DoubleCollection | 7 | Propiedad del tipo de matriz o colección de tipo doble. |
| DateTimeCollection | 8 | Propiedad del tipo de matriz o colección de tipo DateTime. |
Miembros de enumeración SearchAnnotations
| Miembro | Valor | Descripción |
|---|---|---|
| Ninguno | 0 | Ninguno |
| IsSearchable | 1 | Si se puede buscar en una propiedad, su valor se agrega al índice de texto completo. Cuando un usuario realiza una búsqueda, los resultados se devuelven si hay un acierto de búsqueda en uno de los campos que se pueden buscar o en su contenido. Por ejemplo, si la propiedad es "Author", la búsqueda de "Smith" devuelve elementos cuya propiedad Author contiene "Smith". |
| IsQueryable | 2 | Si se puede consultar una propiedad, puede consultarla con el Lenguaje de consulta de conocimiento (KQL). KQL consta de una o varias palabras clave de texto libre (palabras o frases) o restricciones de propiedad. El nombre de la propiedad debe incluirse en la consulta, sea especificado en la consulta misma o incluido en la consulta por programación. Puede usar la coincidencia de prefijos con el operador comodín(*). Por ejemplo, si la propiedad es "Author", la consulta de búsqueda puede ser "Author: Smith" |
| IsRetrievable | 4 | Si se puede recuperar una propiedad, puede devolver su valor en los resultados de la búsqueda. Cualquier propiedad que quiera agregar a la plantilla para mostrar o devolver de la consulta y ser relevante en los resultados de la búsqueda debe ser recuperable. Si se marcan propiedades grandes o demasiadas como recuperables, aumentará la latencia de búsqueda. Sea selectivo y elija propiedades relevantes. |
| IsContent | 8 | La propiedad content es para identificar una propiedad que se puede indizar con texto completo. Los administradores elegirán entre las propiedades disponibles, que deben ser la propiedad que se va a tratar como contenido para esa conexión específica. Para obtener más información, vea Content property (Propiedad de contenido). |
| IsRefinable | 16 | Si una propiedad es refinable, un administrador puede configurarla como un filtro personalizado en la página de resultados de Búsqueda de Microsoft. No se puede buscar en una propiedad refinable. |
Nota:
Si una conexión tiene las etiquetas semánticas Title y Url y cualquier propiedad de esquema de la conexión se marca como IsContent, el contenido del elemento se vectoriza en el índice semántico.
SearchPropertyLabel
Las etiquetas de propiedad de búsqueda son etiquetas conocidas publicadas por Microsoft que puede agregar en una propiedad del esquema. Agregar una etiqueta semántica ayuda a varios productos de Microsoft a comprender la propiedad y proporcionar una mejor experiencia. Para obtener más información, consulte Etiquetas semánticas.
Miembros de enumeración SearchPropertyLabel
| Miembro | Valor | Descripción |
|---|---|---|
| Título | 0 | Título del elemento que desea mostrar en la búsqueda y otras experiencias. |
| Url | 1 | Dirección URL de destino del elemento en el origen de datos. |
| CreatedBy | 2 | Nombre de la persona que creó el elemento en el origen de datos. |
| LastModifiedBy | 3 | Nombre de la persona que más recientemente editó el elemento en el origen de datos. |
| Autores | 4 | Nombre de todas las personas que participaron o colaboraron en el elemento en el origen de datos. |
| CreatedDateTime | 5 | Fecha y hora en que se creó el elemento en el origen de datos. |
| LastModifiedDateTime | 6 | Fecha y hora en que el elemento se modificó por última vez en el origen de datos. |
| FileName | 7 | En el caso de un archivo, el nombre del archivo se encuentra en el origen de datos. |
| FileExtension | 8 | En el caso de un archivo, la extensión del archivo se encuentra en el origen de datos. |
| LastModifiedByUpn | 9 | UPN de la persona que editó más recientemente el elemento en el origen de datos. |
| CreatedByUpn | 10 | UPN de la persona que creó el elemento en el origen de datos. |
| AuthorsUpn | 11 | UPN de todas las personas que participaron o colaboraron en el elemento en el origen de datos. |
| UnknownFutureValue | 12 | Para la corrección futura, siga las enumeraciones evolvables de Microsoft Graph. Agregue todas las nuevas enumeraciones debajo de esta hasta que cambie la versión de la API principal. |
| ContainerName | 13 | Nombre del contenedor. |
| ContainerUrl | 14 | Dirección URL del contenedor. |
| IconUrl | 15 | Dirección URL de un icono. |
SourcePropertyDefinition
Define una propiedad de origen única para un elemento del origen de datos. Para obtener más información sobre las definiciones de propiedades de esquema, consulte tipo de recurso de propiedad.
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre de la propiedad. |
| type | SourcePropertyType | Tipo de datos de la propiedad . |
| defaultSearchAnnotations | uint32 | Anotaciones de búsqueda predeterminadas para la propiedad . |
| requiredSearchAnnotations | uint32 | Anotaciones de búsqueda necesarias. Algunas propiedades como ID siempre se establecen en isQueryabletrue y isRetrievabletrue. |
| defaultSemanticLabels | SearchPropertyLabel repetida | Lista de etiquetas semánticas para la propiedad de origen. |
| orden | int32 | Orden de esta propiedad de origen. Usado por la interfaz de usuario para ordenar los resultados de la búsqueda. Opcional. |
| etiqueta | string | Etiqueta de esta propiedad de origen. Usado por la interfaz de usuario de resultados de búsqueda para mostrar la etiqueta (nombre legible por el usuario). Opcional. |
| Alias | cadena repetida | Lista de alias de esta propiedad de origen. Opcional. |