Preparar seu aplicativo para instalação do cliente

Aplica-se a: ISV

Use este artigo antes de enviar um aplicativo do SharePoint Embedded para um locatário do cliente. O SharePoint Embedded é somente API, portanto, a instalação do cliente depende do registro do tipo de contêiner, do consentimento, das permissões e da configuração de cobrança, em vez de uma implantação tradicional do site do SharePoint. Seu objetivo é fornecer ao administrador do cliente um pacote de integração completo e repetível.

Fluxo de instalação do cliente

Um aplicativo do SharePoint Embedded pronto para o cliente geralmente segue esta sequência:

1. Escolha o modelo de aplicativo e o modelo de locatário para seu produto.
2. Registre ou configure o aplicativo proprietário em seu locatário de desenvolvedor.
3. Crie um tipo de contêiner de produção padrão para o aplicativo proprietário.
4. Escolha a cobrança padrão ou a cobrança de passagem para o tipo de contêiner.
5. Preparar as informações de consentimento do Microsoft Entra para o administrador do cliente.
6. Forneça instruções de configuração do locatário do cliente.
7. Peça ao cliente para concluir o registro do tipo de contêiner, o consentimento do administrador e a configuração de cobrança quando necessário.
8. Valide se o aplicativo pode criar e usar contêineres no locatário consumidor.

Para a próxima decisão no caminho de publicação, consulte Escolher um modelo de cobrança para seu aplicativo.

Pré-requisitos

Antes de preparar os materiais de instalação do cliente, confirme os itens a seguir em seu locatário de desenvolvedor.

Entender a responsabilidade do desenvolvedor

O desenvolvedor gerencia o aplicativo SharePoint Embedded e os tipos de contêiner que o apoiam. Um tipo de contêiner define a relação entre um aplicativo do SharePoint Embedded e os contêineres que armazenam conteúdo. Cada tipo de contêiner está associado a um aplicativo proprietário. O aplicativo proprietário tem acesso total padrão aos contêineres desse tipo.

Os desenvolvedores podem usar a extensão do Visual Studio Code Embedded do SharePoint ou as APIs do Microsoft Graph fileStorageContainerType para criar, listar, atualizar e excluir tipos de contêiner. A criação do Graph é somente delegada e não requer função de administrador. Para obter detalhes, consulte Criar e configurar um tipo de contêiner.

Para decisões de modelo e locatário, consulte Escolher um modelo de aplicativo.

Empacotar a configuração do aplicativo

Forneça aos clientes os identificadores e URLs exatos de que precisam para examinar e aprovar o aplicativo. Não peça a um administrador do cliente para inferir esses valores do código.

Inclua as seguintes informações em seu pacote de instalação:

• Nome do produto e nome do editor.
• ID do aplicativo proprietário.
• ID do tipo de contêiner, depois de criada.
• Nome do tipo de contêiner.
• Modelo de cobrança: padrão ou passagem.
• URL de redirecionamento do aplicativo, se configurado no tipo de contêiner.
• URL de entrada voltada para o cliente.
• URL de suporte voltada para o cliente.
• Lista de permissões do Microsoft Entra solicitadas pelo aplicativo.
• Se o aplicativo usa permissões delegadas, permissões de aplicativo ou ambas.
• Se um aplicativo convidado requer acesso ao aplicativo proprietário.
• Residência de dados, retenção e limites de suporte para seu aplicativo.
• Etapas de validação que o cliente pode executar após a instalação.

Confirmar a relação do tipo de aplicativo proprietário e contêiner

Cada tipo de contêiner de produção deve ter um aplicativo proprietário. Um único aplicativo proprietário pode possuir apenas um tipo de contêiner por vez. Não reutilize um aplicativo proprietário em vários tipos de contêiner de produção. Se você precisar de vários limites de isolamento ou cobrança, planeje aplicativos proprietários e tipos de contêiner separados.

Crie o tipo de contêiner de produção com a extensão do Visual Studio Code Incorporada ao SharePoint ou com a API de criação do arquivo fileStorageContainerType. A criação do Microsoft Graph é somente delegada e não requer uma função de administrador.

Configurar um tipo de contêiner de produção

Crie um tipo de contêiner padrão para uso do cliente. O SharePoint Embedded dá suporte a duas opções de cobrança de produção:

• Cobrança Standard, em que o locatário do desenvolvedor é cobrado.
• Cobrança de passagem, em que o locatário consumidor é cobrado após o registro e a configuração.

Para cobrança padrão, o desenvolvedor deve fornecer uma assinatura do Azure, grupo de recursos e região ao anexar informações de cobrança. Para a cobrança de passagem, o desenvolvedor cria o tipo de contêiner com a cobrança de passagem habilitada e, posteriormente, o administrador do cliente configura a cobrança no locatário consumidor.

