SharePoint Asynchronous Metadata Read (AMR)-API–Referenzhandbuch

Verwenden Sie dieses Dokument als Leitfaden für die Verwendung der SHAREPoint-AMR-API (Asynchronous Metadata Read).

Die AMR-API aggregiert SharePoint-Metadaten in einem Manifestpaket. Verwenden Sie das Paket für die inkrementelle Migration, die Strukturerstellung, die Überprüfung nach der Migration oder die Berechtigungsverwaltung.

CSOM und REST

Die AMR-API unterstützt sowohl das clientseitige SharePoint-Objektmodell (Client Side Object Model, CSOM) als auch REST.

Verwenden von NuGet-Paketen mit CSOM

Verwenden Sie NuGet-Pakete, um auf das SharePoint Client Side Object Model (CSOM) in Ihrer Lösung zu verweisen.

Verwalten Sie Auf einfache Weise Abhängigkeiten, und stellen Sie sicher, dass Ihre Lösung die neueste Version der CSOM-Bibliothek mit NuGet-Paketen verwendet.

Rufen Sie die neueste Version des CSOM-Pakets in den clientseitigen SharePoint-Objektmodellbibliotheken mit der ID Microsoft.SharePointOnline.CSOMab.

Anweisungen zur REST-API finden Sie unter Kennenlernen des SharePoint-REST-Diensts .

CreateSPAsyncReadJob-Methode

Erstellt einen AMR-Auftrag, um alle Metadaten der angegebenen SharePoint-URL und ihrer untergeordneten Elemente in den angegebenen Manifestcontainer zu lesen.

CreateSPAsyncReadJob-Syntax

public SPAsyncReadJobInfo CreateSPAsyncReadJob(String url,
SPAsyncReadOptions readOptions,
EncryptionOption encryptionOption,
string azureContainerManifestUri,
string azureQueueReportUri)

CreateSPAsyncReadJob-Parameter

url

Erforderlich.

Ein String-Wert , der die vollständige Pfad-URL des Pfads der zu lesenden SharePoint-Liste, der Dateien/Ordner oder der Dokumentbibliothek enthält. Die AMR-API gibt alle Metadaten von Dateien, Ordnern und Stammobjekten zurück, einschließlich Unterordnern und untergeordneten Inhalten.

Beispiel

In diesem Beispiel url werden alle Metadaten des freigegebenen Dokuments und seiner untergeordneten Elemente zurückgegeben:

https://www.contoso.com/Shared%20Document

readOptions

Erforderlich.

Eine SPAsyncReadOptions -Struktur mit readOption Werten, die die Typen der zu lesenden Metadaten angeben.

IncludeVersions

Optional.

Ein Bool-Wert , der angibt, ob die AMR-API mehrere Versionen von Dateien und Listenelementen liest.

Der Standardwert ist false. Wenn nicht vorhanden oder auf falsefestgelegt ist, liest die AMR-API nur die neueste Version von Elementen.

IncludeSecurity

Optional.

Ein Bool-Wert , der angibt, ob die AMR-API Benutzer- und Gruppeninformationen im Zusammenhang mit einer Website liest.

Der Standardwert ist false.

Die AMR-API liest Benutzer und Gruppen als Autoren oder Modifizierer als Teil der Metadaten der Objekte.

Bei Festlegung auf trueliest die AMR-API alle Benutzer in Websitesammlungen. Beim Lesen mehrerer Dokumentbibliotheken unter derselben Websitesammlung werden die gleichen Benutzer und Gruppen möglicherweise mehrmals im Lesepaket angezeigt.

IncludeDirectDescendantsOnly

Optional.

Ein Bool-Wert , der angibt, ob die AMR-API nur die Metadaten der direkten Nachfolger liest.

Der Standardwert ist false.

Bei Festlegung auf trueliest die AMR-API nur die Metadaten der direkten Nachfolger.

Verwenden Sie dies readOption zusammen mit IncludeSecurityreadOption , um die Leistung beim Lesen von Metadaten aus einer Dokumentbibliothek mit einer großen Anzahl von Elementen zu verbessern, wie unter Bewährte Methode zur Vermeidung einer langsamen Leistung beschrieben.

IncludeExtendedMetadata

Optional.

Der Standardwert ist false.

Bei Festlegung auf falseliest die AMR-API grundlegende Metadaten:

• Auflisten
• Ordner
• File
• List Item
• Rollen
• Rollenzuweisungen

Bei Festlegung auf trueliest die AMR-API alle verfügbaren Metadaten:

Für Dateien:

• Webpart
• Webpartpersonalisierung
• Links
• Versionsereignisse
• Ereignisempfänger
• Anlagenmetadaten

Für Listen:

• Benutzerdefinierte Aktionen
• Listenverknüpfungen

Für Listenelemente:

• Kommentare
• Dokumentensatzlinks
• Aktivitäten
• Listenelementverknüpfungen

Das Einschließen erweiterter Metadaten verlangsamt den Lesevorgang erheblich. Behalten Sie bei Dateifreigabemigrationen den Standardwert falsebei. Legen Sie für komplexe Migrationsprojekte nur bei Bedarf auf true fest.

IncludePermission

Optional.

Ein Bool-Wert , der angibt, ob Leseberechtigungen erforderlich sind. Der Standardwert ist false.

Bei Festlegung auf trueliest die AMR-API Berechtigungsmetadaten in RoleAssignments Tags in Manifest.xml Dateien. Die Datei enthält alle Distinguished-Berechtigungsmetadaten für jedes gelesene SharePoint-Objekt zusammen mit der -Eigenschaft ScopeId.

