Partilhar via


Admin - Groups GetGroupsAsAdmin

Retorna uma lista de workspaces 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é-solicitação de consentimento de administrador necessária 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 15 solicitações por minuto, por locatário. Essa chamada também atingiu o tempo limite após 30 segundos para evitar o efeito adverso na serviço do Power BI.

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
$top
query True

integer

int32

Retorna apenas os primeiros n resultados. Esse parâmetro é obrigatório e deve estar no intervalo de 1 a 5000.

$expand
query

string

Aceita uma lista separada por vírgulas de tipos de dados, que serão expandidos embutidos na resposta. usersDá suporte a , reports, dashboards, datasets, dataflowse workbooks.

$filter
query

string

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

$skip
query

integer

int32

Ignora os primeiros n resultados. Use com superior para buscar resultados além dos primeiros 5000.

Respostas

Nome Tipo Description
200 OK

AdminGroups

OK

Exemplos

Get deleted workspaces example.
Get orphaned workspaces example.
Get workspaces with their 'dashboards' expanded example
Get workspaces with their 'datasets' expanded example
Get workspaces with their 'datasets' expanded example.
Get workspaces with their 'reports' expanded example
Get workspaces with their 'users' expanded example.
Get workspaces with their 'workbooks' expanded example

Get deleted workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$filter=state eq 'Deleted'&$top=100

Sample Response

{
  "value": [
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted"
    }
  ]
}

Get orphaned workspaces example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$filter=(not users/any()) or (not users/any(u: u/groupUserAccessRight eq Microsoft.PowerBI.ServiceContracts.Api.GroupUserAccessRight'Admin'))&$top=100

Sample Response

{
  "value": [
    {
      "id": "d5caa808-8c91-400a-911d-06af08dbcc31",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Orphaned Group",
      "description": "Sample orphan group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": []
    }
  ]
}

Get workspaces with their 'dashboards' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=dashboards&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "dashboards": [
        {
          "id": "4668133c-ae3f-42fb-ad7c-214a8623280c",
          "displayName": "SQlAzure-Refresh.pbix",
          "isReadOnly": false
        },
        {
          "id": "a8f18ca7-63e8-4220-bc1c-f576ec180b98",
          "displayName": "cdvc",
          "isReadOnly": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "datasets": [
        {
          "id": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523",
          "name": "SQlAzure-Refresh",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        },
        {
          "id": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69",
          "name": "NESGames",
          "addRowsAPIEnabled": false,
          "configuredBy": "admin@granularcontrols.ccsctp.net",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "targetStorageMode": "Abf",
          "createdDate": "2019-04-30T21:35:15.867-07:00",
          "ContentProviderType": "PbixInImportMode",
          "isInPlaceSharingEnabled": false
        }
      ]
    }
  ]
}

Get workspaces with their 'datasets' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=datasets

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": true,
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "addRowsAPIEnabled": false,
          "configuredBy": "john@contoso.com",
          "isRefreshable": true,
          "isEffectiveIdentityRequired": false,
          "isEffectiveIdentityRolesRequired": false,
          "isOnPremGatewayRequired": false,
          "isInPlaceSharingEnabled": false,
          "encryption": {
            "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
            "encryptionStatus": "InSyncWithWorkspace"
          }
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "datasets": []
    }
  ]
}

Get workspaces with their 'reports' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=reports&$top=100

Sample Response

{
  "value": [
    {
      "id": "EC1EE11F-845D-495E-82A3-9DAC2072305A",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "cvcv",
      "type": "Workspace",
      "state": "Active",
      "name": "WSv2Test12",
      "hasWorkspaceLevelSettings": true,
      "reports": []
    },
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "capacityMigrationStatus": "Migrated",
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "name": "a",
      "hasWorkspaceLevelSettings": false,
      "reports": [
        {
          "id": "5DBA60B0-D9A7-42AE-B12C-6D9D51E7739A",
          "reportType": "PowerBIReport",
          "name": "SQlAzure-Refresh",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        },
        {
          "id": "197E5C3C-D2F3-42D8-A536-875FB6D7D48C",
          "reportType": "PowerBIReport",
          "name": "NESGames",
          "datasetId": "7d6a4f72-1906-4e08-a469-bd6bc1ab7b69"
        }
      ]
    }
  ]
}

