Modèles courants du KIT de développement logiciel (SDK) des connecteurs Microsoft Graph
Cet article décrit les modèles courants utilisés dans le Kit de développement logiciel (SDK) des connecteurs Microsoft Graph.
CustomConfiguration
La Administration de recherche fournit les informations de configuration personnalisée spécifiques au connecteur lors de la création de la connexion. La plateforme ne gère pas la structure et le format de la configuration. Les développeurs de connecteurs peuvent utiliser le format de leur choix.
| Propriété | Type | Description |
|---|---|---|
| configuration | chaîne | Contient les informations de configuration sous forme de chaîne. Le connecteur doit avoir la capacité d’interpréter le contenu de la chaîne. |
AuthenticationType, membres de l’énumération
Le tableau suivant répertorie les membres de l’énumération AuthenticationType .
| Membre | Valeur | Description |
|---|---|---|
| Anonyme | 0 | Aucune authentification n’est requise pour accéder à la source de données. |
| Basic | 1 | Authentification de base sous la forme d’un nom d’utilisateur et d’un mot de passe pour accéder à la source de données. |
| Windows | 2 | L’authentification basée sur Windows Active Directory prend en charge le nom d’utilisateur, le mot de passe et les informations de domaine. |
| oAuth2ClientCredential | 3 | Authentification basée sur OAuth2 avec les informations d’identification du client. Il prend en charge l’ID d’application et le secret d’application. |
AuthenticationData
Contient les informations d’identification fournies par l’administrateur pour accéder à la source de données, notamment le type d’authentification, l’URL de la source de données et les données d’informations d’identification.
| Propriété | Type | Description |
|---|---|---|
| authType | Élément AuthenticationType | Type d’informations d’authentification contenues dans cet objet. |
| DatasourceUrl | string | URL ou chemin d’accès à la source de données : chemin d’accès à la ressource qui doit être analysée. Exemple : chaîne de connexion pour une base de données. |
| basicCredential | BasicCredential | Informations d’identification sous forme de nom d’utilisateur et de mot de passe pour accéder à la source de données. Cette propriété est définie exclusivement sur windowsCredential, et authType est défini sur Basic quand cette propriété est définie. |
| windowsCredential | WindowsCredential | Informations d’identification sous la forme d’un nom d’utilisateur, d’un mot de passe et d’un domaine Windows AD pour accéder à la source de données. Cette propriété est définie exclusivement sur basicCredential, et authType est défini sur Windows lorsque cette propriété est définie. |
| oAuth2ClientCredential | oAuth2ClientCredential | Informations d’identification sous forme d’ID d’application et de secret d’application pour l’authentification basée sur les informations d’identification du client OAuth pour accéder à la source de données. Cette propriété est définie exclusivement sur oAuth2ClientCredential et authType est défini sur oAuth2ClientCredential lorsque cette propriété est définie. |
BasicCredential
Représente le modèle d’informations d’identification de base.
| Propriété | Type | Description |
|---|---|---|
| username | string | Nom d’utilisateur pour accéder à la source de données. |
| secret | chaîne | Secret à utiliser avec le nom d’utilisateur pour accéder à la source de données. |
WindowsCredential
Représente le modèle d’informations d’identification Windows.
| Propriété | Type | Description |
|---|---|---|
| username | chaîne | Nom d’utilisateur pour accéder à la source de données. |
| secret | string | Secret à utiliser avec le nom d’utilisateur pour accéder à la source de données. |
| domaine | chaîne | Domaine Active Directory du compte. Si elle n’est pas fournie explicitement par l’administrateur, cette propriété contient la valeur du nom de l’ordinateur. |
oAuth2ClientCredential
Représente le modèle d’informations d’identification pour les informations d’identification du client OAuth2.
| Propriété | Type | Description |
|---|---|---|
| appId | string | ID d’application/ID client pour l’application OAuth2. |
| appSecret | Chaîne | Secret d’application/clé secrète client pour l’application OAuth2. |
| oAuth2ClientCredentialResponse | oAuth2ClientCredentialResponse | Contient les détails liés au jeton OAuth. Cette propriété est définie sur la réponse que le connecteur envoie après la réussite du premier appel d’authentification de validation. |
oAuth2ClientCredentialResponse
Représente le modèle de réponse du serveur d’authentification pour la demande de jeton OAuth2. Les champs présents dans ce modèle sont les champs de réponse courants spécifiés dans la documentation OAuth2. En outre, idToken peut être défini lorsque les serveurs d’authentification prennent en charge OpenIDConnect.
| Propriété | Type | Description |
|---|---|---|
| accessToken | chaîne | Jeton d’accès du serveur d’authentification. |
| refreshToken | string | Jeton d’actualisation si le serveur d’authentification l’envoie. |
| tokenType | chaîne | Type du jeton ( généralement jeton du porteur pour OAuth). |
| expiresIn | uint64 | Heure d’expiration du jeton dans l’horodatage Unix. |
| étendue | string | Étendues prises en charge par le jeton si le serveur d’authentification l’envoie. |
| idToken | chaîne | Jeton d’ID si le serveur d’authentification prend en charge open ID connect. |
OperationResult
L’énumération OperationResult contient les valeurs possibles pour les résultats de l’opération.
| Membre | Valeur | Description |
|---|---|---|
| Opération réussie | 0 | L’opération a réussi sans erreur. |
| PartialSuccess | 1 | L’opération est réussie, mais un message d’avertissement doit être traité. |
| ValidationFailure | 2 | Une ou plusieurs validations ont échoué. |
| AuthenticationIssue | 3 | Les informations d’identification fournies n’ont pas fonctionné. |
| DatasourceError | 4 | Erreur de lecture de la source de données. |
| NetworkError | 5 | Erreur d’opération réseau. |
| Annulé | 6 | Le jeton d’annulation a annulé l’opération. |
| TokenExpired | 7 | À utiliser dans le flux OAuth lorsque le jeton envoyé au connecteur par la plateforme a expiré. Pendant l’analyse, à la réception de cette status, la plateforme déclenche le flux de jetons d’actualisation et appelle la méthode RefreshAccessToken dans ConnectorOAuthService. |
| SkipItem | 8 | À utiliser dans le flux d’analyse lorsque l’élément doit être ignoré. |
OperationStatus
Représente la status d’une opération, y compris les erreurs/avertissements et les détails des nouvelles tentatives. Ce modèle fait partie de la réponse de toutes les API dans ConnectionManagementService et ConnectorCrawlerService.
| Propriété | Type | Description |
|---|---|---|
| result | OperationResult | Résultat de l’opération. |
| statusMessage | chaîne | Message personnalisé qui peut être utilisé à des fins de journalisation et de surveillance. |
| retryInfo | RetryDetails | Informations sur les nouvelles tentatives que l’infrastructure doit utiliser pour réessayer la même opération pour une opération ayant échoué. Si l’opération réussit ou réussit partiellement, elle est ignorée. |
Membres de l’énumération RetryType
Cette énumération est utilisée pour définir la stratégie de nouvelle tentative en cas d’erreurs.
| Membre | Valeur | Description |
|---|---|---|
| NoRetry | 0 | Aucune nouvelle tentative ne doit être effectuée. |
| Standard | 1 | Une nouvelle tentative standard avec un temps d’attente linéaire sera effectuée. |
| ExponentialBackOff | 2 | Une nouvelle tentative par interruption exponentielle est effectuée. |
RetryDetails
Ce modèle est utilisé pour communiquer la stratégie de nouvelle tentative où une nouvelle tentative est requise.
| Propriété | Type | Description |
|---|---|---|
| type | RetryType | Le type de nouvelle tentative définit le type de stratégie de nouvelle tentative requis pour l’erreur. |
| numberOfRetries | uint32 | Nombre de nouvelles tentatives à effectuer pour l’exception. |
| pauseBetweenRetriesInMilliseconds | uint64 | Obtient une pause entre les nouvelles tentatives en cas de nouvelles tentatives standard. |
| backoffCoefficient | float | Obtient le coefficient utilisé dans le calcul de l’interruption exponentielle. |
| backoffRate | float | Obtient le backoffRate utilisé dans le calcul de l’interruption exponentielle. |
DataSourceSchema
Représente le schéma des propriétés qui représentent une entité de données dans la source de données. Pour plus d’informations, consultez Type de ressource de schéma.
| Propriété | Type | Description |
|---|---|---|
| PropertyList | sourcePropertyDefinition répétée | Représente la liste des propriétés qui définissent un élément dans la source de données. |
Membres de l’énumération SourcePropertyType
| Membre | Valeur | Description |
|---|---|---|
| Chaîne | 0 | Propriété de type string. |
| Int64 | 1 | Propriété de type int64 (long). |
| Double | 2 | Propriété de type double. |
| DateTime | 3 | Propriété de type DateTime. |
| Valeur booléenne | 4 | Propriété de type Boolean. |
| StringCollection | 5 | Propriété de type tableau ou collection de type chaîne. |
| Int64Collection | 6 | Propriété du type de tableau ou de collection de type long. |
| DoubleCollection | 7 | Propriété de type de tableau ou collection de type double. |
| DateTimeCollection | 8 | Propriété du type de tableau ou de collection de type DateTime. |
Membres de l’énumération SearchAnnotations
| Membre | Valeur | Description |
|---|---|---|
| Aucun | 0 | Aucun |
| IsSearchable | 1 | Si une propriété peut faire l’objet d’une recherche, sa valeur est ajoutée à l’index de recherche en texte intégral. Lorsqu’un utilisateur effectue une recherche, les résultats sont retournés s’il y a un accès de recherche dans l’un des champs pouvant faire l’objet d’une recherche ou dans son contenu. Par exemple, si la propriété est « Author », la recherche « Smith » renvoie les éléments dont la propriété Author contient « Smith ». |
| IsQueryable | 2 | Si une propriété est interrogeable, vous pouvez l’interroger à l’aide du langage KQL (Knowledge Query Language). KQL se compose d’un ou de plusieurs mots clés de texte libre (mots ou expressions) ou de restrictions de propriété. Le nom de la propriété doit être inclus dans la requête, c'est-à-dire soit être précisé dans la requête même, soit être intégré par programme dans la requête. Vous pouvez utiliser la correspondance des préfixes avec l’opérateur générique (*). Par exemple, si la propriété est « Author », la requête de recherche peut être « Author : Smith » |
| IsRetrievable | 4 | Si une propriété est récupérable, elle peut retourner sa valeur dans les résultats de la recherche. Toute propriété que vous souhaitez ajouter au modèle d’affichage ou retourner à partir de la requête et être pertinente dans les résultats de recherche doit être récupérable. Le fait de marquer des propriétés importantes ou trop nombreuses comme récupérables augmente la latence de recherche. Soyez sélectif et choisissez les propriétés appropriées. |
| IsContent | 8 | La propriété content consiste à identifier une propriété qui peut être indexée en texte intégral. Les administrateurs choisissent parmi les propriétés disponibles, celle qui doit être la propriété à traiter comme contenu pour cette connexion spécifique. Pour plus d’informations, consultez Propriété content. |
| IsRefinable | 16 | Si une propriété peut être redéfinie, un administrateur peut la configurer en tant que filtre personnalisé dans la page des résultats de recherche Microsoft. Une propriété refinable ne peut pas faire l’objet d’une recherche. |
Remarque
Si une connexion a les étiquettes sémantiques Title et URL , et qu’une propriété de schéma dans la connexion est marquée comme IsContent, le contenu de l’élément est vectorisé dans l’index sémantique.
SearchPropertyLabel
Les étiquettes de propriétés de recherche sont des étiquettes bien connues publiées par Microsoft que vous pouvez ajouter à une propriété dans votre schéma. L’ajout d’une étiquette sémantique permet à différents produits Microsoft de comprendre la propriété et de fournir une meilleure expérience. Pour plus d’informations, consultez Étiquettes sémantiques.
Membres de l’énumération SearchPropertyLabel
| Membre | Valeur | Description |
|---|---|---|
| Titre | 0 | Titre de l’élément que vous souhaitez afficher dans la recherche et d’autres expériences. |
| Url | 1 | L’URL cible de l’élément dans la source de données. |
| CreatedBy | 2 | Nom de la personne qui a créé l’élément dans la source de données. |
| LastModifiedBy | 3 | Nom de la personne qui a récemment modifié l’élément dans la source de données. |
| des auteurs | 4 | Nom de toutes les personnes qui ont participé/collaboré à l’élément de la source de données. |
| CreatedDateTime | 5 | Date et heure de création de l’élément dans la source de données. |
| LastModifiedDateTime | 6 | Date et heure de la dernière modification de l’élément dans la source de données. |
| FileName | 7 | Dans le cas d’un fichier, le nom du fichier se trouve dans la source de données. |
| FileExtension | 8 | Dans le cas d’un fichier, l’extension du fichier se trouve dans la source de données. |
| LastModifiedByUpn | 9 | UPN de la personne qui a récemment modifié l’élément dans la source de données. |
| CreatedByUpn | 10 | UPN de la personne qui a créé l’élément dans la source de données. |
| AuthorsUpn | 11 | UPN de toutes les personnes qui ont participé ou collaboré sur l’élément dans la source de données. |
| UnknownFutureValue | 12 | Pour une mise à l’épreuve du temps, suivez les énumérations évolutives de Microsoft Graph. Ajoutez toutes les nouvelles énumérations sous celle-ci jusqu’à ce que la version principale de l’API change. |
| ContainerName | 13 | Nom du conteneur. |
| ContainerUrl | 14 | L’URL du conteneur. |
| IconUrl | 15 | L’URL d’une icône. |
SourcePropertyDefinition
Définit une propriété source unique pour un élément dans la source de données. Pour plus d’informations sur les définitions de propriétés de schéma, consultez Type de ressource de propriété.
| Propriété | Type | Description |
|---|---|---|
| name | string | Nom de la propriété. |
| type | SourcePropertyType | Type de données de la propriété. |
| defaultSearchAnnotations | uint32 | Annotations de recherche par défaut pour la propriété . |
| requiredSearchAnnotations | uint32 | Annotations de recherche requises. Certaines propriétés comme ID sont toujours définies sur isQueryabletrue et isRetrievabletrue. |
| defaultSemanticLabels | répété SearchPropertyLabel | Liste des étiquettes sémantiques pour la propriété source. |
| commande | int32 | Ordre de cette propriété source. Utilisé par l’interface utilisateur pour trier les résultats de la recherche. Optional. |
| étiquette | chaîne | Étiquette de cette propriété source. Utilisé par l’interface utilisateur des résultats de recherche pour afficher l’étiquette (nom lisible par l’utilisateur). Optional. |
| Alias | chaîne répétée | Liste des alias de cette propriété source. Optional. |