Microsoft Graph Connectors SDK Vertrags Connector Crawler-API und -Modelle
Die Microsoft Graph Connectors SDK Contracts Connector Crawler-API und -Modelle werden während einer Durchforstung aufgerufen.
Connectorcrawler-API
| Methode | Parameter | Rückgabetyp | Beschreibung |
|---|---|---|---|
| GetCrawlStream | GetCrawlStreamRequest | CrawlStreamBit als Stream | Liest Daten aus der Datenquelle. Diese Methode wird während vollständiger und regelmäßiger vollständiger Durchforstungen aufgerufen, bei denen alle Elemente aus der Datenquelle gelesen und an die Plattform zurückgegeben werden sollen. |
| GetIncrementalCrawlStream | GetIncrementalCrawlStreamRequest | IncrementalCrawlStreamBit als Stream | Liest Daten aus der Datenquelle. Diese Methode ist optional und wird während inkrementeller Durchforstungen aufgerufen und gibt nur die inkrementellen Änderungen an Elementen seit der letzten inkrementellen Durchforstung zurück. |
Connector-Crawlermodelle
Im Folgenden sind die Connector-Crawlermodelle aufgeführt.
GetCrawlStreamRequest
Anforderungsmodell zum Abrufen von Elementen während der Durchforstung.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| customConfiguration | CustomConfiguration | Stellt Konfigurationsdaten für den Connector bereit. |
| authenticationData | AuthenticationData | Enthält die Zugriffs-URL für die Datenquelle und die Anmeldeinformationen für den Zugriff darauf. |
| crawlProgressMarker | CrawlCheckpoint | Enthält Daten, um Elemente zu identifizieren, die bei der letzten Durchforstung verarbeitet wurden. Der Connector gibt die Informationen des Elements zurück und verwendet sie, wenn die Plattform während der Durchforstung abstürzt. |
| Schema | DataSourceSchema | Zeigt das Schema der Verbindung an. Diese Eigenschaft kann auch verwendet werden, um den Wert festzulegen. |
CrawlStreamBit
Antwortmodell, das das Element status enthält, das den Erfolg oder Fehler angibt, sowie den Indikator/Prüfpunkt für das Element, das während der vollständigen oder regelmäßigen Durchforstung durchforstet wird.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| status | OperationStatus | Zeigt die status des Vorgangs und Fehlerdetails an. |
| crawlItem | CrawlItem | Zeigt ein einzelnes Element an, das aus der Datenquelle durchforstet wurde. |
| crawlProgressMarker | CrawlCheckpoint | Identifiziert das Element, das aus der Datenquelle durchforstet wurde. |
GetIncrementalCrawlStreamRequest
Anforderungsmodell zum Abrufen von Elementen während einer inkrementellen Durchforstung.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| customConfiguration | CustomConfiguration | Stellt Konfigurationsdaten für den Connector bereit. |
| authenticationData | AuthenticationData | Enthält die Zugriffs-URL für die Datenquelle und die Anmeldeinformationen für den Zugriff darauf. |
| crawlProgressMarker | CrawlCheckpoint | Enthält Daten, um Elemente zu identifizieren, die bei der letzten Durchforstung verarbeitet wurden. Der Connector gibt die Informationen des Elements zurück und verwendet sie, wenn die Plattform während der Durchforstung abstürzt. |
| Schema | DataSourceSchema | Zeigt das Schema der Verbindung an. Diese Eigenschaft kann auch verwendet werden, um den Wert festzulegen. |
| previousCrawlStartTimeInUtc | Zeitstempel | Zeigt die vorherige Durchforstungsstartzeit in UTC an. Dieser Wert kann bei der ersten inkrementellen Durchforstung verwendet werden, aber nachfolgende Aufrufe sollten den Prüfpunktwert verwenden. |
IncrementalCrawlStreamBit
Antwortmodell, das das Element enthält, status, das ggf. Erfolg/Fehler sowie den Indikator/Prüfpunkt für das Element angibt, das während der inkrementellen Durchforstung durchforstet wird.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| status | OperationStatus | Zeigt die status des Vorgangs und Fehlerdetails an. |
| crawlItem | IncrementalCrawlItem | Zeigt ein einzelnes Element an, das während und der inkrementellen Durchforstung aus der Datenquelle durchforstet wurde. |
| crawlProgressMarker | CrawlCheckpoint | Identifiziert das letzte Element, das während der letzten inkrementellen Durchforstung aus der Datenquelle durchforstet wurde. |
ItemType-Enumerationselemente für CrawlItem
Enumerationsfelder für Durchforstungselemente.
| Element | Wert | Beschreibung |
|---|---|---|
| ContentItem | 0 | Datenelemente mit zu erfassendem Inhalt. Beispiel: Websiteinhalte. |
| LinkItem | 1 | Link zu einem Inhaltselement, das in nachfolgenden Durchforstungen verwendet wird. Beispiel: Links zu einer Website oder einem Ordner. |
CrawlItem
Stellt eine Entität in der Datenquelle dar. Die maximal zulässige Größe beträgt 4 MB. Beispiel: eine Datei, ein Ordner oder ein Datensatz in einer Tabelle.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Itemid | string | Zeigt die eindeutige ID an, die das Element in der Datenquelle darstellt. |
| contentItem | ContentItem | Zeigt ein Datenelement mit zu erfassendem Inhalt an. Beispiel: der Inhalt einer Website. |
| linkItem | LinkItem | Link zu einem Inhaltselement, das in nachfolgenden Durchforstungen verwendet wird. Beispiel: ein Link zu einer Website oder einem Ordner. |
| Itemtype | ItemType | Zeigt den Typ des gesendeten Elements an. Dieses Modell sollte über ein contentItem- oder linkItem-Element verfügen, und dieses Enumerationsfeld sollte diesem Element entsprechen. |
Hinweis
- Die Eigenschaften linkItem und contentItem schließen sich gegenseitig aus.
ItemType-Enumerationselemente für IncrementalCrawlItem
Enumerationsfelder für Elemente der inkrementellen Durchforstung.
| Element | Wert | Beschreibung |
|---|---|---|
| ContentItem | 0 | Datenelemente mit zu erfassendem Inhalt. Beispiel: der Inhalt einer Website. |
| LinkItem | 1 | Link zu einem Inhaltselement, das in nachfolgenden Durchforstungen verwendet wird. Beispiel: ein Link zu einer Website oder einem Ordner. |
| DeletedItem | 2 | Element, das aus der Datenquelle gelöscht wurde und aus dem Index gelöscht werden sollte. |
IncrementalCrawlItem
Stellt eine Entität in der Datenquelle dar. Beispiel: eine Datei, ein Ordner oder ein Datensatz in einer Tabelle.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Itemid | string | Zeigt die eindeutige ID an, die das Element in der Datenquelle darstellt. |
| contentItem | ContentItem | Zeigt ein Datenelement mit zu erfassendem Inhalt an. Beispiel: der Inhalt einer Website. |
| linkItem | LinkItem | Link zu einem Inhaltselement, das in nachfolgenden Durchforstungen verwendet wird. Beispiel: ein Link zu einer Website oder einem Ordner. |
| deletedItem | DeletedItem | Element, das aus der Datenquelle gelöscht wird und aus dem Index entfernt werden soll. Wenn deletedItem festgelegt ist, kann contentItem oder linkItem nicht festgelegt werden. |
| Itemtype | ItemType | Zeigt den Typ des gesendeten Elements an. Dieses Modell sollte über ein contentItem- oder linkItem-Element verfügen, und dieses Enumerationsfeld sollte diesem Element entsprechen. |
Hinweis
- Die Eigenschaften linkItem, contentItem und deletedItem schließen sich gegenseitig aus.
ContentItem
Element, das den Inhalt der zu erfassenden Datenquellenentität enthält. Beispiel: der Inhalt einer Website.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Propertyvalues | SourcePropertyValueMap | Enthält den Schlüssel und die Werte jeder Eigenschaft im Element. |
| accessList | Accesscontrollist | Schränkt den Zugriff auf das Element auf bestimmte Benutzer oder Gruppen ein. |
| content | Inhalt | Zeigt die Inhaltseigenschaft des Elements an, das beim Anzeigen von Suchergebnissen verwendet werden kann. |
LinkItem
Element, das als Link zu einem anderen Element fungiert. Diese Linkelemente werden zum erneuten Durchforsen an den Connector gesendet. In einem Ordnerinhalt sind z. B. Dateien Inhaltselemente, und Unterordner sind Linkelemente.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Metadaten | map<string, GenericType> | Enthält die Metadaten, die der Connector zum erneuten Durchforsen des Elements benötigt. |
DeletedItem
Stellt ein Element dar, das aus der Datenquelle gelöscht wurde und aus dem Index entfernt werden muss.
Accesscontrollist
Schränkt die Benutzer ein, die die Suchergebnisse sehen können.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Entries | Wiederholtes AccessControlEntry | Zeigt das Array oder die Auflistung von Zugriffssteuerungslisteneinträgen an. |
Elemente der AclAccessType-Enumeration
Enumerationsmember des Zugriffssteuerungslistentyps.
| Element | Wert | Beschreibung |
|---|---|---|
| Keine | 0 | Gibt den Standardwert an: deny. |
| Gewähren | 1 | Der Eintrag ist für Benutzer/Gruppen mit Zugriff auf das Element. |
| Deny | 2 | Der Eintrag ist für Benutzer/Gruppen ohne Zugriff auf das Element und überschreibt die Gewährung für beliebige Benutzer/Gruppen. |
Accesscontrolentry
Enthält einzelne Zugriffssteuerungseinträge.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| accessType | AclAccessType | Zeigt den Zugriffstyp der Entität entweder gewähren oder verweigern an. |
| Prinzipal | Principal | Stellt eine Gruppe oder einen Benutzer mit definiertem Zugriff dar. |
Elemente der PrincipalType-Enumeration
Enumerationsmember des Prinzipaltyps.
| Element | Wert | Beschreibung |
|---|---|---|
| PT_None | 0 | Gibt den Standardwert an: user. |
| Benutzer | 1 | Typ des Benutzers. |
| Gruppe | 2 | Typ der Gruppe. |
| Jeder | 3 | Spezielle Gruppe, um allen Zugriff zu gewähren. |
| EveryoneExceptGuests | 4 | Spezielle Gruppe, um allen Personen außer Gästen Zugriff zu gewähren. |
Member der IdentitySource-Enumeration
Enumerationsmember der Identitätsquelle.
| Element | Wert | Beschreibung |
|---|---|---|
| IS_None | 0 | Gibt den Standardwert an: Microsoft Entra ID. |
| AzureActiveDirectory | 1 | Die Identitätsquelle ist Microsoft Entra ID. |
Member der IdentityType-Enumeration
Enumerationsmember des Identitätstyps.
| Element | Wert | Beschreibung |
|---|---|---|
| IT_None | 0 | Gibt den Standardwert an: (Azure ADId). |
| ActiveDirectorySId | 1 | SID (Lokale Sicherheits-ID), die von Active Directory (AD) bereitgestellt wird. |
| UserPrincipalName | 2 | Benutzerprinzipalname (UPN). |
| AadId | 3 | Azure ADId. |
Principal
Struktur zum Speichern von Attributen des Prinzipals (Benutzer/Gruppe).
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| type | PrincipalType | Typ des Prinzipals. |
| Wert | string | Prinzipalwert: Der Wert von SID, UPN, Azure ADId usw. |
| identitySource | IdentitySource | Die Identitätsquelle. |
| Identitytype | IdentityType | Identitätsdarstellungstyp. |
| identitySourceProperties | Zuordnungszeichenfolge<, Zeichenfolge> | Metadaten zur Identitätsquelle. |
SourcePropertyValueMap
Zuordnung des Quelleigenschaftsschlüssels und seines Werts in der Datenquelle. Es speichert den Eigenschaftswert jedes Elements.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| values | map<string, GenericType> | Enthält den Schlüssel und die Werte der Eigenschaften des Elements. Der Schlüssel ist der Eigenschaftsname, und der Wert ist der Eigenschaftswert. Dateiinhalte verfügen beispielsweise über Eigenschaften wie title, modifiedDate usw. Die Eigenschaftenschlüssel sind die Eigenschaften selbst, und ihre Werte sind der Titel der Datei bzw. des Änderungsdatums der Datei. |
Elemente der ContentType-Enumeration
Enumerationsmember des Inhaltstyps.
| Element | Wert | Beschreibung |
|---|---|---|
| Keine | 0 | Standardwert. |
| Text | 1 | Textinhaltstyp. |
| HTML | 2 | HTML-Inhaltstyp. |
Inhalt
Der Wert der Inhaltseigenschaft des Elements, der zum Rendern von Suchergebnissen verwendet wird.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| contentType | ContentType | Typ des Inhalts. |
| contentValue | string | Wert der Inhaltseigenschaft. |
CrawlCheckpoint
Identifiziert das Element, das zuletzt durchforstet wurde. Es wird von der Plattform gespeichert, und der Prüfpunkt aus dem letzten erfolgreichen Elementbatch wird für die Fortsetzung der Durchforstung verwendet, wenn es zu einem Fehler oder Absturz kommt. Die Plattform sendet den Prüfpunkt in der GetCrawlStream-API .
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Pagenumber | uint32 | Zeigt die Seitenzahl zum Markieren des Durchforstungsfortschritts an. |
| Batchsize | uint32 | Enthält die Anzahl der elemente, die in jedem Batch zurückgegeben werden. Er hat einen konstanten Wert von 1, da jedes Element einzeln gestreamt wird. |
| customMarkerData | Zeichenfolge | Benutzerdefinierte Daten, die erforderlich sind, um das letzte element zu identifizieren, das aus der Datenquelle durchforstet wurde. |
GenericType
Modell, das die von der Plattform unterstützten Wertetypen in bestimmten Feldern wie Quelleigenschaftswerten enthält. Es muss nur eines der folgenden Felder festgelegt werden.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| Stringvalue | string | Stellt einen Zeichenfolgenwert dar. |
| intValue | int64 | Stellt einen int64 -Wert (long) dar. |
| doubleValue | double | Stellt einen double-Wert dar. |
| dateTimeValue | google.protobuf.Timestamp | Stellt einen dateTime-Wert dar. |
| boolValue | bool | Stellt einen booleschen Wert dar. |
| stingCollectionValue | StringCollectionType | Stellt eine Auflistung von Zeichenfolgen dar. |
| intCollectionValue | IntCollectionType | Stellt eine Auflistung von int64 (long) dar. |
| doubleCollectionValue | DoubleCollectionType | Stellt eine Auflistung von double dar. |
| dateTimeCollectionValue | TimestampCollectionType | Stellt eine Auflistung von dateTime dar. |
StringCollectionType
Auflistung von Zeichenfolgen.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| values | Wiederholte Zeichenfolge | Auflistung oder Array von Zeichenfolgen. |
IntCollectionType
Auflistung ganzzahliger Werte.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| values | wiederholt int64 | Auflistung oder Array von int64-Werten (long). |
DoubleCollectionType
Auflistung von Double-Werten.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| values | Wiederholtes Double | Auflistung oder Array von Double-Werten. |
TimestampCollectionType
Auflistung von DateTime-Werten .
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| values | wiederholt google.protobuf.Timestamp | Auflistung oder Array von dateTime-Werten . |