Get workspaces with their 'users' expanded example.

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=users&$top=100

Sample Response

{
  "value": [
    {
      "id": "e380d1d0-1fa6-460b-9a90-1a5c6b02414c",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "Sample Group 1",
      "description": "Sample group",
      "type": "Workspace",
      "state": "Active",
      "hasWorkspaceLevelSettings": false,
      "users": [
        {
          "emailAddress": "john@contoso.com",
          "groupUserAccessRight": "Admin"
        }
      ]
    },
    {
      "id": "183dcf10-47b8-48c4-84aa-f0bf9d5f8fcf",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "Sample Group 2",
      "description": "Deleted sample group",
      "type": "Workspace",
      "state": "Deleted",
      "users": []
    }
  ]
}

Get workspaces with their 'workbooks' expanded example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups?$expand=workbooks&$top=100

Sample Response

{
  "value": [
    {
      "id": "94E57E92-CEE2-486D-8CC8-218C97200579",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "description": "shorter description",
      "type": "Workspace",
      "state": "Removing",
      "hasWorkspaceLevelSettings": false,
      "name": "a",
      "workbooks": [
        {
          "name": "My Excel sheet",
          "datasetId": "8ce96c50-85a0-4db3-85c6-7ccc3ed46523"
        }
      ]
    }
  ]
}

Definições

Nome Description
AdminDashboard

Um dashboard do Power BI retornado por APIs de Administração. A API retorna um subconjunto da lista de propriedades de 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.

AdminDataflow

Os metadados de um fluxo de dados retornados por APIs Administração. Veja abaixo uma lista de propriedades que podem ser retornadas para um fluxo de dados. Somente um subconjunto das propriedades será retornado dependendo da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

AdminDataset

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

AdminGroup

Um grupo do Power BI retornado por APIs de administrador

AdminGroups

O wrapper de resposta OData para uma lista de grupos do Power BI retornados por APIs de Administração

AdminReport

Um relatório do Power BI retornado por APIs Administração. A API retorna um subconjunto da lista de propriedades de relatório 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.

AdminTile

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

AzureResource

Uma resposta detalhando um recurso do Azure de propriedade do usuário, como um workspace do Log Analytics.

DashboardUser

Uma entrada correta de acesso de 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)

DataflowUser

Uma entrada correta de acesso de usuário do Power BI para um fluxo de dados

DataflowUserAccessRight

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

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados

DatasetUser

Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados

DatasetUserAccessRight

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

DefaultDatasetStorageFormat

O formato de armazenamento do conjunto de dados padrão no grupo

DependentDataflow

Um fluxo de dados dependente do Power BI

Encryption

Informações de criptografia para um conjunto de dados

EncryptionStatus

Status de criptografia de conjunto de dados

GroupType

O tipo de grupo

GroupUser

Um usuário do Power BI com acesso ao workspace

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

PrincipalType

O tipo de entidade de segurança

ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório

ReportUserAccessRight

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

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.

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

Workbook

Uma pasta de trabalho do Power BI

AdminDashboard

Um dashboard do Power BI retornado por APIs de Administração. A API retorna um subconjunto da lista de propriedades de 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 de carga 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 de carga em uma versão futura. Você pode recuperar informações do usuário em um dashboard do Power BI usando a chamada Obter Usuários do Painel como Administração API 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.

AdminDataflow

Os metadados de um fluxo de dados retornados por APIs Administração. Veja abaixo uma lista de propriedades que podem ser retornadas para um fluxo de dados. Somente um subconjunto das propriedades será retornado dependendo da API chamada, das permissões de chamador e da disponibilidade dos dados no banco de dados do Power BI.

Nome Tipo Description
configuredBy

string

O proprietário do fluxo de dados

description

string

A descrição do fluxo de dados

modelUrl

string

Uma URL para o arquivo de definição de fluxo de dados (model.json)

modifiedBy

string

O usuário que modificou o fluxo de dados

modifiedDateTime

string

A data e a hora em que o fluxo de dados foi modificado pela última vez

name

string

O nome do fluxo de dados

objectId

string

A ID do fluxo de dados

users

DataflowUser[]

