Compartilhar via

Guia de Referência da API de Leitura de Metadados Assíncronos do SharePoint (AMR)

Utilize este documento como guia ao utilizar a API de Leitura (AMR) de Metadados Assíncronos do SharePoint.

A API AMR agrega metadados do SharePoint num pacote de manifesto. Utilize o pacote para migração incremental, criação de estrutura, validação pós-migração ou gestão de permissões.

CSOM e REST

A API AMR suporta o Modelo de Objeto 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.

CreateSPAsyncReadJob method (Método CreateSPAsyncReadJob)

Cria uma tarefa de AMR para ler todos os metadados do URL do SharePoint especificado e os respetivos subordinados no contentor de manifesto especificado.

Sintaxe CreateSPAsyncReadJob

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

Parâmetros CreateSPAsyncReadJob

url

Obrigatório.

Um valor de Cadeia que contém o URL de caminho completo do caminho da Lista do SharePoint, ficheiros/pastas ou Biblioteca de Documentos a ler. A API AMR devolve todos os metadados de ficheiros, pastas e objetos de raiz, incluindo subpastas e qualquer conteúdo subordinado.

Exemplo

Este exemplo url devolve todos os metadados do Documento Partilhado e os respetivos subordinados:

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

readOptions

Obrigatório.

Uma SPAsyncReadOptions estrutura, com readOption valores que especificam os tipos de metadados a ler.

IncludeVersions

Opcional.

Um valor Bool para indicar se a API AMR lê várias versões de ficheiros e Itens de Lista.

O valor padrão é false. Quando estiver ausente ou definido como , a falseAPI AMR só lê a versão mais recente dos itens.

IncludeSecurity

Opcional.

Um valor Bool para indicar se a API AMR lê informações de Utilizadores e Grupos relacionadas com um Site.

O valor padrão é false.

A API AMR lê Utilizadores e Grupos como Autores ou Modificadores como parte dos metadados dos objetos.

Se estiver definida como , a trueAPI AMR lê todos os Utilizadores nas Coleções de Sites. Ao ler múltiplas Bibliotecas de Documentos na mesma Coleção de Sites, os mesmos Utilizadores e Grupo podem aparecer no pacote de leitura várias vezes.

IncludeDirectDescendantsOnly

Opcional.

Um valor Bool para indicar se a API AMR lê apenas os metadados dos descendentes diretos.

O valor padrão é false.

Se definida como , a trueAPI AMR lê apenas os metadados dos descendentes diretos.

Utilize-o readOption juntamente com IncludeSecurityreadOption para melhorar o desempenho ao ler metadados de uma Biblioteca de Documentos com um grande número de itens, conforme descrito em Melhores práticas para evitar um desempenho lento.

IncludeExtendedMetadata

Opcional.

O valor padrão é false.

Quando definida como , a falseAPI AMR lê metadados básicos:

  • Listar
  • Pasta
  • Arquivo
  • Item de Lista
  • Funções
  • Atribuições de Funções

Quando definida como , a trueAPI AMR lê todos os metadados disponíveis:

Para Ficheiros:

  • Web Part
  • Personalização de Peças Web
  • Links
  • Eventos de versão
  • Receptores de eventos
  • Metadados de anexo

Para Listas:

  • Ações personalizadas
  • Listar atalhos

Para Itens de Lista:

  • Comments
  • Ligações de conjunto de documentos
  • Atividades
  • Atalhos de Item de Lista

A inclusão de metadados expandidos diminui significativamente a leitura. Para migrações de partilhas de ficheiros, mantenha o valor falsepredefinido . Definido como true apenas quando necessário, para projetos de migração complexos.

IncludePermission

Opcional.

Um valor Bool para indicar se as permissões de leitura são necessárias. O valor padrão é false.

Quando definida como , a trueAPI AMR lê metadados de permissão em RoleAssignments etiquetas em Manifest.xml ficheiros. O ficheiro inclui todos os metadados de permissão distintos para cada objeto do SharePoint lido, juntamente com a propriedade ScopeId.

