Compartilhar via


Automatizar a instalação do aplicativo de modelo com o Azure

Automatize a instalação do aplicativo de modelo para simplificar o processo de implantação do Power BI para seus clientes. Os aplicativos de modelo fornecem relatórios predefinidos que se conectam aos dados do cliente, mas a configuração manual pode ser desafiadora para usuários que não estão familiarizados com os detalhes da conexão.

Este tutorial mostra aos provedores de serviços de dados como automatizar a configuração de parâmetro de aplicativo de modelo usando o Azure Functions. Quando os clientes clicam em um link pré-configurado, a automação coleta as informações necessárias, define parâmetros e os redireciona para instalar o aplicativo, exigindo apenas a autenticação para concluir a instalação.

Quando o cliente entra no portal, ele seleciona um link especial que você preparou. Este link:

  • Inicia a automação, que coleta as informações necessárias.
  • Pré-configura os parâmetros do aplicativo de modelo.
  • Redireciona o cliente para sua conta do Power BI, na qual ele pode instalar o aplicativo.

Tudo o que eles precisam fazer é selecionar Instalar, autenticar em sua fonte de dados e pronto para começar!

A experiência do cliente é ilustrada aqui.

Captura de tela da experiência do usuário com um aplicativo de instalação automática.

Neste tutorial, você usará um exemplo de instalação automatizada do Azure Functions que criamos para pré-configurar e instalar seu aplicativo de modelo. Este exemplo foi deliberadamente mantido simples para fins de demonstração. Ele encapsula a instalação de uma função do Azure para usar APIs do Power BI para instalar um aplicativo de modelo e configurá-lo automaticamente para seus usuários.

Para obter mais informações sobre o fluxo de automação geral e as APIs que o aplicativo usa, consulte Automatizar a configuração de uma instalação de aplicativo de modelo.

Nosso aplicativo simples usa uma função do Azure. Para obter mais informações sobre o Azure Functions, consulte a documentação do Azure Functions.

Fluxo básico

O fluxo básico a seguir lista o que o aplicativo faz quando o cliente o inicia selecionando o link em seu portal.

  1. O usuário entra no portal do ISV e seleciona o link fornecido. Essa ação inicia o fluxo. O portal do ISV prepara a configuração específica do usuário neste estágio.
  2. O ISV adquire um token somente de aplicativo com base em uma entidade de serviço (token somente de aplicativo) registrada no tenant do ISV.
  3. Usando APIs REST do Power BI, o ISV cria um tíquete de instalação, que contém a configuração de parâmetro específica do usuário, conforme preparado pelo ISV.
  4. O ISV redireciona o usuário para o Power BI usando um POST método de redirecionamento, que contém o ticket de instalação.
  5. O usuário é redirecionado para sua conta do Power BI com o ticket de instalação e é solicitado a instalar o app modelo. Quando o usuário seleciona Instalar, o aplicativo de modelo é instalado para ele.

Observação

Embora os valores de parâmetro sejam configurados pelo ISV no processo de criação do tíquete de instalação, as credenciais relacionadas à fonte de dados são fornecidas apenas pelo usuário nos estágios finais da instalação. Essa disposição impede que eles sejam expostos a terceiros e garante uma conexão segura entre o usuário e as fontes de dados do aplicativo de modelo.

Pré-requisitos

Configurar seu ambiente de desenvolvimento de automação

Antes de continuar configurando seu aplicativo, siga as instruções no Início Rápido: Criar um aplicativo do Azure Functions com a Configuração de Aplicativos do Azure para desenvolver uma função do Azure junto com uma configuração de aplicativo do Azure. Crie a configuração do aplicativo, conforme descrito no artigo.

Registre um aplicativo no Microsoft Entra ID

Crie um principal de serviço conforme descrito em Incorporar o conteúdo do Power BI com principal de serviço e um segredo de aplicativo.

Registre o aplicativo como um aplicativo Web do lado do servidor. Registre um aplicativo web no lado do servidor para criar um segredo de aplicativo.

Salve a ID do aplicativo (ClientID) e o segredo do aplicativo (ClientSecret) para etapas posteriores.

Adicione o principal de serviço à área de trabalho do aplicativo modelo como administrador, para poder testar seu fluxo de automação.

Preparação do aplicativo de modelo

Depois de criar seu aplicativo de modelo e ele estiver pronto para instalação, salve as seguintes informações para as próximas etapas:

Observação

Você pode testar seu aplicativo de instalação pré-configurado em seu aplicativo de modelo se o aplicativo de modelo estiver pronto para instalação, mesmo que ainda não esteja disponível publicamente no AppSource. Para que os usuários fora do locatário possam usar o aplicativo de instalação automatizado para instalar seu aplicativo de modelo, o aplicativo de modelo deve estar disponível publicamente no AppSource. Antes de distribuir seu aplicativo de modelo usando o aplicativo de instalação automatizado que você está criando, publique-o no Partner Center.

Instalar e configurar seu aplicativo de modelo

Nesta seção, você usará um exemplo de instalação automatizada do Azure Functions que criamos para pré-configurar e instalar seu aplicativo de modelo. Este exemplo foi deliberadamente mantido simples para fins de demonstração. Ele permite que você use uma função do Azure e a Configuração de Aplicativos do Azure para implantar e usar facilmente a API de instalação automatizada para seus aplicativos de modelo.

Baixar o Visual Studio