(Valor vazio) Os detalhes de acesso do usuário do fluxo de dados. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um fluxo de dados do Power BI usando a chamada Obter Usuários de Fluxo de Dados como Administração chamada à API ou a chamada à API PostWorkspaceInfo com o getArtifactUser parâmetro .

workspaceId

string

A ID do workspace do fluxo de dados.

AdminDataset

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

Nome Tipo Description
ContentProviderType

string

O tipo de provedor de conteúdo para o conjunto de dados

CreateReportEmbedURL

string

O conjunto de dados criar URL de inserção de relatório

CreatedDate

string

A data e hora de criação do conjunto de dados

Encryption

Encryption

Informações de criptografia de conjunto de dados. Aplicável somente quando $expand for especificado.

IsEffectiveIdentityRequired

boolean

Se o conjunto de dados requer uma identidade eficaz, que você deve enviar em uma chamada à API GenerateToken .

IsEffectiveIdentityRolesRequired

boolean

Se a segurança em nível de linha é definida dentro do arquivo .pbix do Power BI. Nesse caso, você deve especificar uma função.

IsInPlaceSharingEnabled

boolean

Se o conjunto de dados pode ser compartilhado com usuários externos a serem consumidos em seu próprio locatário

IsOnPremGatewayRequired

boolean

Se o conjunto de dados requer um gateway de dados local

IsRefreshable

boolean

Se o conjunto de dados é atualizável ou não. Um conjunto de dados atualizável do Power BI é um conjunto de dados que foi atualizado pelo menos uma vez ou para o qual existe um agendamento de atualização válido.

QnaEmbedURL

string

O conjunto de dados Q&UMA URL de inserção

addRowsAPIEnabled

boolean

Se o conjunto de dados permite adicionar novas linhas

configuredBy

string

O proprietário do conjunto de dados

description

string

A descrição do conjunto de dados

id

string

A ID do conjunto de dados

name

string

O nome do conjunto de dados

queryScaleOutSettings

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados

targetStorageMode

string

O modo de armazenamento do conjunto de dados

upstreamDataflows

DependentDataflow[]

A lista de todos os fluxos de dados dos quais este item depende

users

DatasetUser[]

(Valor vazio) Os detalhes de acesso do usuário do conjunto de dados. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um item do Power BI (como um relatório ou um dashboard) usando a API Obter Usuários do Conjunto de Dados como Administração ou a API PostWorkspaceInfo com o getArtifactUsers parâmetro .

webUrl

string

A URL da Web do conjunto de dados

workspaceId

string

A ID do workspace do conjunto de dados. Essa propriedade será retornada somente em GetDatasetsAsAdmin.

AdminGroup

Um grupo do Power BI retornado por APIs de administrador

Nome Tipo Description
capacityId

string

A ID da capacidade

dashboards

AdminDashboard[]

Os painéis que pertencem ao grupo

dataflowStorageId

string

A ID da conta de armazenamento de fluxo de dados do Power BI

dataflows

AdminDataflow[]

Os fluxos de dados que pertencem ao grupo

datasets

AdminDataset[]

Os conjuntos de dados que pertencem ao grupo

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

O formato de armazenamento do conjunto de dados padrão no workspace. Retornado somente quando isOnDedicatedCapacity é true

description

string

A descrição do grupo

hasWorkspaceLevelSettings

boolean

Se o workspace tem configurações personalizadas

id

string

A ID do workspace

isOnDedicatedCapacity

boolean

Se o grupo é atribuído a uma capacidade dedicada

isReadOnly

boolean

Se o grupo é somente leitura

logAnalyticsWorkspace

AzureResource

O workspace do Log Analytics atribuído ao grupo. Isso é retornado somente ao recuperar um único grupo.

name

string

O nome do grupo

pipelineId

string

A ID do pipeline de implantação à qual o workspace está atribuído.

reports

AdminReport[]

Os relatórios que pertencem ao grupo

state

string

O estado do grupo

type

GroupType

O tipo de grupo que está sendo retornado.

users

GroupUser[]

(Valor vazio) Os usuários que pertencem ao grupo e seus direitos de acesso. Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações do usuário em um item do Power BI (como um relatório ou um dashboard) usando a chamada à API Obter Usuários do Grupo Como Administração ou a chamada à API PostWorkspaceInfo com o getArtifactUsers parâmetro .

