Admin - Dashboards GetDashboardsAsAdmin

Retorna uma lista de painéis para a organização.

Permissões

  • O usuário deve ter direitos de administrador (como Office 365 Administrador Global ou Administrador de Serviços do Power BI) 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 nenhuma pré-permissão necessária de consentimento do administrador para o Power BI definida 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ão expandidos embutidos na resposta. Dá suporte a tiles.

$filter
query

string

Filtra os resultados, com base em uma condição booliana

$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

AdminDashboards

OK

Exemplos

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/dashboards

Sample Response

{
  "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
AdminDashboard

Uma dashboard do Power BI retornada por APIs Administração. A API retorna um subconjunto da lista de propriedades dashboard a seguir. O subconjunto depende da API chamada, das permissões de chamador e da disponibilidade de dados no banco de dados do Power BI.

AdminDashboards

O wrapper de resposta OData para uma coleção de dashboard do Power BI

AdminTile

Um bloco do Power BI retornado por APIs Administração.

DashboardUser

Uma entrada à direita de acesso do usuário do Power BI para um dashboard

DashboardUserAccessRight

O direito de acesso que o usuário tem para o dashboard (nível de permissão)

PrincipalType

O tipo de entidade de segurança

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

Subscription

Uma assinatura de email para um item do Power BI (como um relatório ou um dashboard)

SubscriptionUser

Um usuário de assinatura de email do Power BI

AdminDashboard

Uma dashboard do Power BI retornada por APIs Administração. A API retorna um subconjunto da lista de propriedades dashboard a seguir. 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 dashboard pertencer a um aplicativo

displayName

string

O nome de exibição do dashboard

embedUrl

string

A URL de inserção do dashboard

id

string

A ID do dashboard

isReadOnly

boolean

Se o dashboard é somente leitura

subscriptions

Subscription[]

(Valor vazio) Os detalhes da assinatura de um item do Power BI (como um relatório ou um dashboard). Essa propriedade será removida da resposta do 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 Administração API.

tiles

AdminTile[]

Os blocos que pertencem ao dashboard

users

DashboardUser[]

(Valor vazio) O dashboard detalhes de acesso do usuário. Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações do usuário em uma dashboard do Power BI usando a chamada à API Obter Usuários do Painel como Administração ou a chamada à API PostWorkspaceInfo com o getArtifactUsers parâmetro .

webUrl

string

A URL da Web do dashboard

workspaceId

string

A ID do workspace (GUID) do dashboard. Essa propriedade será retornada somente em GetDashboardsAsAdmin.

AdminDashboards

O wrapper de resposta OData para uma coleção de dashboard do Power BI

Nome Tipo Description
odata.context

string

Contexto OData

value

AdminDashboard[]

A coleção dashboard

AdminTile

Um bloco do Power BI retornado por APIs Administração.

Nome Tipo Description
colSpan

integer

O número de colunas de intervalo de blocos

datasetId

string

A ID do conjunto de dados. Disponível somente para blocos criados a partir de um relatório ou usando um conjunto de dados, como blocos Q&A.

embedData

string

Os dados de inserção para o bloco

embedUrl

string

A URL de inserção do bloco

id

string

A ID do bloco

reportId

string

A ID do relatório. Disponível somente 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 à direita de acesso do usuário do Power BI para um dashboard

Nome Tipo Description
dashboardUserAccessRight

DashboardUserAccessRight

O direito de acesso que o usuário tem para o dashboard (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

PrincipalType

O tipo de entidade de segurança

profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

userType

string

Tipo do usuário.

DashboardUserAccessRight

O direito de acesso que o usuário tem para o dashboard (nível de permissão)

Nome Tipo Description
None

string

Nenhuma permissão para conteúdo no dashboard

Owner

string

Concede acesso de leitura, gravação e compartilhamento ao conteúdo no relatório

Read

string

Concede acesso de leitura ao conteúdo no dashboard

ReadCopy

string

Concede acesso de Leitura e Cópia ao conteúdo no dashboard

ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no dashboard

ReadWrite

string

Concede acesso de leitura e gravação ao conteúdo no dashboard

PrincipalType

O tipo de entidade de segurança

Nome Tipo Description
App

string

Tipo de entidade de serviço

Group

string

Tipo de entidade de grupo

None

string

Nenhum tipo de entidade de segurança. Use para acesso em nível de organização inteiro.

User

string

Tipo de entidade de usuário

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

Nome Tipo Description
displayName

string

O nome do perfil da entidade de serviço

id

string

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 dashboard)

Nome Tipo Description
artifactDisplayName

string

O nome do item do Power BI assinado (como um relatório ou um dashboard)

artifactId

string

A ID do item do Power BI assinado (como um relatório ou um dashboard)

artifactType

string

O tipo de item do Power BI (por exemplo, um Report, Dashboardou Dataset)

attachmentFormat

string

Formato do relatório anexado na assinatura de email

endDate

string

A data e a hora de término da assinatura de email

frequency

string

A frequência da assinatura de email

id

string

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

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

SubscriptionUser[]

Os detalhes de cada assinante de email. Ao usar a chamada à API Obter Assinaturas de Usuário Como Administração, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta do conteúdo em uma versão futura. Você pode recuperar informações de assinatura em um relatório do Power BI ou dashboard usando obter assinaturas de relatório como Administração ou obter assinaturas de painel como chamadas à API Administração.

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

PrincipalType

O tipo de entidade de segurança

profile

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de multilocação.

userType

string

Tipo do usuário.