Usando as APIs REST do Power BI
As APIs REST do Power BI fornecem pontos de extremidade de serviço para inserção, administração, governança e recursos de usuário.
Com as APIs REST do Power BI, você pode fazer o seguinte:
Gerenciar conteúdo do Power BI
Executar operações de administrador
Inserir conteúdo do Power BI
Observação
Algumas das APIs do Power BI referem-se a workspaces como grupos. Qualquer referência a grupos significa que você está trabalhando com workspaces.
Ao acessar a API REST do Power BI, o conteúdo e os dados de solicitação e resposta podem ser processados por data centers em regiões diferentes da região inicial do locatário do Power BI.
Escopos
Para usar as APIs REST do Power BI, você precisa registrar um aplicativo do Azure Active Directory (Azure AD) no Azure. O aplicativo do Azure AD estabelece permissões para os recursos REST do Power BI e permite o acesso às APIs REST do Power BI. Para saber como registrar um aplicativo, consulte Registrar um aplicativo Azure AD a ser usado com o Power BI.
Depois de registrar um aplicativo Azure AD, você pode se autenticar nele usando o Azure AD (v1.0; ADAL) ou o plataforma de identidade da Microsoft (v2.0; Pontos de extremidade MSAL). Para saber mais sobre como esses métodos de autenticação funcionam, consulte Por que atualizar para plataforma de identidade da Microsoft (v2.0)?
Para obter mais informações sobre permissões de acesso do Power BI, consulte Permissões e consentimento no ponto de extremidade da plataforma de identidade da Microsoft.
Usando uma entidade de serviço
Os escopos não serão necessários se você estiver usando uma entidade de serviço. Depois de habilitar uma entidade de serviço a ser usada com o Power BI, as permissões do AD do aplicativo não entrarão mais em vigor. Ao usar uma entidade de serviço, as permissões do aplicativo são gerenciadas por meio do portal de administração do Power BI. Para obter mais informações, consulte Habilitar as configurações de administrador do serviço do Power BI.
Adicionando escopos
Para adicionar permissões ao aplicativo Azure AD, siga estas etapas:
Abra seu aplicativo no Azure.
À esquerda, em Gerenciar, selecione Permissões de API.
Selecione Adicionar uma permissão.
Na janela Solicitar permissões de API , selecione Serviço do Power BI.
Selecione Permissões delegadas. Uma lista de APIs é exibida.
Expanda a API à qual você deseja adicionar permissões e selecione as permissões que deseja adicionar a ela.
Selecione Adicionar Permissões.
Removendo escopos
Para remover permissões de seu aplicativo Azure AD, siga estas etapas:
Abra seu aplicativo no Azure.
À esquerda, em Gerenciar, selecione Permissões de API.
Selecione o menu Contexto (reticências de permissão).
Selecione Remover permissão.
Limitação
O Power BI usa a limitação para manter o desempenho e a confiabilidade ideais. Para evitar o uso excessivo de recursos de usuários únicos, o Power BI limita o número de chamadas à API em uma janela de tempo por usuário.
Quando um usuário envia várias solicitações que excedem um limite predeterminado durante uma janela de tempo, o Power BI limita as solicitações adicionais desse usuário por um curto período.
Quando os aplicativos experimentam limitação, o Power BI retorna um código HTTP status 429 (muitas solicitações) com um cabeçalho HTTP Retry-After na resposta, indicando quantos segundos o aplicativo de chamada precisa aguardar antes de fazer uma nova solicitação.
Grupos de operações REST
Esta tabela lista os grupos de operações da API REST do Power BI.
Observação
Para gerenciar Power BI Embedded capacidades, use as APIs REST do Power BI Embedded Azure Resource Manager.
| Grupo de operações | Descrição |
|---|---|
| Administrador | Operações para trabalhar com tarefas administrativas. |
| Aplicativos | Operações para trabalhar com aplicativos. |
| Recursos disponíveis | Operações que retornam recursos disponíveis. |
| Capacidades | Operações para trabalhar com capacidades. |
| Dashboards | Operações para trabalhar com dashboards. |
| Contas de armazenamento de fluxo de dados | Operações para trabalhar com contas de armazenamento de fluxo de trabalho. |
| Fluxos de dados | Operações para trabalhar com fluxos de dados. |
| Conjunto de dados | Operações para trabalhar com conjuntos de dados. |
| Token de inserção | Operações para trabalhar com tokens de inserção. |
| Gateways | Operações para trabalhar com gateways. |
| Grupos | Operações para trabalhar com grupos. |
| Importações | Operações para trabalhar com importações. |
| Pipelines | Operações para trabalhar com pipelines de implantação. |
| Conjuntos de dados por push | Operações para trabalhar com conjuntos de dados por push. |
| Relatórios | Operações para trabalhar com relatórios. |
| Aplicativos de modelo | Operações para trabalhar com aplicativos de modelo. |
| Usuários | Operações para trabalhar com usuários. |