Partilhar via


Admin - Groups UpdateGroupAsAdmin

Atualiza as propriedades do workspace especificado.

Para cancelar a atribuição de um workspace do Log Analytics, defina explicitamente o valor como nulo.

Permissões

O usuário deve ser um administrador do Fabric.

Escopo necessário

Tenant.ReadWrite.All

Limitações

  • Máximo de 200 solicitações por hora.
  • Para capacidades compartilhadas, somente o nome e a descrição podem ser atualizados.
  • Para capacidades Premium, somente o nome, a descrição, o workspace defaultDatasetStorageFormat e o Log Analytics podem ser atualizados.
  • O nome deve ser exclusivo dentro de uma organização.

PATCH https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
groupId
path True

string

uuid

A ID do workspace

Corpo da solicitação

Nome Obrigatório Tipo Description
id True

string

A ID do workspace

capacityId

string

A ID da capacidade

dashboards

AdminDashboard[]

Os dashboards 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

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 conteúdo 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 painel) usando o Obter Usuários de Grupo como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUsers.

workbooks

Workbook[]

As pastas de trabalho que pertencem ao grupo

Respostas

Nome Tipo Description
200 OK

OKEY

Exemplos

Example of assigning Log Analytics workspace
Example of unassigning Log Analytics workspace
Example of updating group description and defaultDatasetStorageFormat

Example of assigning Log Analytics workspace

Solicitação de exemplo

PATCH https://api.powerbi.com/v1.0/myorg/admin/groups/e2284830-c8dc-416b-b19a-8cdcd2729332
{
  "logAnalyticsWorkspace": {
    "subscriptionId": "d778934f-bda2-41d9-b5c7-6cf41372c1a0",
    "resourceGroup": "myResourceGroup",
    "resourceName": "myLogAnalyticsWorkspace"
  }
}

Resposta de exemplo

Example of unassigning Log Analytics workspace

Solicitação de exemplo

PATCH https://api.powerbi.com/v1.0/myorg/admin/groups/e2284830-c8dc-416b-b19a-8cdcd2729332
{
  "logAnalyticsWorkspace": null
}

Resposta de exemplo

Example of updating group description and defaultDatasetStorageFormat

Solicitação de exemplo

PATCH https://api.powerbi.com/v1.0/myorg/admin/groups/e2284830-c8dc-416b-b19a-8cdcd2729332
{
  "name": "Updated Sales Results",
  "description": "Refreshed sales numbers",
  "defaultDatasetStorageFormat": "Large"
}

Resposta de exemplo

Definições

Nome Description
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.

AdminDataflow

Os metadados de um fluxo de dados retornado pelas APIs de Administrador. 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 administrador. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. 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

AdminReport

Um relatório do Power BI retornado pelas APIs de Administrador. A API retorna um subconjunto da lista a seguir de propriedades de relatório. 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 pelas APIs de Administrador.

AzureResource

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

DashboardUser

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

DashboardUserAccessRight

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

DataflowUser

Uma entrada certa 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 certa 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 da criptografia do 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 principal

ReportUser

Uma entrada certa 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 perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

Subscription

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

SubscriptionUser

Um usuário de assinatura de email do Power BI

Workbook

Uma pasta de trabalho 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

A ID do painel

isReadOnly

boolean

Se o painel é somente leitura

subscriptions

Subscription[]

