Admin - Dashboards GetDashboardsAsAdmin
Retorna uma lista de dashboards para a organização.
Permissions
- O usuário deve ser um administrador do Fabric ou autenticar usando uma entidade de serviço.
- Há suporte para permissões delegadas.
Ao executar em autenticação prinicipal de serviço, um aplicativo não deve ter as pré-requismissões necessárias de consentimento do administrador para o Power BI definidas nele no portal do Azure.
Escopo necessário
Tenant.Read.All ou Tenant.ReadWrite.All
Relevante somente ao autenticar por meio de um token de acesso de administrador delegado padrão. Não deve estar presente quando a autenticação por meio de uma entidade de serviço é usada.
Limitações
Máximo de 50 solicitações por hora ou 5 solicitações por minuto, por locatário.
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}
Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
$expand
|
query |
string |
Aceita uma lista separada por vírgulas de tipos de dados, que será expandida embutida na resposta.
|
|
|
$filter
|
query |
string |
Retorna um subconjunto de resultados com base na condição de parâmetro de consulta do filtro Odata . |
|
|
$skip
|
query |
integer (int32) |
Ignora os primeiros n resultados |
|
|
$top
|
query |
integer (int32) |
Retorna apenas os primeiros n resultados |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
OKEY |
Exemplos
Example
Solicitação de exemplo
GET https://api.powerbi.com/v1.0/myorg/admin/dashboards
Resposta de exemplo
{
"value": [
{
"id": "69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"displayName": "SalesMarketing",
"embedUrl": "https://app.powerbi.com/dashboardEmbed?dashboardId=69ffaa6c-b36d-4d01-96f5-1ed67c64d4af",
"isReadOnly": false,
"workspaceId": "abfbdc89-2659-43c1-9142-93e8378eac96"
}
]
}
Definições
| Nome | Description |
|---|---|
|
Admin |
Um painel do Power BI retornado por APIs de administrador. A API retorna um subconjunto da lista a seguir de propriedades do painel. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI. |
|
Admin |
O wrapper de resposta OData para uma coleção de painéis do Power BI |
|
Admin |
Um bloco do Power BI retornado pelas APIs de Administrador. |
|
Dashboard |
Uma entrada certa de acesso de usuário do Power BI para um dashboard |
|
Dashboard |
O direito de acesso que o usuário tem para o painel (nível de permissão) |
|
Principal |
O tipo principal |
|
Service |
Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded. |
| Subscription |
Uma assinatura de email para um item do Power BI (como um relatório ou um painel) |
|
Subscription |
Um usuário de assinatura de email do Power BI |
AdminDashboard
Um painel do Power BI retornado por APIs de administrador. A API retorna um subconjunto da lista a seguir de propriedades do painel. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.
| Nome | Tipo | Description |
|---|---|---|
| appId |
string |
A ID do aplicativo, retornada somente se o painel pertencer a um aplicativo |
| displayName |
string |
O nome de exibição do painel |
| embedUrl |
string |
A URL de inserção do painel |
| id |
string (uuid) |
A ID do painel |
| isReadOnly |
boolean |
Se o painel é somente leitura |
| subscriptions |
(Valor vazio) Os detalhes da assinatura de um item do Power BI (como um relatório ou um painel). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura para um relatório do Power BI usando a chamada Obter Assinaturas de Relatório como API de Administrador. |
|
| tiles |
Os blocos que pertencem ao painel |
|
| users |
(Valor vazio) Os detalhes de acesso do usuário do painel. Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações do usuário em um painel do Power BI usando a chamada Obter Usuários do Painel como API de Administrador ou a chamada à API PostWorkspaceInfo com o |
|
| webUrl |
string |
A URL da Web do painel |
| workspaceId |
string (uuid) |
A ID do workspace (GUID) do painel. Essa propriedade será retornada somente em GetDashboardsAsAdmin. |
AdminDashboards
O wrapper de resposta OData para uma coleção de painéis do Power BI
| Nome | Tipo | Description |
|---|---|---|
| @odata.context |
string |
Contexto OData |
| value |
A coleção de dashboards |
AdminTile
Um bloco do Power BI retornado pelas APIs de Administrador.
| Nome | Tipo | Description |
|---|---|---|
| colSpan |
integer |
O número de colunas de intervalo de blocos |
| datasetId |
string |
A ID do conjunto de dados. Disponível apenas para blocos criados a partir de um relatório ou usando um conjunto de dados, como blocos de Q&A. |
| embedData |
string |
Os dados de inserção para o bloco |
| embedUrl |
string |
A URL de inserção do bloco |
| id |
string (uuid) |
A ID do bloco |
| reportId |
string (uuid) |
A ID do relatório. Disponível apenas para blocos criados a partir de um relatório. |
| rowSpan |
integer |
O número de linhas de intervalo de blocos |
| title |
string |
O nome de exibição do bloco |
DashboardUser
Uma entrada certa de acesso de usuário do Power BI para um dashboard
| Nome | Tipo | Description |
|---|---|---|
| dashboardUserAccessRight |
O direito de acesso que o usuário tem para o painel (nível de permissão) |
|
| displayName |
string |
Nome de exibição da entidade de segurança |
| emailAddress |
string |
Endereço de email do usuário |
| graphId |
string |
Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador. |
| identifier |
string |
Identificador da entidade de segurança |
| principalType |
O tipo principal |
|
| profile |
Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded. |
|
| userType |
string |
Tipo do usuário. |
DashboardUserAccessRight
O direito de acesso que o usuário tem para o painel (nível de permissão)
| Valor | Description |
|---|---|
| None |
Nenhuma permissão para conteúdo no painel |
| Read |
Concede acesso de leitura ao conteúdo no painel |
| ReadWrite |
Concede acesso de leitura e gravação ao conteúdo no painel |
| ReadReshare |
Concede acesso de leitura e compartilhamento ao conteúdo no painel |
| ReadCopy |
Concede acesso de leitura e cópia ao conteúdo no painel |
| Owner |
Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no relatório |
PrincipalType
O tipo principal
| Valor | Description |
|---|---|
| None |
Nenhum tipo de entidade de segurança. Use todo o acesso ao nível da organização. |
| User |
Tipo de entidade de usuário |
| Group |
Tipo de entidade de grupo |
| App |
Tipo de entidade de serviço |
ServicePrincipalProfile
Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded.
| Nome | Tipo | Description |
|---|---|---|
| displayName |
string |
O nome do perfil da entidade de serviço |
| id |
string (uuid) |
A ID do perfil da entidade de serviço |
Subscription
Uma assinatura de email para um item do Power BI (como um relatório ou um painel)
| Nome | Tipo | Description |
|---|---|---|
| artifactDisplayName |
string |
O nome do item do Power BI assinado (como um relatório ou um painel) |
| artifactId |
string (uuid) |
A ID do item do Power BI assinado (como um relatório ou um painel) |
| artifactType |
string |
O tipo de item do Power BI (por exemplo, um |
| attachmentFormat |
string |
Formato do relatório anexado na assinatura de email |
| endDate |
string (date-time) |
A data e a hora de término da assinatura de email |
| frequency |
string |
A frequência da assinatura de email |
| id |
string (uuid) |
A ID da assinatura |
| isEnabled |
boolean |
Se a assinatura de email está habilitada |
| linkToContent |
boolean |
Se existe um link de assinatura na assinatura de email |
| previewImage |
boolean |
Se existe uma captura de tela do relatório na assinatura de email |
| startDate |
string (date-time) |
A data e a hora de início da assinatura de email |
| subArtifactDisplayName |
string |
O nome da página do item do Power BI assinado, se for um relatório. |
| title |
string |
O nome do aplicativo |
| users |
Os detalhes de cada assinante de email. Ao usar a chamada à API Obter Assinaturas de Usuário como Administrador, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta de conteúdo em uma versão futura. Você pode recuperar informações de assinatura em um relatório ou dashboard do Power BI usando as chamadas obter assinaturas de relatório como administrador ou obter assinaturas de painel como chamadas à API de administrador. |
SubscriptionUser
Um usuário de assinatura de email do Power BI
| Nome | Tipo | Description |
|---|---|---|
| displayName |
string |
Nome de exibição da entidade de segurança |
| emailAddress |
string |
Endereço de email do usuário |
| graphId |
string |
Identificador da entidade de segurança no Microsoft Graph. Disponível somente para APIs de administrador. |
| identifier |
string |
Identificador da entidade de segurança |
| principalType |
O tipo principal |
|
| profile |
Um perfil de entidade de serviço do Power BI. Relevante apenas para a solução de multilocação do Power BI Embedded. |
|
| userType |
string |
Tipo do usuário. |