Compartilhar via

Guia de Referência da API de Migração do SharePoint

Este guia descreve a utilização da API de Migração do SharePoint, que importa conteúdos para o SharePoint, com base em ficheiros de manifesto.

CSOM e REST

A API de Migração suporta o Modelo de Objetos do Lado do Cliente do SharePoint (CSOM) e o REST.

Utilizar Pacotes NuGet com CSOM

Para referenciar o Modelo de Objetos do Lado do Cliente do SharePoint (CSOM) na sua solução, utilize pacotes NuGet.

Faça a gestão de dependências facilmente e certifique-se de que a sua solução está a utilizar a versão mais recente da biblioteca CSOM com pacotes NuGet.

Obtenha a versão mais recente do pacote CSOM nas Bibliotecas de Modelos de Objetos do Lado do Cliente do SharePoint com o ID Microsoft.SharePointOnline.CSOM.

Consulte Conhecer o serviço REST do SharePoint para obter instruções sobre a API REST.

CreateMigrationJob method (Método CreateMigrationJob)

Cria uma nova tarefa de importação de migração com o pacote de importação especificado no azureContainerSourceUri parâmetro .

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

Parâmetros CreateMigrationJob

gWebID

Obrigatório.

Um valor de Cadeia que contém o identificador exclusivo da Web de destino direcionada para a importação do pacote. O próprio pacote de importação especifica informações e identificadores adicionais para a importação. Pode encontrar este identificador através de programação ao consultar a Web de destino através de chamadas CSOM.

azureContainerSourceUri

Obrigatório.

Um valor de Cadeia que contém o URI válido, incluindo o token de SAS, para aceder ao contentor de Armazenamento de Blobs do Azure que contém os ficheiros binários do bloco de tipo.

Veja Utilizar Contentores do Armazenamento de Blobs do Azure e o Azure Filas com a API de Migração do SharePoint para obter instruções sobre como utilizar Armazenamento de Blobs do Azure Contentores na migração.

Ao utilizar contentores de conteúdos não fornecidos por este método, a API de Migração requer Readapenas permissões e List . Certifique-se de que a hora de início do token de SAS está definida em ou antes da submissão da tarefa. Além disso, ao definir o tempo de expiração, permita uma duração razoável para a conclusão do processo de importação.

A API de Migração não requer List permissão de contentores aprovisionados com ProvisionMigrationContainers o método .

azureContainerManifestUri

Obrigatório.

Um valor de Cadeia que contém o URI válido, incluindo o token de SAS, para aceder ao Contentor de Armazenamento de Blobs do Azure, que contém os blobs de blocos para o manifesto e outros pacotes que descrevem ficheiros XML. A API de Migração escreve o registo neste contentor. Este contentor não pode ser o mesmo que o utilizado para o azureContainerSourceUri.

Veja Utilizar Contentores do Armazenamento de Blobs do Azure e o Azure Filas com a API de Migração do SharePoint para obter instruções sobre como utilizar Armazenamento de Blobs do Azure Contentores na migração.

Ao utilizar contentores de conteúdos não fornecidos por este método, a API de Migração requer Readapenas , Liste Write permissões. Certifique-se de que a hora de início do token de SAS está definida em ou antes da submissão da tarefa. Além disso, ao definir o tempo de expiração, permita uma duração razoável para a conclusão do processo de importação.

azureQueueReportUri

Opcional.

Um valor de Cadeia que contém o URL válido, incluindo o token de SAS, para aceder à Fila do Azure fornecida pelo utilizador para o progresso da tarefa de migração. Utilize null se não for necessário receber status atualizações de importação.

Se este valor não nullfor e o token de SAS contiver as permissões corretas, a API de Migração escreve a importação status atualizações para a fila no URL fornecido.

Partilhe a fila de notificação entre várias tarefas de migração. A API de Migração identifica cada tarefa com valores de ID de Tarefa exclusivos na fila de notificação.

Veja Azure para obter instruções sobre como utilizar a Fila do Azure na migração. Verifique os eventos de Migração na Fila do Azure quanto a tipos de eventos.

Add ReadRequer apenas , e Update permissões. Se o token de SAS tiver outras permissões, a tarefa de migração não poderá adicionar eventos à fila.

Valor devolvido de CreateMigrationJob

ID do Trabalho

Um valor guid , que contém o ID da Tarefa, o identificador exclusivo da tarefa de migração. O método devolve um null valor, se não conseguir criar a tarefa. Utilize o ID da Tarefa para consultar a status de tarefas de migração com GetMigrationJobStatus o método .

Exemplo

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

CreateMigrationJobEncrypted method (Método CreateMigrationJobEncrypted)

Cria uma nova tarefa de importação de migração com um pacote PRIME encriptado.

Verifique as instruções de encriptação no Azure para Armazenamento de Blobs do Azure Contentor e a encriptação de Fila do Azure utilizadas.

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

Parâmetros CreateMigrationJobEncrypted

gWebIDos parâmetros , , azureContainerSourceUriazureContainerManifestUrie azureQueueReportUri têm os mesmos requisitos que no CreateMigrationJob método .

Indique o EncryptionOption parâmetro conforme indicado abaixo.

EncryptionOption

Obrigatório.

Um EncryptionOption objeto que contém a AES256CBCKey utilizada para desencriptar a saída.

A API de Migração encripta a saída com a chave AES256CBCKey fornecida.

Consulte a [EncryptionOption](https://learn.microsoft.com/en-us/dotnet/api/microsoft.sharepoint.client.encryptionoption) classe para obter detalhes.

Valor devolvido createMigrationJobEncrypted

Veja Devolver valor no CreateMigrationJob método .

GetMigrationJobStatus method (Método GetMigrationJobStatus)

Importante

Utilize a API GetMigrationJobProgress para obter a tarefa de migração status. A descontinuação da API GetMigrationJobStatus está prevista para o segundo semestre de 2026. Até lá, permanecerá disponível para status obtenção.

Obtém o status de processamento para uma tarefa de migração designada.

A API de Migração remove as tarefas de migração concluídas da fila de tarefas de temporizador. Verifique as saídas da fila de notificação e/ou do registo para obter os resultados da importação.

Sintaxe GetMigrationJobStatus

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

Parâmetros GetMigrationJobStatus

ID

Obrigatório.

Um valor guid , que contém o ID da Tarefa de migração, é devolvido a partir de CreateMigrationJob.

Valor devolvido de GetMigrationJobStatus

Um SPMigrationJobState objeto, que contém a status da tarefa de migração.

Exemplo de GetMigrationJobStatus

SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId);

Enumeração SPMigrationJobState

Contém membros que representam a status das tarefas de migração na fila de importação.

Membros SPMigrationJobState

Nenhum

Valor: 0

A fila não contém a tarefa de migração com o ID da Tarefa. As possíveis razões são:

  • A API de Migração concluiu a tarefa e removeu-a da fila.
  • O ID da Tarefa é inválido.

Na fila

Valor: 2

A fila contém a tarefa de migração. A API de Migração não está a processar a tarefa.

Processamento

Valor: 4

A fila contém a tarefa de migração. A API de Migração está a processar a tarefa.

  • Last updated on