Compartilhar via

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

  • Artigo

Este guia descreve o uso da API de Migração do SharePoint, que importa conteúdo para o SharePoint, com base em arquivos de manifesto.

CSOM e REST

A API de Migração dá suporte ao CSOM (Modelo de Objeto Lateral do Cliente) do SharePoint e ao REST.

Usar pacotes NuGet com CSOM

Para fazer referência ao CSOM (Modelo de Objeto Lateral do Cliente) do SharePoint em sua solução, use pacotes NuGet.

Gerencie as dependências facilmente e verifique se sua solução está usando a versão mais recente da biblioteca CSOM com pacotes NuGet.

Obtenha a versão mais recente do pacote CSOM nas Bibliotecas de Modelo de Objeto do lado do cliente do SharePoint com a ID Microsoft.SharePointOnline.CSOM.

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

Método CreateMigrationJob

Cria um novo trabalho 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 String que contém o identificador exclusivo da Web de destino direcionada para a importação do pacote. O pacote de importação em si especifica informações e identificadores adicionais para a importação. Você pode encontrar esse identificador programaticamente consultando a Web de destino usando chamadas CSOM.

azureContainerSourceUri

Obrigatório.

Um valor String que contém o URI válido, incluindo o token SAS, para acessar o contêiner Armazenamento de Blobs do Azure que contém os arquivos binários do bloco de tipo.

Consulte Usar contêineres Armazenamento de Blobs do Azure e filas do Azure com a API de Migração do SharePoint para obter instruções sobre como usar contêineres Armazenamento de Blobs do Azure na migração.

Ao usar contêineres de conteúdo não fornecidos por esse método, a API de Migração requer Read, e List somente permissões. Verifique se a hora de início do token SAS é definida em ou antes do envio do trabalho. Além disso, ao definir o tempo de expiração, permita uma duração razoável para que o processo de importação seja concluído.

A API de migração não requer List permissão de contêineres provisionados com ProvisionMigrationContainers o método.

azureContainerManifestUri

Obrigatório.

Um valor String que contém o URI válido, incluindo o token SAS, para acessar o contêiner Armazenamento de Blobs do Azure, que contém os blobs de bloco para o manifesto e outros pacotes que descrevem arquivos XML. A API de Migração grava log neste contêiner. Esse contêiner não pode ser o mesmo usado para o azureContainerSourceUri.

Consulte Usar contêineres Armazenamento de Blobs do Azure e filas do Azure com a API de Migração do SharePoint para obter instruções sobre como usar contêineres Armazenamento de Blobs do Azure na migração.

Ao usar contêineres de conteúdo não fornecidos por esse método, a API de ReadMigração requer , Liste Write somente permissões. Verifique se a hora de início do token SAS é definida em ou antes do envio do trabalho. Além disso, ao definir o tempo de expiração, permita uma duração razoável para que o processo de importação seja concluído.

azureQueueReportUri

Opcional.

Um valor String que contém a URL válida, incluindo o token SAS, para acessar a Fila do Azure fornecida pelo usuário para o progresso do trabalho de migração. Use null se não for necessário receber atualizações de importação status.

Se esse valor não nullfor , e o token SAS contiver as permissões corretas, a API de Migração gravará a importação status atualizações para a fila na URL fornecida.

Compartilhe a fila de notificação entre vários trabalhos de migração. A API de migração identifica cada trabalho com valores exclusivos de ID do trabalho na fila de notificação.

Consulte o Azure para obter instruções sobre como usar a Fila do Azure na migração. Verifique eventos de migração na Fila do Azure em busca de tipos de eventos.

AddReadRequer , e Update somente permissões. Se o token SAS tiver outras permissões, o trabalho de migração não poderá adicionar eventos à fila.

Valor de retorno CreateMigrationJob

ID do Trabalho

Um valor Guid , que contém a ID do Trabalho, o identificador exclusivo do trabalho de migração. O método retornará um null valor, se não conseguir criar o trabalho. Use a ID do Trabalho para consultar o status de trabalhos de migração com GetMigrationJobStatus o método.

Exemplo

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

Método CreateMigrationJobEncrypted

Cria um novo trabalho de importação de migração com um pacote PRIME criptografado.

Verifique as instruções de criptografia no Azure para Armazenamento de Blobs do Azure criptografia de contêiner e fila do Azure usada.

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

gWebID, azureContainerSourceUri, azureContainerManifestUrie azureQueueReportUri os parâmetros têm os mesmos requisitos que no CreateMigrationJob método.

Forneça EncryptionOption o parâmetro conforme instruído abaixo.

Encryptionoption

Obrigatório.

Um EncryptionOption objeto que contém o AES256CBCKey usado para descriptografar a saída.

A API de migração criptografa a saída com a chave AES256CBCKey fornecida.

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

Valor de retorno CreateMigrationJobEncrypted

Consulte Retornar valor no CreateMigrationJob método.

Método GetMigrationJobStatus

Recupera o status de processamento de um trabalho de migração designado.

A API de migração remove trabalhos de migração concluídos da fila de trabalho do temporizador. Verifique a fila de notificação e/ou saídas de log para obter resultados de importação.

Sintaxe GetMigrationJobStatus

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

Parâmetros GetMigrationJobStatus

ID

Obrigatório.

Um valor Guid , que contém a ID do trabalho de migração, é retornado de CreateMigrationJob.

Valor retornado GetMigrationJobStatus

Um SPMigrationJobState objeto, que contém o status do trabalho de migração.

Exemplo GetMigrationJobStatus

SPMigrationJobState CurrentJobState = TargetSite.GetMigrationJobStatus(MigrationJobId);

Enumeração SPMigrationJobState

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

Membros do SPMigrationJobState

Nenhum

Valor: 0

A fila não contém o trabalho de migração com a ID do trabalho. Os possíveis motivos são:

  • A API de migração concluiu o trabalho e o removeu da fila.
  • A ID do trabalho é inválida.

Na fila

Valor: 2

A fila contém o trabalho de migração. A API de migração não está processando o trabalho.

Processamento

Valor: 4

A fila contém o trabalho de migração. A API de migração está processando o trabalho.