workbooks

Workbook[]

As pastas de trabalho que pertencem ao grupo

AdminGroups

O wrapper de resposta OData para uma lista de grupos do Power BI retornados por APIs de Administração

Nome Tipo Description
odata.context

string

Contexto OData

value

AdminGroup[]

A lista de grupos

AdminReport

Um relatório do Power BI retornado por APIs Administração. A API retorna um subconjunto da lista de propriedades de relatório 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 relatório pertencer a um aplicativo

createdBy

string

O proprietário do relatório. Disponível somente para relatórios criados após junho de 2019.

createdDateTime

string

A data e hora de criação do relatório

datasetId

string

A ID do conjunto de dados do relatório

description

string

A descrição do relatório

embedUrl

string

A URL de inserção do relatório

id

string

A ID do relatório

isOwnedByMe

boolean

Determine se o relatório é criado pelo usuário atual.

modifiedBy

string

O último usuário que modificou o relatório

modifiedDateTime

string

A data e a hora em que o relatório foi modificado pela última vez

name

string

O nome do relatório

originalReportId

string

A ID do relatório real quando o workspace é publicado como um aplicativo.

reportType enum:
  • PaginatedReport
  • PowerBIReport

O tipo de relatório

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 de carga 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.

users

ReportUser[]

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

webUrl

string

A URL da Web do relatório

workspaceId

string

A ID do workspace (GUID) do relatório. Essa propriedade será retornada somente em GetReportsAsAdmin.

AdminTile

Um bloco do Power BI retornado por APIs de 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 apenas 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 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

AzureResource

Uma resposta detalhando um recurso do Azure de propriedade do usuário, como um workspace do Log Analytics.

Nome Tipo Description
id

string

Um identificador para o recurso no Power BI.

resourceGroup

string

O grupo de recursos dentro da assinatura em que o recurso reside.

resourceName

string

O nome do recurso.

subscriptionId

string

A assinatura do Azure em que o recurso reside.

DashboardUser

Uma entrada correta de acesso de 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 apenas 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 várias locações.

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 recompartilhamento 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 compartilhamento ao conteúdo no dashboard

ReadWrite

string

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

DataflowUser

Uma entrada correta de acesso de usuário do Power BI para um fluxo de dados

Nome Tipo Description
DataflowUserAccessRight

DataflowUserAccessRight