StartChangeToken

Optional.

Ein Integer-Wert , der das changeToken-Element enthält.

Wenn kein StartChangeToken angegeben ist, CreateSPAsyncReadJob gibt die Methode standardmäßig alle verfügbaren Elemente basierend auf den Parametern zurück. Ein CurrentChangeToken Wert wird jedes Mal zurückgegeben.

Um nur die Elemente zu lesen, die seit dem letzten Lesevorgang geändert wurden, legen Sie in nachfolgenden Aufrufen auf CreateSPAsyncReadJobfestStartChangeToken. Verwenden Sie CurrentChangeToken vom letzten Aufruf zurückgegeben als Wert von StartChangeToken.

Die AMR-API gibt einen Fehler zurück und beendet den Lesevorgang, wenn sie einen ungültigen StartChangeToken Wert empfängt.

Seien Sie vorsichtig, wenn Sie dieses Feature mit einer großen Anzahl von Elementen verwenden. Der Leseauftrag kann länger ausgeführt werden. Die AMR-API bricht Aufträge ab, die über 10 Minuten ausgeführt werden, um die SharePoint-Infrastruktur zu schützen.

encryptionOption

Optional.

Ein EncryptionOption -Objekt, das den AES-256-CBC-Schlüssel enthält, der zum Entschlüsseln der Ausgabe verwendet wird.

Standardmäßig verschlüsselt die AMR-API die Ausgabe- und Ereigniswarteschlange nicht. Bei Festlegung mit dem AES-256-CBC-Schlüssel verschlüsselt die AMR-API die Ausgabe mit dem angegebenen Schlüssel.

Weitere Informationen finden Sie unter EncryptionOption -Klasse.

azureContainerManifestUri

Erforderlich.

Ein String-Wert , bei dem es sich um die Ziel-URL des Azure Blob Storage-Containers handelt, der das Ausgabemanifestpaket enthält.

Anweisungen zur Verwendung von Azure Blob Storage-Containern bei der Migration finden Sie unter Azure .

azureQueueReportUri

Erforderlich.

Ein String-Wert , bei dem es sich um die URL der Azure-Warteschlange zum Empfangen von Lesestatusmeldungen handelt.

Teilen Sie azureQueueReportUri bei Bedarf zwischen verschiedenen Aufträgen. Die AMR-API gibt zurück JobID , um einzelne erstellte Aufträge zu identifizieren.

Anweisungen zur Verwendung der Azure-Warteschlange bei der Migration finden Sie unter Azure . Überprüfen Sie Migrationsereignisse in Azure-Warteschlange auf Ereignistypen.

CreateSPAsyncReadJob-Rückgabewerte

Auftrags-ID

Ein GUID-Wert , der die Auftrags-ID enthält, den eindeutigen Bezeichner des Migrationsauftrags. Die Methode gibt einen null Wert zurück, wenn sie den Auftrag nicht erstellen kann.

Die AMR-API generiert ein JobEnd Ereignis, wenn sie die Elementanzahl für jede urlschätzt. Weitere Informationen finden Sie unter Ereignisse .

AzureContainerManifest

Ein URI-Wert , der die URL für den Zugriff auf den Azure Blob Storage-Container enthält, der die gelesenen Metadaten enthält.

JobQueueUri

Ein URI-Wert , der die URL der Azure-Warteschlange enthält, die für den Lesestatus verwendet wird.

EncryptionKey

Ein Byte Array-Wert , der den AES-256-CBC-Schlüssel zum Entschlüsseln der Manifestdateien und Nachrichten in der Azure-Warteschlange enthält.

CreateSPAsyncReadJobWithMultiUrl-Methode

Erstellt einen AMR-Auftrag, um alle Metadaten aller angegebenen SharePoint-URLs und deren untergeordneten Elemente in den angegebenen Manifestcontainer zu lesen.

CreateSPAsyncReadJobWithMultiUrl-Syntax

public SPAsyncReadJobInfo CreateSPAsyncReadJobWithMultiUrl(
        String[] urls,
        SPAsyncReadOptions readOptions,
        EncryptionOption encryptionOption,
        String azureContainerManifestUri,
        String azureQueueReportUri)

CreateSPAsyncReadJobWithMultiUrl-Parameter

Weitere Informationen zu readOptions, , encryptionOptionazureContainerManifestUriund azureQueueReportUrifinden Sie CreateSPAsyncReadJob unter -Methode.

urls

Erforderlich.

Ein URI-Array, das die vollständigen Pfad-URLs der Stammpfade der zu lesenden SharePoint-Listen, -Dateien/-Ordner oder -Dokumentbibliotheken enthält. Die AMR-API gibt alle Metadaten von Dateien, Ordnern und Stammobjekten zurück, einschließlich Unterordnern und untergeordneten Inhalten.

Geben Sie bei Bedarf mehrere URLs an. Ein verschärfter Aufruf mit mehreren URLs kann die Leistung verbessern. Weitere Informationen finden Sie unter Leistung .

Fehler

-2146232832

Das changeToken bezieht sich auf einen Zeitpunkt vor dem Beginn des aktuellen Änderungsprotokolls.

Das Änderungsprotokoll ist auf 60 Tage unmittelbar vor dem aktuellen Datum beschränkt. Die AMR-API gibt diesen Fehlercode zurück, wenn der angegebene changeToken auf eine Zeit außerhalb des 60-Tage-Zeitfensters verweist.

-2147213196

Vorgang abgebrochen.

Die AMR-API hat eine Abbruchanforderung vom Client empfangen und den Lesevorgang abgebrochen.