(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 o Obter Assinaturas de Relatório como Administrador chamada à API.

tiles

AdminTile[]

Os blocos que pertencem ao painel

users

DashboardUser[]

(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 o Obter Usuários do Painel como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUsers.

webUrl

string

A URL da Web do painel

workspaceId

string

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

AdminDataflow

Os metadados de um fluxo de dados retornado pelas APIs de Administrador. 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)

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 conteúdo em uma versão futura. Você pode recuperar informações do usuário sobre um fluxo de dados do Power BI usando a chamada Obter Usuários de Fluxo de Dados como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUser.

workspaceId

string

A ID do workspace do fluxo de dados.

AdminDataset

Um conjunto de dados do Power BI retornado por APIs de administrador. A API retorna um subconjunto da lista a seguir de propriedades do conjunto de dados. 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 cria a URL de inserção de relatório

Encryption

Encryption

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

IsEffectiveIdentityRequired

boolean

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

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

Esse campo retorna true quando o conjunto de dados é atualizado recentemente ou está configurado para atualização automática, com o modo de conexão definido especificamente como "Importar". O valor retornará false para outros modos de conexão, como 'DirectQuery' e 'LiveConnection', independentemente de o conjunto de dados ser atualizado manualmente ou ser configurado para atualização automática.

QnaEmbedURL

string

A URL de inserção do conjunto de dados Q&A

addRowsAPIEnabled

boolean

Se o conjunto de dados permite adicionar novas linhas

configuredBy

string

O proprietário do conjunto de dados

createdDate

string

A data e a hora de criação 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 conteúdo 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 painel) usando o Obter Usuários do Conjunto de Dados como Administrador API ou a API PostWorkspaceInfo com o parâmetro getArtifactUsers.

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 dashboards 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 conteúdo 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 painel) usando o Obter Usuários de Grupo como Administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUsers.

workbooks

Workbook[]

As pastas de trabalho que pertencem ao grupo

AdminReport

Um relatório do Power BI retornado pelas APIs de Administrador. A API retorna um subconjunto da lista a seguir de propriedades de relatório. 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 a 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 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 o Obter Assinaturas de Relatório como Administrador chamada à 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 conteúdo em uma versão futura. Você pode recuperar informações do usuário em um relatório do Power BI usando o Obter Usuários de Relatório como administrador chamada à API ou a chamada à API PostWorkspaceInfo com o parâmetro getArtifactUsers.

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 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 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 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 na qual o recurso reside.

DashboardUser

Uma entrada certa 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 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

PrincipalType

O tipo principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários 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)

Nome Tipo Description
None

string

Nenhuma permissão para conteúdo no painel

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 painel

ReadCopy

string

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

ReadReshare

string

Concede acesso de leitura e compartilhamento ao conteúdo no painel

ReadWrite

string

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

DataflowUser

Uma entrada certa 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 somente para APIs de administrador.

identifier

string

Identificador da entidade de segurança

principalType

PrincipalType

O tipo principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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 compartilhamento 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 compartilhamento 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 certa 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 somente para APIs de administrador.

identifier

string

Identificador da entidade de segurança

principalType

PrincipalType

O tipo principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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, compartilhamento 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 compartilhamento ao conteúdo no conjunto de dados

ReadWriteReshareExplore

string

Concede acesso de leitura, gravação, compartilhamento e exploração 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 da criptografia do conjunto de dados

EncryptionStatus

Status da criptografia do 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á em sincronia com as configurações de criptografia

NotSupported

string

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

Unknown

string

O status de criptografia é desconhecido devido à corrupção do conjunto de dados

GroupType

O tipo de grupo

Nome Tipo Description
AdminWorkspace

string

Monitoramento de administrador para administradores de malha

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 somente 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 principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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 principal

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 todo o acesso ao nível da organização.

User

string

Tipo de entidade de usuário

ReportUser

Uma entrada certa 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 somente para APIs de administrador.

identifier

string

Identificador da entidade de segurança

principalType

PrincipalType

O tipo principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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 compartilhamento ao conteúdo no relatório

ReadWrite

string

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

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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

Nome Tipo Description
artifactDisplayName

string

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

artifactId

string

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 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 o obter assinaturas de usuário como administrador chamada à API, 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 o Obter Assinaturas de Relatório como Administrador ou Obter Assinaturas do Painel como Administrador chamadas à API.

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 principal

profile

ServicePrincipalProfile

Um perfil de entidade de serviço do Power BI. Relevante apenas para solução de vários locatários do Power BI Embedded.

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. Aplica-se somente se a pasta de trabalho tiver um conjunto de dados associado.

name

string

O nome da pasta de trabalho