O direito de acesso que um usuário tem para o fluxo de dados (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 apenas 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 várias locações.

userType

string

Tipo do usuário.

DataflowUserAccessRight

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

Nome Tipo Description
None

string

Remove a permissão para o conteúdo no fluxo de dados

Owner

string

Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no fluxo de dados

Read

string

Concede acesso de leitura ao conteúdo no fluxo de dados

ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no fluxo de dados

ReadWrite

string

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

DatasetQueryScaleOutSettings

Consultar configurações de expansão de um conjunto de dados

Nome Tipo Description
autoSyncReadOnlyReplicas

boolean

Se o conjunto de dados sincroniza automaticamente réplicas somente leitura

maxReadOnlyReplicas

integer

Número máximo de réplicas somente leitura para o conjunto de dados (0-64, -1 para o número automático de réplicas)

DatasetUser

Uma entrada correta de acesso de usuário do Power BI para um conjunto de dados

Nome Tipo Description
datasetUserAccessRight

DatasetUserAccessRight

O direito de acesso que o usuário tem para o conjunto de dados (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 apenas 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 várias locações.

userType

string

Tipo do usuário.

DatasetUserAccessRight

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

Nome Tipo Description
None

string

Remove a permissão para o conteúdo no conjunto de dados

Read

string

Concede acesso de leitura ao conteúdo no conjunto de dados

ReadExplore

string

Concede acesso de Leitura e Exploração ao conteúdo no conjunto de dados

ReadReshare

string

Concede acesso de leitura e compartilhamento ao conteúdo no conjunto de dados

ReadReshareExplore

string

Concede acesso de Leitura, Recompartilhamento e Exploração ao conteúdo no conjunto de dados

ReadWrite

string

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

ReadWriteExplore

string

Concede acesso de Leitura, Gravação e Exploração ao conteúdo no conjunto de dados

ReadWriteReshare

string

Concede acesso de leitura, gravação e recompartilhamento ao conteúdo no conjunto de dados

ReadWriteReshareExplore

string

Concede acesso de Leitura, Gravação, Recompartilhamento e Explorar ao conteúdo no conjunto de dados

DefaultDatasetStorageFormat

O formato de armazenamento do conjunto de dados padrão no grupo

Nome Tipo Description
Large

string

Formato de armazenamento de conjunto de dados grande

Small

string

Formato de armazenamento de conjunto de dados pequeno

DependentDataflow

Um fluxo de dados dependente do Power BI

Nome Tipo Description
groupId

string

A ID do grupo de destino

targetDataflowId

string

A ID do fluxo de dados de destino

Encryption

Informações de criptografia para um conjunto de dados

Nome Tipo Description
EncryptionStatus

EncryptionStatus

Status de criptografia de conjunto de dados

EncryptionStatus

Status de criptografia de conjunto de dados

Nome Tipo Description
InSyncWithWorkspace

string

A criptografia tem suporte e está em sincronia com as configurações de criptografia

NotInSyncWithWorkspace

string

A criptografia tem suporte, mas não está sincronizada com as configurações de criptografia

NotSupported

string

Não há suporte para criptografia para esse conjunto de dados

Unknown

string

A status de criptografia é desconhecida devido à corrupção do conjunto de dados

GroupType

O tipo de grupo

Nome Tipo Description
Group

string

Versão V1 do workspace compartilhado. Esse tipo de workspaces será preterido à medida que a Microsoft migrar todos os workspaces para a versão mais recente do workspace compartilhado

Personal

string

Tipo especial de workspace destinado à lista do SharePoint e à integração do OneDrive

PersonalGroup

string

"Meu workspace", também conhecido como workspace pessoal

Workspace

string

Workspace compartilhado ou workspace simples usado para compartilhar conteúdo com outros usuários na organização

GroupUser

Um usuário do Power BI com acesso ao workspace

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 apenas para APIs de administrador.

groupUserAccessRight

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

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 várias locações.

userType

string

Tipo do usuário.

GroupUserAccessRight

O direito de acesso (nível de permissão) que um usuário tem no workspace

Nome Tipo Description
Admin

string

Direitos de administrador para o conteúdo do workspace

Contributor

string

Acesso de leitura e exploração (ReadExplore) ao conteúdo do workspace

Member

string

Direitos de acesso de leitura, recompartilhamento e exploração (ReadReshareExplore) ao conteúdo do workspace

None

string

Sem acesso ao conteúdo do workspace

Viewer

string

Acesso somente leitura (leitura) ao conteúdo do workspace

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

ReportUser

Uma entrada correta de acesso de usuário do Power BI para um relatório

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 apenas 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 várias locações.

reportUserAccessRight

ReportUserAccessRight

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

userType

string

Tipo do usuário.

ReportUserAccessRight

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

Nome Tipo Description
None

string

Nenhuma permissão para conteúdo no relatório

Owner

string

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

Read

string

Concede acesso de leitura ao conteúdo no relatório

ReadCopy

string

Concede acesso de leitura e cópia ao conteúdo no relatório

ReadReshare

string

Concede acesso de leitura e recompartilhamento ao conteúdo no relatório

ReadWrite

string

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

ServicePrincipalProfile

Um serviço do Power BI perfil principal. Relevante apenas para Power BI Embedded solução de várias locações.

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 obter assinaturas de usuário como Administração API, o valor retornado é uma matriz vazia (nula). Essa propriedade será removida da resposta de carga em uma versão futura. Você pode recuperar informações de assinatura em um relatório ou dashboard do Power BI usando as chamadas à API Obter Assinaturas de Relatório como Administração ou Obter Assinaturas de Painel como 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 apenas 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 várias locações.

userType

string

Tipo do usuário.

Workbook

Uma pasta de trabalho do Power BI

Nome Tipo Description
datasetId

string

A ID do conjunto de dados associado a uma pasta de trabalho. Só se aplica se a pasta de trabalho tiver um conjunto de dados associado.

name

string

O nome da pasta de trabalho