Gängige Modelle des Microsoft Graph Connectors SDK
In diesem Artikel werden die gängigen Modelle beschrieben, die im Microsoft Graph Connectors SDK verwendet werden.
CustomConfiguration
Search Admin stellt die connectorspezifischen benutzerdefinierten Konfigurationsinformationen während der Verbindungserstellung bereit. Die Plattform verwaltet nicht die Struktur und das Format der Konfiguration. Connectorentwickler können ein Format ihrer Wahl verwenden.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Konfiguration | string | Enthält die Konfigurationsinformationen als Zeichenfolge. Der Connector sollte über die Möglichkeit verfügen, den Inhalt der Zeichenfolge zu interpretieren. |
Member der AuthenticationType-Enumeration
In der folgenden Tabelle sind die Elemente der AuthenticationType-Enumeration aufgeführt.
| Element | Wert | Beschreibung |
|---|---|---|
| Anonym | 0 | Für den Zugriff auf die Datenquelle ist keine Authentifizierung erforderlich. |
| Standard | 1 | Standardauthentifizierung in Form von Benutzername und Kennwort für den Zugriff auf die Datenquelle. |
| Windows | 2 | Die Windows Active Directory-basierte Authentifizierung unterstützt Benutzernamen, Kennwort und Domäneninformationen. |
| oAuth2ClientCredential | 3 | OAuth2-basierte Authentifizierung mit Clientanmeldeinformationen. Es unterstützt die Anwendungs-ID und das Anwendungsgeheimnis. |
AuthenticationData
Enthält anmeldeinformationen, die vom Administrator für den Zugriff auf die Datenquelle bereitgestellt werden, einschließlich des Authentifizierungstyps, der Datenquellen-URL und der Anmeldeinformationen.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| authType | AuthenticationType | Typ der Authentifizierungsinformationen, die in diesem Objekt gespeichert sind. |
| DatasourceUrl | Zeichenfolge | URL oder Pfad für den Zugriff auf die Datenquelle: Pfad zu der Ressource, die durchforstet werden muss. Beispiel: Verbindungszeichenfolge für eine Datenbank. |
| basicCredential | BasicCredential | Anmeldeinformationen in Form von Benutzername und Kennwort für den Zugriff auf die Datenquelle. Diese Eigenschaft wird exklusiv auf windowsCredential und authType auf Basic festgelegt, wenn diese Eigenschaft festgelegt wird. |
| windowsCredential | WindowsCredential | Anmeldeinformationen in Form von Windows AD-Benutzername, Kennwort und Domäne für den Zugriff auf die Datenquelle. Diese Eigenschaft wird exklusiv auf basicCredential und authType auf Windows festgelegt, wenn diese Eigenschaft festgelegt wird. |
| oAuth2ClientCredential | oAuth2ClientCredential | Anmeldeinformationen in Form von App-ID und App-Geheimnis für die auf OAuth-Clientanmeldeinformationen basierende Authentifizierung für den Zugriff auf die Datenquelle. Diese Eigenschaft wird exklusiv auf oAuth2ClientCredential und authType auf oAuth2ClientCredential festgelegt, wenn diese Eigenschaft festgelegt wird. |
BasicCredential
Stellt das grundlegende Anmeldeinformationsmodell dar.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Benutzername | string | Benutzername für den Zugriff auf die Datenquelle. |
| geheim | Zeichenfolge | Geheimnis, das mit dem Benutzernamen für den Zugriff auf die Datenquelle verwendet werden soll. |
WindowsCredential
Stellt das Windows-Anmeldeinformationsmodell dar.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Benutzername | string | Benutzername für den Zugriff auf die Datenquelle. |
| geheim | Zeichenfolge | Geheimnis, das mit dem Benutzernamen für den Zugriff auf die Datenquelle verwendet werden soll. |
| domain | string | Active Directory-Domäne des Kontos. Wenn nicht explizit vom Administrator angegeben, enthält diese Eigenschaft den Wert des Computernamens. |
oAuth2ClientCredential
Stellt das Anmeldeinformationsmodell für OAuth2-Clientanmeldeinformationen dar.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| appId | string | Anwendungs-ID/Client-ID für die OAuth2-Anwendung. |
| appSecret | String | Anwendungsgeheimnis/geheimer Clientschlüssel für die OAuth2-Anwendung. |
| oAuth2ClientCredentialResponse | oAuth2ClientCredentialResponse | Enthält Details zu OAuth-Token. Diese Eigenschaft wird auf die Antwort festgelegt, die der Connector sendet, nachdem der erste Authentifizierungsaufruf erfolgreich war. |
oAuth2ClientCredentialResponse
Stellt das Antwortmodell vom Authentifizierungsserver für die OAuth2-Tokenanforderung dar. Die in diesem Modell vorhandenen Felder sind die allgemeinen Antwortfelder, die in der OAuth2-Dokumentation angegeben sind. Darüber hinaus kann idToken festgelegt werden, wenn die Authentifizierungsserver OpenIDConnect unterstützen.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| accessToken | Zeichenfolge | Das Zugriffstoken vom Authentifizierungsserver. |
| refreshToken | string | Das Aktualisierungstoken, wenn der Authentifizierungsserver es sendet. |
| tokenType | Zeichenfolge | Typ des Tokens – in der Regel Bearertoken für OAuth. |
| expiresIn | uint64 | Die Ablaufzeit des Tokens im Unix-Zeitstempel. |
| Bereich | Zeichenfolge | Bereiche, die vom Token unterstützt werden, wenn der Authentifizierungsserver es sendet. |
| idToken | Zeichenfolge | Das ID-Token, wenn der Authentifizierungsserver open ID connect unterstützt. |
OperationResult
Die OperationResult-Enumeration enthält die möglichen Werte für Vorgangsergebnisse.
| Element | Wert | Beschreibung |
|---|---|---|
| Erfolgreich | 0 | Der Vorgang war ohne Fehler erfolgreich. |
| PartialSuccess | 1 | Der Vorgang ist erfolgreich, aber es gibt eine Warnmeldung, die verarbeitet werden muss. |
| ValidationFailure | 2 | Mindestens eine Überprüfung ist fehlgeschlagen. |
| AuthenticationIssue | 3 | Die angegebenen Anmeldeinformationen funktionierten nicht. |
| DatasourceError | 4 | Fehler beim Lesen der Datenquelle. |
| NetworkError | 5 | Netzwerkvorgangsfehler. |
| Abgebrochen | 6 | Das Abbruchtoken hat den Vorgang abgebrochen. |
| TokenExpired | 7 | Zur Verwendung im OAuth-Fluss, wenn das von der Plattform an den Connector gesendete Token abgelaufen ist. Während der Durchforstung löst die Plattform beim Empfang dieses status den Aktualisierungstokenflow aus und ruft die RefreshAccessToken-Methode in ConnectorOAuthService auf. |
| SkipItem | 8 | Soll im Durchforstungsflow verwendet werden, wenn das Element übersprungen werden soll. |
OperationStatus
Stellt die status eines Vorgangs dar, einschließlich Fehler/Warnungen und Wiederholungsdetails. Dieses Modell ist Teil der Antwort aller APIs in ConnectionManagementService und ConnectorCrawlerService.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| result | OperationResult | Ergebnis des Vorgangs. |
| statusMessage | Zeichenfolge | Benutzerdefinierte Meldung, die für Protokollierungs- und Überwachungszwecke verwendet werden kann. |
| retryInfo | RetryDetails | Wiederholen Sie die Informationen, die vom Framework verwendet werden sollen, um denselben Vorgang für einen fehlgeschlagenen Vorgang erneut zu versuchen. Wenn der Vorgang erfolgreich oder teilweise erfolgreich ist, wird er ignoriert. |
Elemente der RetryType-Enumeration
Diese Enumeration wird verwendet, um die Strategie für den Wiederholungsversuch bei Fehlern zu definieren.
| Element | Wert | Beschreibung |
|---|---|---|
| NoRetry | 0 | Es muss kein Wiederholungsversuch durchgeführt werden. |
| Standard | 1 | Es wird ein Standardwiedenversuch mit linearer Wartezeit durchgeführt. |
| ExponentialBackOff | 2 | Ein Wiederholungsversuch durch exponentielles Backoff wird durchgeführt. |
RetryDetails
Dieses Modell wird für die Kommunikation der Wiederholungsrichtlinie verwendet, bei der ein Wiederholungsversuch erforderlich ist.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| type | RetryType | Der Wiederholungstyp definiert den Typ der Wiederholungsstrategie, die für den Fehler erforderlich ist. |
| numberOfRetries | uint32 | Anzahl der Wiederholungen, die für die Ausnahme ausgeführt werden sollen. |
| pauseBetweenRetriesInMilliseconds | uint64 | Ruft eine Pause zwischen Wiederholungsversuchen bei Standardversuchen ab. |
| backoffCoefficient | Gleitkommazahl | Ruft den bei der Berechnung des exponentiellen Backoffs verwendeten Koeffizient ab. |
| backoffRate | Gleitkommazahl | Ruft die backoffRate ab, die bei der Berechnung des exponentiellen Backoffs verwendet wird. |
DataSourceSchema
Stellt das Schema der Eigenschaften dar, die eine Datenentität in der Datenquelle darstellen. Weitere Informationen finden Sie unter Schemaressourcentyp.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| PropertyList | Wiederholte SourcePropertyDefinition | Stellt eine Liste der Eigenschaften dar, die ein Element in der Datenquelle definieren. |
Member der SourcePropertyType-Enumeration
| Element | Wert | Beschreibung |
|---|---|---|
| String | 0 | Eigenschaft vom Typ Zeichenfolge. |
| Int64 | 1 | Eigenschaft vom Typ int64 (long). |
| Gleitkommawert mit doppelter Genauigkeit | 2 | Eigenschaft vom Typ double. |
| DateTime | 3 | Eigenschaft vom Typ DateTime. |
| Boolesch | 4 | Eigenschaft vom Typ Boolean. |
| StringCollection | 5 | Eigenschaft des Arraytyps oder auflistung des Zeichenfolgentyps. |
| Int64Collection | 6 | Eigenschaft des Typs des Arrays oder der Auflistung des long-Typs. |
| DoubleCollection | 7 | Eigenschaft vom Typ des Arrays oder der Auflistung des Double-Typs. |
| DateTimeCollection | 8 | Eigenschaft des Arraytyps oder der Auflistung des DateTime-Typs. |
Member der SearchAnnotations-Enumeration
| Element | Wert | Beschreibung |
|---|---|---|
| Keine | 0 | None |
| IsSearchable | 1 | Wenn eine Eigenschaft durchsuchbar ist, wird ihr Wert dem Volltextindex hinzugefügt. Wenn ein Benutzer eine Suche durchführt, werden Ergebnisse zurückgegeben, wenn ein Suchtreffer in einem der durchsuchbaren Felder oder dessen Inhalt vorliegt. Wenn die Eigenschaft z. B. "Author" lautet, gibt die Suche nach "Smith" Elemente zurück, deren Author-Eigenschaft "Smith" enthält. |
| IsQueryable | 2 | Wenn eine Eigenschaft abgefragt werden kann, können Sie sie mithilfe von Knowledge Query Language (KQL) abfragen. KQL besteht aus einem oder mehreren freien Textschlüsselwörtern (Wörtern oder Ausdrücken) oder Eigenschafteneinschränkungen. Der Name der Eigenschaft muss in der Abfrage enthalten sein (entweder in der eigentlichen Abfrage angegeben oder programmseitig in die Abfrage eingefügt). Sie können den Präfix-Abgleich mit dem Platzhalterzeichen (*) verwenden. Wenn die Eigenschaft beispielsweise "Author" lautet, kann die Suchabfrage "Author: Smith" lauten. |
| IsRetrievable | 4 | Wenn eine Eigenschaft abgerufen werden kann, kann sie ihren Wert in den Suchergebnissen zurückgeben. Jede Eigenschaft, die Sie der Anzeigevorlage hinzufügen oder aus der Abfrage zurückgeben und in Suchergebnissen relevant sein möchten, muss abrufbar sein. Durch das Kennzeichnen umfangreicher oder zu vieler Eigenschaften als abrufbar wird die Suchlatenz erhöht. Gehen Sie selektiv vor, und wählen Sie relevante Eigenschaften aus. |
| IsContent | 8 | Die Inhaltseigenschaft dient zum Identifizieren einer Eigenschaft, die volltextindiziert werden kann. Administratoren wählen unter den verfügbaren Eigenschaften aus, welche die Eigenschaft sein soll, die als Inhalt für diese bestimmte Verbindung behandelt werden soll. Weitere Informationen finden Sie unter Content-Eigenschaft. |
| IsRefinable | 16 | Wenn eine Eigenschaft eingeschränkt werden kann, kann ein Administrator sie als benutzerdefinierten Filter auf der Microsoft Search-Ergebnisseite konfigurieren. Eine einschränkungsfähige Eigenschaft kann nicht durchsucht werden. |
Hinweis
Wenn eine Verbindung über die semantischen Bezeichnungen Title und URL verfügt und eine beliebige Schemaeigenschaft in der Verbindung als IsContent markiert ist, wird der Inhalt des Elements im semantischen Index vektorisiert.
SearchPropertyLabel
Sucheigenschaftenbezeichnungen sind bekannte Tags, die von Microsoft veröffentlicht werden und für eine Eigenschaft in Ihrem Schema hinzugefügt werden können. Wenn Sie eine semantische Bezeichnung hinzufügen, können verschiedene Microsoft-Produkte die Eigenschaft verstehen und eine bessere Benutzererfahrung bieten. Weitere Informationen finden Sie unter Semantische Bezeichnungen.
SearchPropertyLabel-Enumerationsmber
| Element | Wert | Beschreibung |
|---|---|---|
| Position | 0 | Der Titel des Elements, das Sie in der Suche und anderen Umgebungen anzeigen möchten. |
| Url | 1 | Die Ziel-URL des Elements in der Datenquelle |
| CreatedBy | 2 | Name der Person, die das Element in der Datenquelle erstellt hat. |
| LastModifiedBy | 3 | Name der Person, die das Element zuletzt in der Datenquelle bearbeitet hat. |
| blockieren | 4 | Die Namen aller Personen, die an dem Element in der Datenquelle beteiligt waren/zusammengearbeitet haben. |
| CreatedDateTime | 5 | Datum und Uhrzeit der Erstellung des Elements in der Datenquelle. |
| LastModifiedDateTime | 6 | Datum und Uhrzeit der letzten Änderung des Elements in der Datenquelle. |
| FileName | 7 | Im Fall einer Datei befindet sich der Name der Datei in der Datenquelle. |
| FileExtension | 8 | Im Fall einer Datei befindet sich die Erweiterung der Datei in der Datenquelle. |
| LastModifiedByUpn | 9 | UPN der Person, die das Element in der Datenquelle zuletzt bearbeitet hat. |
| CreatedByUpn | 10 | UPN der Person, die das Element in der Datenquelle erstellt hat. |
| AuthorsUpn | 11 | UPNs aller Personen, die an dem Element in der Datenquelle teilgenommen bzw. zusammengearbeitet haben. |
| UnknownFutureValue | 12 | Für die Zukunftsnachweise folgen Sie den verteilbaren Enumerationen von Microsoft Graph. Fügen Sie alle neuen Enumerationen unterhalb dieser hinzu, bis sich die Hauptversion der API ändert. |
| ContainerName | 13 | Der Name des Containers |
| ContainerUrl | 14 | Die URL des Containers |
| IconUrl | 15 | Die URL eines Symbols |
SourcePropertyDefinition
Definiert eine einzelne Quelleigenschaft für ein Element in der Datenquelle. Ausführliche Informationen zu Schemaeigenschaftendefinitionen finden Sie unter Eigenschaftenressourcentyp.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| name | string | Der Name der Eigenschaft. |
| type | SourcePropertyType | Datentyp der Eigenschaft. |
| defaultSearchAnnotations | uint32 | Standardmäßige Suchanmerkungen für die Eigenschaft. |
| requiredSearchAnnotations | uint32 | Erforderliche Suchanmerkungen. Bestimmte Eigenschaften wie ID sind immer auf isQueryabletrue und isRetrievabletrue festgelegt. |
| defaultSemanticLabels | Wiederholtes SearchPropertyLabel | Liste der semantischen Bezeichnungen für die Quelleigenschaft. |
| Bestellung | int32 | Reihenfolge dieser Quelleigenschaft. Wird von der Benutzeroberfläche zum Sortieren der Suchergebnisse verwendet. Optional. |
| label | Zeichenfolge | Bezeichnung dieser Quelleigenschaft. Wird von der Benutzeroberfläche der Suchergebnisse verwendet, um die Bezeichnung (lesbarer Name) anzuzeigen. Optional. |
| decknamen | Wiederholte Zeichenfolge | Liste der Aliase dieser Quelleigenschaft. Optional. |