StartChangeToken

Opcional.

Um valor inteiro que contém o item changeToken.

Por predefinição, quando não StartChangeToken é fornecido nenhum, CreateSPAsyncReadJob o método devolve todos os itens disponíveis, com base nos parâmetros. É CurrentChangeToken sempre devolvido um valor.

Para ler apenas os itens que foram alterados desde a última leitura, defina um StartChangeToken em chamadas subsequentes para CreateSPAsyncReadJob. Utilize CurrentChangeToken devolvido da última chamada como o valor de StartChangeToken.

A API AMR devolve um erro e para a leitura, se receber um valor inválido StartChangeToken .

Tenha cuidado ao utilizar esta funcionalidade com um grande número de itens. A tarefa de leitura pode ser executada durante uma duração prolongada. A API AMR cancela tarefas que são executadas ao longo de 10 minutos para proteger a infraestrutura do SharePoint.

encryptionOption

Opcional.

Um EncryptionOption objeto que contém a Chave AES-256-CBC utilizada para desencriptar a saída.

Por predefinição, a API AMR não encripta a saída e a fila de eventos. Se definida com a Chave AES-256-CBC, a API AMR encripta a saída com a chave fornecida.

Consulte a EncryptionOption classe para obter detalhes.

azureContainerManifestUri

Obrigatório.

Um valor de Cadeia , que é o URL de destino do Contentor de Armazenamento de Blobs do Azure que contém o pacote de manifesto de saída.

Veja Azure para obter instruções sobre como utilizar o Contentor de Armazenamento de Blobs do Azure na migração.

azureQueueReportUri

Obrigatório.

Um valor de Cadeia , que é o URL da Fila do Azure para receber mensagens de estado de leitura.

Partilhe azureQueueReportUri entre diferentes tarefas, se necessário. A API AMR regressa JobID para identificar tarefas individuais criadas.

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.

CreateSPAsyncReadJob devolve valores

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.

A API AMR gera um JobEnd evento quando estima a contagem de itens para cada url. Consulte Eventos para obter detalhes.

AzureContainerManifest

Um valor URI que contém o URL para aceder ao Contentor de Armazenamento de Blobs do Azure, que contém os metadados lidos.

JobQueueUri

Um valor URI que contém o URL da Fila do Azure utilizada para o estado de leitura.

EncryptionKey

Um valor de Matriz de Bytes que contém a Chave AES-256-CBC para desencriptar os ficheiros de manifesto e as mensagens na Fila do Azure.

CreateSPAsyncReadJobWithMultiUrl method (Método CreateSPAsyncReadJobWithMultiUrl)

Cria uma tarefa amr para ler todos os metadados de todos os URLs do SharePoint especificados e os respetivos subordinados no contentor de manifesto especificado.

Sintaxe CreateSPAsyncReadJobWithMultiUrl

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

Parâmetros CreateSPAsyncReadJobWithMultiUrl

Veja o CreateSPAsyncReadJob método para obter detalhes de readOptions, encryptionOption, azureContainerManifestUrie azureQueueReportUri.

URLs

Obrigatório.

Uma Matrizde Uri que contém os URLs de caminho completo dos caminhos raiz das Listas, ficheiros/pastas do SharePoint ou Bibliotecas de Documentos a ler. A API AMR devolve todos os metadados de ficheiros, pastas e objetos de raiz, incluindo subpastas e qualquer conteúdo subordinado.

Especifique vários URLs quando necessário. A chamada agravada com vários URLs pode melhorar o desempenho. Veja Desempenho para obter detalhes.

Erros

-2146232832

O changeToken refere-se a uma hora antes do início do registo de alterações atual.

O registo de alterações está limitado a 60 dias imediatamente antes da data atual. A API AMR devolve este código de erro quando o especificado changeToken se refere a uma hora fora da janela de 60 dias.

-2147213196

Operação cancelada.

A API AMR recebeu um pedido de cancelamento do cliente e cancela a operação de leitura.

  • Last updated on