Criar e gerenciar contêineres

Aplica-se a: Desenvolvedor

Crie e gerencie contêineres depois que seu tipo de contêiner for criado, registrado e autorizado. Os contêineres são a unidade de armazenamento básica no SharePoint Embedded.

Concluir Configure a autenticação e a autorização antes de chamar as APIs de contêiner.

Entender os contêineres

Todos os arquivos e documentos incorporados do SharePoint são armazenados em contêineres.

Um contêiner:

  • Pertence a um locatário consumidor do Microsoft 365.
  • Tem uma ID de tipo de contêiner imutável.
  • Armazena conteúdo para seu aplicativo.
  • Define um limite para associação e permissões.
  • É acessado por meio do Microsoft Graph.

Para obter a visão geral da arquitetura, consulte Arquitetura de aplicativos do SharePoint Embedded.

Conheça o ciclo de vida

Um ciclo de vida típico de contêiner inclui:

  1. Crie um contêiner.
  2. Adicione ou confirme membros.
  3. Carregar e gerenciar arquivos.
  4. Leia ou atualize os metadados do contêiner.
  5. Recicle um contêiner quando ele não estiver mais ativo.
  6. Restaure um contêiner reciclado quando necessário.
  7. Exclua os contêineres permanentemente durante a limpeza.

Continue a Carregar, baixar e gerenciar arquivos para operações de conteúdo.

Pré-requisitos

Antes de criar contêineres, verifique se:

  • O tipo de contêiner existe.
  • O tipo de contêiner é registrado no locatário consumidor.
  • O aplicativo tem o consentimento do Microsoft Graph FileStorageContainer.Selected .
  • O aplicativo tem permissões de tipo de contêiner para a operação.
  • Para chamadas delegadas, o usuário conectado pode receber a função de contêiner necessária.
  • Para tipos de contêiner de avaliação, você está dentro dos limites de avaliação.

Importante

Os tipos de contêineres de teste podem criar até cinco contêineres, incluindo contêineres ativos e contêineres na lixeira.

Escolha a criação delegada ou somente aplicativo

Use o acesso delegado quando um usuário iniciar a criação, o usuário deverá ser responsável ou o usuário criador deverá se tornar o proprietário do contêiner.

Use o acesso somente ao aplicativo Quando um serviço provisiona contêineres, nenhum usuário está presente e o aplicativo tem permissão para criar contêineres.

Observação

Um usuário que cria um novo contêiner por meio de chamadas delegadas recebe automaticamente a função Proprietário.

Criar um contêiner

Use o Microsoft Graph para criar um contêiner de armazenamento de arquivos para seu tipo de contêiner registrado.

Para a forma de API canônica, consulte Criar fileStorageContainer.

Etapas de implementação:

  1. Adquira um token válido do Microsoft Graph.
  2. Inclua as informações de tipo de contêiner de destino exigidas pela API.
  3. Envie a solicitação de criação.
  4. Armazene a ID de contêiner retornada.
  5. Metadados de exibição da loja de que seu aplicativo precisa.
  6. Atribua ou confirme a associação para cenários delegados.

Dica

Armazene a ID do contêiner no banco de dados do aplicativo como o link durável entre o objeto de negócios e o contêiner do SharePoint Embedded.

Criar um contêiner no Visual Studio Code

Para o desenvolvimento de avaliação, a extensão do Visual Studio Code pode criar contêineres.

  1. Abra o modo de exibição do SharePoint Embedded.
  2. Expanda o tipo de contêiner de avaliação registrado.
  3. Clique com o botão direito do mouse em Contêineres.
  4. Selecione Criar contêiner.
  5. Insira um nome.
  6. Confirme se o contêiner aparece no tipo de contêiner.

Consulte Início Rápido: Criar seu primeiro aplicativo com VS Code para o fluxo de extensão.

Listar contêineres

Liste os contêineres para mostrar os contêineres disponíveis, validar o provisionamento ou executar a manutenção.

Para a forma de API canônica, consulte Listar contêineres.

Ao listar contêineres:

  • Use o acesso somente de aplicativo para cenários de inventário de serviços.
  • Use o acesso delegado somente quando o contexto do usuário for apropriado.
  • Lidar com paginação.
  • Mapeie os resultados para os dados do aplicativo.

Observação

Os contêineres da lista delegada atualmente retornam 403 Forbidden se o usuário não tiver um OneDrive. Essa dependência não se aplica a chamadas de lista somente aplicativo.

Obter um contêiner

Obtenha um contêiner quando precisar dos metadados mais recentes antes de agir.

Use esta operação para confirmar se o contêiner existe, ler propriedades de exibição, verificar o tipo de contêiner, marcar o estado antes das operações de arquivo e confirmar a restauração.

Vincule implementações ao tipo de recurso fileStorageContainer.

Atualizar metadados de contêiner

Atualize os metadados quando as propriedades com suporte forem alteradas.

Antes de atualizar:

  1. Confirme se o aplicativo tem permissão de tipo Write de contêiner.
  2. Confirme se o usuário delegado tem uma função apropriada.
  3. Leia o estado atual do contêiner.
  4. Aplicar somente as alterações pretendidas.
  5. Valide a resposta.

Excluir ou reciclar um contêiner

Recicle ou exclua um contêiner quando ele não estiver mais ativo.

Antes da exclusão:

  • Confirme se o chamador tem permissão.
  • Confirme se o aplicativo arquivou referências de negócios.
  • Decida se o recipiente deve ser reciclado primeiro.
  • Diga aos usuários como eles podem restaurar um contêiner reciclado.

A extensão do Visual Studio Code inclui recursos de reciclagem e recuperação para desenvolvimento de avaliação.

Restaurar um contêiner reciclado

Um fluxo de restauração deve:

  1. Identifique o recipiente reciclado.
  2. Confirme se o chamador tem permissão.
  3. Restaure o contêiner.
  4. Atualizar o estado do aplicativo.
  5. Confirme se os arquivos e metadados estão disponíveis.
  6. Notifique o usuário.

Importante

Para tipos de contêineres de teste, os contêineres na lixeira ainda contam para o limite de cinco contêineres.

Excluir contêineres permanentemente

Exclua permanentemente somente quando tiver certeza de que o contêiner não é mais necessário.

Você deve remover todos os contêineres de um tipo de contêiner, incluindo contêineres excluídos, antes de excluir o tipo de contêiner em si.

Use a exclusão permanente para limpeza de avaliação, remoção de dados de teste, desativação de um tipo de contêiner ou atendimento aos requisitos de ciclo de vida.

Validar operações de ciclo de vida

Crie um teste de fumaça:

  1. Crie um contêiner de teste.
  2. Recupere-o por ID.
  3. Liste os contêineres e confirme se aparece.
  4. Atualizar um valor de metadados com suporte.
  5. Carregue um arquivo pequeno.
  6. Recicle ou exclua o contêiner.
  7. Restaure-o se tiver suporte.
  8. Exclua-o permanentemente durante a limpeza.

Solucionar problemas de ciclo de vida

Sintoma Verificar
Falha na criação Registro e Create permissão.
Falha na criação delegada Consentimento do usuário e comportamento de atribuição de função.
Falha de lista para usuário delegado Dependência do OneDrive anotada no artigo de autenticação.
Falha na exclusão Delete permissão e a função de proprietário do usuário.
Falha na criação de teste Os recipientes ativos mais reciclados podem ter atingido o limite.
Falha na exclusão do tipo de contêiner Todos os contêineres ativos e excluídos devem ser removidos primeiro.

Próximas etapas

Adicionar operações de arquivo em Carregar, baixar e gerenciar arquivos.