Decidir o que o cliente deve fazer

A entrega do cliente deve separar claramente as tarefas do ISV das tarefas do administrador do cliente.

Tarefas do ISV

Conclua estas tarefas antes que o cliente inicie a instalação:

1. Crie ou configure o aplicativo proprietário do Microsoft Entra.
2. Crie o tipo de contêiner de produção.
3. Defina as configurações de tipo de contêiner que se aplicam a todos os contêineres.
4. Documente os requisitos de consentimento do Microsoft Entra.
5. Documente se a cobrança de passagem é necessária.
6. Prepare a lista de verificação de validação.
7. Forneça contatos de escalonamento para falhas de instalação.

Tarefas de administração do cliente

Peça ao administrador do cliente para concluir estas tarefas em seu locatário:

1. Revise a documentação do editor do aplicativo, as permissões e o tratamento de dados.
2. Conceda consentimento do administrador quando necessário.
3. Registre o tipo de contêiner no locatário consumidor por meio do fluxo de registro do aplicativo.
4. Configure a cobrança se o aplicativo usar a cobrança de passagem.
5. Valide se o aplicativo aparece nas experiências de administração de locatário.
6. Confirme se os contêineres podem ser criados e gerenciados.

Para obter as etapas voltadas para o cliente, consulte Orientar os clientes durante a configuração do locatário.

Preparar diretrizes de permissão

Documente as permissões que seu aplicativo solicita e por que cada permissão é necessária. Use descrições específicas do produto em vez de copiar nomes de exibição de permissão sem contexto.

No mínimo, um aplicativo incorporado do SharePoint instalado em um locatário consumidor solicita estas permissões do Microsoft Graph:

Para aplicativos de locatário único, você pode criar uma URL de consentimento do administrador e fornecê-la ao administrador do Microsoft Entra do locatário, por exemplo:

https://login.microsoftonline.com/{tenant}/v2.0/adminconsent?client_id={client_id}&redirect_uri={redirect_uri}

Verifique se o URI de redirecionamento do aplicativo pode lidar com fluxos de consentimento do administrador. Para obter o modelo de permissão total, consulte Autenticação e autorização.

Se o aplicativo usar o acesso ao aplicativo convidado, explique como o administrador do locatário consumidor pode exibir as permissões do aplicativo convidado nas ferramentas administrativas.

Preparar diretrizes de cobrança

Informe aos clientes qual modelo de cobrança se aplica antes que eles instalem o aplicativo.

Para cobrança padrão:

• Explique que o locatário do desenvolvedor é proprietário da relação de cobrança de consumo do SharePoint Embedded.
• Informe ao cliente se o uso do SharePoint Embedded está incluído em seu contrato comercial.
• Confirme se o cliente não precisa configurar uma assinatura do Azure para cobrança do SharePoint Embedded.

Para cobrança de repasse:

• Explique que os encargos de consumo são cobrados do locatário consumidor.
• Informe ao cliente que nenhum usuário pode acessar aplicativos incorporados do SharePoint de passagem até que a cobrança válida seja configurada.
• Envie o cliente para Orientar os clientes pela configuração do locatário e Instalar um aplicativo Incorporado do SharePoint.

Preparar materiais de entrega do administrador

Crie um pacote de entrega de administração conciso que inclua:

• Visão geral da instalação.
• Informações de fornecedor e identidade do aplicativo.
• Resumo de segurança e conformidade.
• Resumo do modelo de cobrança.
• Etapas de consentimento do Microsoft Entra.
• Etapas de configuração do locatário.
• Lista de verificação de validação.
• Diretrizes de reversão ou desinstalação.
• Contatos de suporte e tempos de resposta esperados.

Mantenha a entrega específica para um produto e um tipo de contêiner. Se você publicar vários produtos, forneça uma entrega separada para cada aplicativo.

Fornecer uma lista de verificação de validação

Inclua uma lista de verificação que o cliente possa concluir com você após a instalação:

• O administrador do cliente pode identificar o aplicativo SharePoint Embedded no locatário.
• O administrador do cliente concedeu o consentimento esperado.
• A cobrança de repassagem é habilitada quando necessário.
• O aplicativo pode criar um contêiner de teste.
• O aplicativo pode carregar, ler e excluir conteúdo de teste.
• O administrador do cliente pode exibir os detalhes do contêiner.
• O comportamento de compartilhamento externo corresponde à política do cliente.
• Os dados de teste são removidos após a validação.

Para obter uma validação detalhada, consulte Validar instalação de aplicativo do cliente.

Próximas etapas

Escolha a opção de cobrança correta antes de enviar instruções de instalação a um cliente: Escolha um modelo de cobrança para seu aplicativo.