Baixe o Visual Studio (versão 2017 ou posterior). Certifique-se de baixar o pacote NuGet mais recente.

Baixar o exemplo de instalação automatizada do Azure Functions

Baixe o exemplo de instalação automatizada do Azure Functions do GitHub para começar.

Captura de tela do exemplo de instalação automatizada do Azure Functions.

Configurar sua configuração de aplicativo do Azure

Para executar este exemplo, você precisa configurar sua configuração de aplicativo do Azure com os valores e as chaves, conforme descrito aqui. As chaves são a ID do aplicativo, o segredo do aplicativo e os valores appId, packageKey e ownerId do aplicativo de modelo. Consulte as seções a seguir para obter informações sobre como obter esses valores.

As chaves também são definidas no arquivo Constants.cs .

Chave de configuração Meaning
TemplateAppInstall:Application:AppId appId da URL de instalação
TemplateAppInstall:Application:PackageKey packageKey da URL de instalação
TemplateAppInstall:Application:OwnerId ownerId da URL de instalação
TemplateAppInstall:ServicePrincipal:ClientId ID do aplicativo do principal de serviço
TemplateAppInstall:ServicePrincipal:ClientSecret Segredo do aplicativo da entidade de serviço

O arquivo Constants.cs é mostrado aqui.

Captura de tela do arquivo Constant.cs.

Obtenha as propriedades do aplicativo de modelo

Preencha todas as propriedades relevantes do aplicativo de modelo conforme elas são definidas quando o aplicativo é criado. Essas propriedades são os valores appId, packageKey e ownerId do aplicativo de modelo.

Para obter os valores anteriores, siga estas etapas:

  1. Entre no Power BI.

  2. Vá para o workspace original do aplicativo.

  3. Abra o painel Gerenciamento de Versão .

    Captura de tela do painel Gerenciamento de Versões.

  4. Selecione a versão do aplicativo e obtenha seu link de instalação.

    Captura de tela do botão Gerenciamento de Versões.

  5. Copie o link para a área de transferência.

    Captura de tela do botão Obter link.

  6. Essa URL de instalação contém os três parâmetros de URL cujos valores você precisa. Use os valores appId, packageKey e ownerId para o aplicativo. Uma URL de exemplo será semelhante ao mostrado aqui.

    https://app.powerbi.com/Redirect?action=InstallApp&appId=66667...9cccc0000&packageKey=b2df4b...dLpHIUnum2pr6k&ownerId=aaaa...22222&buildVersion=5
    

Obter a ID do aplicativo

Preencha a informação sobre o applicationId com a ID do aplicativo do Azure. O valor applicationId é usado pelo aplicativo para se identificar aos usuários dos quais você está solicitando permissões.

Para obter a ID do aplicativo, siga estas etapas:

  1. Entre no portal do Azure.

  2. No menu do portal, selecione Todos os serviços.

  3. Na página Todos os serviços, na seção Identidade , selecione >Registros de aplicativo.

  4. Selecione o aplicativo que precisa da ID do aplicativo.

    Captura de tela da escolha de um aplicativo que precisa da ID do aplicativo.

  5. Há uma ID do aplicativo listada como GUID. Use essa ID do aplicativo como o valor applicationId do aplicativo.

    Captura de tela do valor do ID do aplicativo.

Obter o segredo do aplicativo

Preencha as informações do ApplicationSecret na seção Chaves da seção Registros de aplicativo no Azure. Esse atributo funciona quando você usa o principal de serviço.

Para obter o segredo do aplicativo, siga estas etapas:

  1. Entre no portal do Azure.

  2. No menu do portal, selecione Todos os serviços.

  3. Na página Todos os serviços, na seção Identidade , selecione >Registros de aplicativo.

    Captura de tela da escolha de um aplicativo.

  4. Selecione Certificados e segredos em Gerenciar.

  5. Selecione Novo segredo do cliente.

  6. Insira um nome na caixa Descrição e selecione uma duração. Em seguida, selecione Adicionar para obter o valor do aplicativo, que você verá no título Valor do segredo do cliente.

Testar sua função localmente

Siga as etapas conforme descrito em Executar a função localmente para executar sua função.

Configure seu portal para emitir uma POST solicitação para a URL da função. Um exemplo é POST http://localhost:7071/api/install. O corpo da solicitação deve ser um objeto JSON que descreve pares chave-valor. Chaves são nomes de parâmetro conforme definido no Power BI Desktop. Os valores são os valores desejados a serem definidos para cada parâmetro no aplicativo de modelo.

Observação

Em produção, os valores de parâmetro são determinados para cada usuário pela lógica definida do portal.

O fluxo desejado deve ser:

  1. O portal prepara a solicitação, por usuário ou sessão.
  2. A POST /api/install solicitação é emitida para sua função do Azure. O corpo da solicitação consiste em pares chave-valor. A chave é o nome do parâmetro. O valor é o valor desejado a ser definido.
  3. Se tudo estiver configurado corretamente, o navegador deverá redirecionar automaticamente para a conta do Power BI do cliente e mostrar o fluxo de instalação automatizado.
  4. Após a instalação, os valores de parâmetro são definidos como configurados nas etapas 1 e 2.

Publicar seu projeto no Azure

Para publicar seu projeto no Azure, siga as instruções na documentação do Azure Functions. Em seguida, você pode integrar as APIs de instalação automatizada de aplicativos modelo ao seu produto e começar seus testes em ambientes de produção.