Installation und Konfiguration
Microsoft SharePoint Online Azure Principal Resolution Service
Copyright ©
Mindbreeze GmbH, A-4020 Linz, 2023.
Alle Rechte vorbehalten. Alle verwendeten Hard- und Softwarenamen sind Handelsnamen und/oder Marken der jeweiligen Hersteller.
Diese Unterlagen sind streng vertraulich. Durch die Übermittlung und Präsentation dieser Unterlagen alleine werden keine Rechte an unserer Software, an unseren Dienstleistungen und Dienstleistungsresultaten oder sonstigen geschützten Rechten begründet. Die Weitergabe, Veröffentlichung oder Vervielfältigung ist nicht gestattet.
Aus Gründen der einfacheren Lesbarkeit wird auf die geschlechtsspezifische Differenzierung, z.B. Benutzer/-innen, verzichtet. Entsprechende Begriffe gelten im Sinne der Gleichbehandlung grundsätzlich für beide Geschlechter.
Einleitung
Microsoft SharePoint Online Azure Principal Resolution Service kombiniert die Caches von SharePoint Online und Azure in einem Cache. Die jeweils notwendige serverseitige Konfiguration entnehmen Sie bitte der Dokumentation von Microsoft SharePoint Online und Microsoft Azure.
Hinweis: Falls beide Caches (SharePoint Online und Azure) gleichzeitig genutzt werden sollen, wird dieser Kombinations-Service anstelle der Nutzung der einzelnen Services empfohlen.
Konfiguration des Principal Resolution Service
Gehen Sie in den Tab „Indices“, scrollen Sie nach unten und fügen Sie im Bereich „Services“ durch
Klick auf „Add Service“ ein neues Service hinzu. Wählen Sie „SharepointOnlineAzurePrincipalCache“ aus und vergeben Sie einen Anzeigenamen.
Bereich „Sharepoint Settings“
Server URL
Die URL der SharePoint Online Instanz, z.B.: https://mycompany.sharepoint.com
Sollte genauso wie im Crawler konfiguriert werden.
Admin Server URL
Die Admin URL der SharePoint Online Instanz. Meistens ist es die Server URL mit einem -admin, z.B. https://mycompany-admin.sharepoint.com
Sollte genauso wie im Crawler konfiguriert werden.
Site Relative URL
Die relativen Pfade zu den Sites, die gecrawlt werden sollen, beginnend mit einem Schrägstrich, z.B.: /sites/mysite.
Jede Zeile beinhaltet einen Pfad.
Wenn dieses Feld leergelassen wird, werden automatisch alle Sites im SharePoint Online gefunden und indiziert. Wenn Sites angegeben werden, werden nur die Subsites der angegebenen Sites gefunden.
Sollte genauso wie im Crawler konfiguriert werden.
Site Discovery Schedule
Eine Extended Cron Expression, die angibt wann die Site Discovery ausgeführt werden soll. Die Ergebnisse werden dann bei den nächsten Crawlruns verwendet. Dadurch muss die eventuell aufwändige Site Discovery nicht bei jedem Crawlrun wiederholt werden.
Eine Dokumentation und Beispiele zu Cron Expressions finden Sie hier.
Background Site Discovery Parallel Request Count
(Advanced Settings)
Hier kann die maximale Anzahl an HTTP Requests, die parallel von der Site Discovery gesendet, bestimmt werden.
Site Discovery Strategy
(Advanced Settings)
Die Methode, mit der die Site Discovery durchgeführt werden soll.
Auto | Es wird anhand der Authentisierungsmethode automatisch entschieden, welche Methode verwendet werden soll. |
Admin API | Es wird die SharePoint Admin API für die Site Discovery verwendet. Dadurch werden ALLE Seiten der SharePoint Online Instanz gefunden. Hierfür muss entweder App-Only Authentication oder User-Based Authentication mit einem Admin User verwendet werden. |
Search | Es wird die SharePoint Online Suche für die Site Discovery verwendet. Dadurch können automatisch nur Seiten gefunden werden, auf die der Crawl User Zugriff hat. Für User-Based Authentication ohne Admin User, kann nur diese Methode verwendet werden. |
Included Sites URL (regex)
Regular Expression, mit der angegeben werden kann, welche Subsites gecrawlt werden sollen. Wenn diese Option leer gelassen wird, werden alle Subsites gecrawlt. Die Regex matched auf relative URLs. z.B. /sites/mysite
Sollte genauso wie im Crawler konfiguriert werden.
Excluded Sites URL (regex)
Regular Expression, mit der angegeben werden kann, welche Subsites exkludiert werden sollen. Die Regex matched auf relative URLs. z.B. /sites/mysite
Sollte genauso wie im Crawler konfiguriert werden.
Enable Delta Update
(Advanced Settings)
Wenn aktiviert, werden nach der ersten Cache-Erstellung nur die Änderungen an den Gruppen von SharePoint Online abgeholt, anstatt jedes Mal alle Gruppen abzuholen. Dies ist vor allem bei sehr großen SharePoint Instanzen empfohlen, da ein reguläres Cacheupdate ansonsten sehr lange dauern kann.
Delta Updating mit User-Based Authentication wird nicht unterstützt – falls Delta Updating benötigt wird, muss App-Only Authentication verwendet werden.
User Agent
(Advanced Settings)
Der angegebene Wert wird im User-Agent Header bei HTTP-Requests mitgesendet.
Dump Change Responses
Wenn aktiviert werden die Changes, die wir von SharePoint Online beim Delta Update erhalten, in ein File gedumpt. Dies ist zur Fehlersuche sehr hilfreich.
Log All HTTP Requests
(Advanced Settings)
Wenn gesetzt, werden alle HTTP-Requests, die im Laufe des Cache Updates vom Principal Resolution Service versendet werden, in ein .csv-File geschrieben (sp-request-log.csv).
Regex for your organization (used to determine authenticated users)
Regular Expression, die definiert, ob ein Benutzer Ihrer Organisation angehört oder nicht. Damit wird das Principal „everyone_except_external“ aufgelöst.
Der reguläre Ausdruck kann sich dabei auf die E-Mail-Adresse, die ObjectSID oder die ObjectGUID aus LDAP beziehen.
Parallel Request Count
Mit dieser Option kann definiert werden, wie viele HTTP-Requests vom Crawler gleichzeitig abgeschickt werden. Umso höher der Wert, umso schneller sollte der Crawlrun sein, allerdings kann ein zu hoher Wert auch zu vielen „Too Many Requests“ Errors auf Seiten von SharePoint führen. Ein Wert über 30 ist nicht empfohlen.
Page Size
Maximale Anzahl an Objekten die pro Request an die API empfangen werden.
Ein hoher Wert führt sorgt für höhere Geschwindigkeit, aber auch zu größerem Speicherverbrauch während dem Cache Update, ein kleiner Wert sorgt für weniger Speicherverbrauch, dafür verringert sich aber die Geschwindigkeit.
Wird der Wert auf 0 gesetzt, wird kein Paging verwendet, also der Crawler versucht mit Request alle Objekte auf einmal abzuholen.
Trust all SSL certificates
Erlaubt die Verwendung von nicht gesicherten
Verbindungen, beispielsweise für Testsysteme.
Darf nicht in Produktion aktiviert werden.
Heap Dump On Out Of Memory
Wenn diese Option aktiviert ist, macht der
Principal Service einen Heap Dump falls er Out Of
Memory läuft.
Use App-Only authentication