Share via

Referenzhandbuch zur SharePoint-Migrations-API

  • Artikel

In diesem Leitfaden wird die Verwendung der SharePoint-Migrations-API beschrieben, die Inhalte basierend auf Manifestdateien in SharePoint importiert.

CSOM und REST

Die Migrations-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 .

CreateMigrationJob-Methode

Erstellt einen neuen Migrationsimportauftrag mit dem im azureContainerSourceUri Parameter angegebenen Importpaket.

CreateMigrationJob-Syntax

public Guid CreateMigrationJobEncrypted(
Guid gWebId,
string azureContainerSourceUri,
string azureContainerManifestUri,
string azureQueueReportUri,
EncryptionOption AES256CBCKey
)

POST https://{site_url}/_api/site/CreateMigrationJobEncrypted
{
  "options": {
    "AES256CBCKey": "000000000000000000000000000000000000000000000000000000="
  },
  "gWebId": "00000000-0000-0000-0000-000000000000",
  "azureContainerSourceUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw",
  "azureContainerManifestUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw"
}

CreateMigrationJob-Parameter

gWebID

Erforderlich.

Ein String-Wert , der den eindeutigen Bezeichner des Zielwebs für den Paketimport enthält. Das Importpaket selbst gibt zusätzliche Informationen und Bezeichner für den Import an. Sie können diesen Bezeichner programmgesteuert finden, indem Sie das Zielweb mithilfe von CSOM-Aufrufen abfragen.

azureContainerSourceUri

Erforderlich.

Ein String-Wert, der den gültigen URI einschließlich des SAS-Tokens enthält, um auf den Azure Blob Storage Container zuzugreifen, der die Binärdateien vom Typ Block enthält.

Anweisungen zur Verwendung von Azure Blob Storage Containern bei der Migration finden Sie unter Verwenden von Azure Blob Storage Containern und Azure Warteschleifen mit der SharePoint-Migrations-API.

Wenn Sie Inhaltscontainer verwenden, die von dieser Methode nicht bereitgestellt werden, benötigt Readdie Migrations-API nur die Berechtigungen und List . Stellen Sie sicher, dass die Startzeit des SAS-Tokens auf oder vor der Auftragsübermittlung festgelegt ist. Lassen Sie außerdem beim Festlegen der Ablaufzeit eine angemessene Dauer für den Abschluss des Importvorgangs ein.

Die Migrations-API erfordert List keine Berechtigung von Containern, die mit ProvisionMigrationContainers der -Methode bereitgestellt werden.

azureContainerManifestUri

Erforderlich.

Ein String-Wert, der den gültigen URI enthält, einschließlich des SAS-Tokens, für den Zugriff auf den Azure Blob Storage Container, der die Blockblobs für das Manifest und andere Pakete enthält, die XML-Dateien beschreiben. Die Migrations-API schreibt Protokoll in diesen Container. Dieser Container kann nicht mit dem container identisch sein, der für verwendet azureContainerSourceUriwird.

Anweisungen zur Verwendung von Azure Blob Storage Containern bei der Migration finden Sie unter Verwenden von Azure Blob Storage Containern und Azure Warteschleifen mit der SharePoint-Migrations-API.

Wenn Sie Inhaltscontainer verwenden, die nicht von dieser Methode bereitgestellt werden, benötigt Readdie Migrations-API nur die Berechtigungen , Listund Write . Stellen Sie sicher, dass die Startzeit des SAS-Tokens auf oder vor der Auftragsübermittlung festgelegt ist. Lassen Sie außerdem beim Festlegen der Ablaufzeit eine angemessene Dauer für den Abschluss des Importvorgangs ein.

azureQueueReportUri

Optional.

Ein String-Wert , der die gültige URL einschließlich des SAS-Tokens enthält, um auf die vom Benutzer bereitgestellte Azure-Warteschlange für den Fortschritt des Migrationsauftrags zuzugreifen. Verwenden Sie null , wenn der Empfang von Importen status Updates nicht erforderlich ist.

Wenn dieser Wert nicht nullist und das SAS-Token die richtigen Berechtigungen enthält, schreibt die Migrations-API import status Updates in die Warteschlange unter der angegebenen URL.

