Partager via

Guide de référence de l’API de migration SharePoint

  • Article

Ce guide décrit l’utilisation de l’API de migration SharePoint, qui importe du contenu dans SharePoint, en fonction des fichiers manifeste.

CSOM et REST

L’API de migration prend en charge le modèle objet côté client SharePoint (CSOM) et REST.

Utiliser des packages NuGet avec CSOM

Pour référencer le modèle objet côté client SharePoint (CSOM) dans votre solution, utilisez des packages NuGet.

Gérez facilement les dépendances et vérifiez que votre solution utilise la dernière version de la bibliothèque CSOM avec des packages NuGet.

Obtenez la dernière version du package CSOM dans les bibliothèques de modèles objet côté client SharePoint avec l’ID Microsoft.SharePointOnline.CSOM.

Consultez Découvrir le service REST SharePoint pour obtenir des instructions sur l’API REST.

CreateMigrationJob, méthode

Crée une tâche d’importation de migration avec le package d’importation spécifié dans le azureContainerSourceUri paramètre .

Syntaxe CreateMigrationJob

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"
}

Paramètres CreateMigrationJob

gWebID

Obligatoire.

Valeur string qui contient l’identificateur unique du site web de destination ciblé pour l’importation du package. Le package d’importation proprement dit spécifie des informations et des identificateurs supplémentaires pour l’importation. Vous pouvez trouver cet identificateur par programmation en interrogeant le site web cible à l’aide d’appels CSOM.

azureContainerSourceUri

Obligatoire.

Valeur string qui contient l’URI valide, y compris le jeton SAS, pour accéder au conteneur Stockage Blob Azure qui contient les fichiers binaires du bloc de type.

Consultez Utiliser des conteneurs Stockage Blob Azure et Azure Files d’attente avec l’API de migration SharePoint pour obtenir des instructions sur l’utilisation de conteneurs Stockage Blob Azure dans la migration.

Lorsque vous utilisez des conteneurs de contenu non fournis par cette méthode, l’API de migration nécessite Readuniquement les autorisations et List . Vérifiez que l’heure de début du jeton SAS est définie à ou avant l’envoi du travail. En outre, lorsque vous définissez l’heure d’expiration, prévoyez une durée raisonnable pour que le processus d’importation se termine.

L’API de migration ne nécessite pas l’autorisation List des conteneurs approvisionnés avec ProvisionMigrationContainers la méthode .

azureContainerManifestUri

Obligatoire.

Valeur string qui contient l’URI valide, y compris le jeton SAS, pour accéder au conteneur Stockage Blob Azure, qui contient les objets blob de blocs pour le manifeste et d’autres packages décrivant les fichiers XML. L’API de migration écrit le journal dans ce conteneur. Ce conteneur ne peut pas être identique à celui utilisé pour .azureContainerSourceUri

Consultez Utiliser des conteneurs Stockage Blob Azure et Azure Files d’attente avec l’API de migration SharePoint pour obtenir des instructions sur l’utilisation de conteneurs Stockage Blob Azure dans la migration.

Lorsque vous utilisez des conteneurs de contenu non fournis par cette méthode, l’API de migration requiert Readuniquement les autorisations , Listet Write . Vérifiez que l’heure de début du jeton SAS est définie à ou avant l’envoi du travail. En outre, lorsque vous définissez l’heure d’expiration, prévoyez une durée raisonnable pour que le processus d’importation se termine.

azureQueueReportUri

Optional.

Valeur string qui contient l’URL valide, y compris le jeton SAS, pour accéder à la file d’attente Azure fournie par l’utilisateur pour la progression du travail de migration. Utilisez null si la réception des mises à jour de status d’importation n’est pas nécessaire.

Si cette valeur n’est pas nullet que le jeton SAS contient les autorisations appropriées, l’API de migration écrit l’importation status mises à jour dans la file d’attente à l’URL fournie.

Partagez la file d’attente de notification entre plusieurs travaux de migration. L’API de migration identifie chaque travail avec des valeurs d’ID de travail uniques dans la file d’attente de notification.

Consultez Azure pour obtenir des instructions sur l’utilisation de la file d’attente Azure dans la migration. Vérifiez les événements de migration dans la file d’attente Azure pour connaître les types d’événements.

Nécessite Adduniquement les autorisations , Readet Update . Si le jeton SAS dispose d’autres autorisations, le travail de migration ne peut pas ajouter d’événements à la file d’attente.

Valeur de retour CreateMigrationJob

N° du travail

Valeur Guid , qui contient l’ID du travail, identificateur unique du travail de migration. La méthode retourne une null valeur, si elle ne parvient pas à créer le travail. Utilisez l’ID de travail pour interroger la status des travaux de migration avec GetMigrationJobStatus la méthode .

Exemple

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

CreateMigrationJobEncrypted, méthode

Crée une tâche d’importation de migration avec un package PRIME chiffré.

Consultez les instructions de chiffrement dans Azure pour Stockage Blob Azure conteneur et le chiffrement de file d’attente Azure utilisés.

Syntaxe CreateMigrationJobEncrypted

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"
}

Paramètres CreateMigrationJobEncrypted

gWebIDLes paramètres , azureContainerSourceUri, azureContainerManifestUriet azureQueueReportUri ont les mêmes exigences que dans la CreateMigrationJob méthode .

Fournissez le EncryptionOption paramètre comme indiqué ci-dessous.

EncryptionOption

Obligatoire.

Objet EncryptionOption contenant la clé AES256CBCKey utilisée pour déchiffrer la sortie.

L’API de migration chiffre la sortie avec la clé AES256CBCKey fournie.

Pour plus d’informations, consultez [EncryptionOption](https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.encryptionoption) la classe .

Valeur de retour CreateMigrationJobEncrypted

Consultez Valeur de retour dans la CreateMigrationJob méthode.

Méthode GetMigrationJobStatus

Récupère le status de traitement d’un travail de migration désigné.

L’API de migration supprime les travaux de migration terminés de la file d’attente des travaux du minuteur. Vérifiez les résultats de l’importation dans la file d’attente de notification et/ou les sorties du journal.

Syntaxe GetMigrationJobStatus

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

Paramètres GetMigrationJobStatus

ID

Obligatoire.

Une valeur Guid , qui contient l’ID de travail de migration, est retournée à partir de CreateMigrationJob.

Valeur de retour GetMigrationJobStatus

Objet SPMigrationJobState , qui contient le status de la tâche de migration.

Exemple GetMigrationJobStatus

SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId);

SPMigrationJobState, énumération

Contient des membres représentant le status des travaux de migration dans la file d’attente d’importation.

Membres SPMigrationJobState

Aucune

Valeur : 0

La file d’attente ne contient pas le travail de migration avec l’ID de travail. Les raisons possibles sont les suivantes :

  • L’API de migration a terminé le travail et l’a supprimé de la file d’attente.
  • L’ID du travail n’est pas valide.

En file d’attente

Valeur : 2

La file d’attente contient le travail de migration. L’API de migration ne traite pas le travail.

Traitement

Valeur : 4

La file d’attente contient le travail de migration. L’API de migration traite le travail.