Teilen Sie die Benachrichtigungswarteschlange für mehrere Migrationsaufträge. Die Migrations-API identifiziert jeden Auftrag mit eindeutigen Auftrags-ID-Werten in der Benachrichtigungswarteschlange.

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

Erfordert Addnur die Berechtigungen , Readund Update . Wenn das SAS-Token über andere Berechtigungen verfügt, kann der Migrationsauftrag der Warteschlange keine Ereignisse hinzufügen.

CreateMigrationJob-Rückgabewert

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. Verwenden Sie auftrags-ID, um die status von Migrationsaufträgen mit GetMigrationJobStatus der -Methode abzufragen.

Beispiel

Guid MigrationJobId = TargetSite.CreateMigrationJob(
TargetWebId,
azureContainerSourceUri,
azureContainerManifestUri,
azureQueueReportUri);

CreateMigrationJobEncrypted-Methode

Erstellt einen neuen Migrationsimportauftrag mit einem verschlüsselten PRIME-Paket.

Überprüfen Sie die Verschlüsselungsanweisungen in Azure für Azure Blob Storage verwendete Container- und Azure-Warteschlangenverschlüsselung.

CreateMigrationJobEncrypted-Syntax

public Guid CreateMigrationJobEncrypted(
Guid gWebId,
string azureContainerSourceUri,
string azureContainerManifestUri,
string azureQueueReportUri,
EncryptionOption AES256CBCKey
)

POST https://{site_url}/_api/site/CreateMigrationJobEncrypted
{
  "options": {
    "AES256CBCKey": "000000000000000000000000000000000000000000000000000000="
  },
  "gWebId": "00000000-0000-0000-0000-000000000000",
  "azureContainerSourceUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw",
  "azureContainerManifestUri": "https://tenant.blob.core.windows.net:443/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000=rw"
}

CreateMigrationJobEncrypted-Parameter

gWebIDDie Parameter , azureContainerSourceUri, azureContainerManifestUriund azureQueueReportUri haben die gleichen Anforderungen wie in der CreateMigrationJob -Methode.

Geben Sie EncryptionOption den Parameter wie unten angegeben an.

Encryptionoption

Erforderlich.

Ein EncryptionOption -Objekt, das den AES256CBCKey enthält, der zum Entschlüsseln der Ausgabe verwendet wird.

Die Migrations-API verschlüsselt die Ausgabe mit dem bereitgestellten Schlüssel AES256CBCKey.

Weitere Informationen finden Sie unter [EncryptionOption](https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.encryptionoption) -Klasse.

Rückgabewert von CreateMigrationJobEncrypted

Weitere Informationen finden Sie unter Rückgabewert in der CreateMigrationJob -Methode.

GetMigrationJobStatus-Methode

Ruft die Verarbeitungs-status für einen bestimmten Migrationsauftrag ab.

Die Migrations-API entfernt abgeschlossene Migrationsaufträge aus der Zeitgeberauftragswarteschlange. Überprüfen Sie die Benachrichtigungswarteschlange und/oder Protokollausgaben auf Importergebnisse.

GetMigrationJobStatus-Syntax

[ClientNS.ClientCallableMethod]
public SPMigrationJobState GetMigrationJobStatus(Guid MigrationJobId)

GetMigrationJobStatus-Parameter

ID

Erforderlich.

Ein GUID-Wert , der die Migrationsauftrags-ID enthält, wird von CreateMigrationJobzurückgegeben.

Rückgabewert von GetMigrationJobStatus

Ein SPMigrationJobState -Objekt, das die status des Migrationsauftrags enthält.

GetMigrationJobStatus-Beispiel

SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId);

SPMigrationJobState-Enumeration

Enthält Elemente, die die status von Migrationsaufträgen in der Importwarteschlange darstellen.

SPMigrationJobState-Member

Keine

Wert: 0

Die Warteschlange enthält nicht den Migrationsauftrag mit der Auftrags-ID. Mögliche Gründe:

  • Die Migrations-API hat den Auftrag abgeschlossen und aus der Warteschlange entfernt.
  • Die Auftrags-ID ist ungültig.

In Warteschlange eingereiht

Wert: 2

Die Warteschlange enthält den Migrationsauftrag. Die Migrations-API verarbeitet den Auftrag nicht.

Verarbeitung

Wert: 4

Die Warteschlange enthält den Migrationsauftrag. Die Migrations-API verarbeitet den Auftrag.