Admin - Groups UpdateGroupAsAdmin

汇报指定工作区的属性。

若要取消分配 Log Analytics 工作区,请将值显式设置为 null。

权限

用户必须具有管理员权限 (,例如Office 365全局管理员或 Power BI 服务管理员) 。

所需范围

Tenant.ReadWrite.All

限制

  • 每小时最多 200 个请求。
  • 对于共享容量,只能更新名称和说明。
  • 对于高级容量,只能更新名称、说明、defaultDatasetStorageFormat 和 Log Analytics 工作区。
  • 该名称在组织内必须是唯一的。

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

URI 参数

名称 必需 类型 说明
groupId
path True

string

uuid

工作区 ID

请求正文

名称 必需 类型 说明
id True

string

工作区 ID

capacityId

string

容量 ID

dashboards

AdminDashboard[]

属于组的仪表板

dataflowStorageId

string

Power BI 数据流存储帐户 ID

dataflows

AdminDataflow[]

属于组的数据流

datasets

AdminDataset[]

属于组的数据集

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作区中的默认数据集存储格式。 仅当 为 时 isOnDedicatedCapacity 返回 true

description

string

组说明

hasWorkspaceLevelSettings

boolean

工作区是否具有自定义设置

isOnDedicatedCapacity

boolean

是否将组分配到专用容量

isReadOnly

boolean

组是否为只读

logAnalyticsWorkspace

AzureResource

分配给组的 Log Analytics 工作区。 仅当检索单个组时,才会返回此值。

name

string

组名称

pipelineId

string

工作区分配到的部署管道 ID。

reports

AdminReport[]

属于组的报表

state

string

组状态

type

GroupType

要返回的组的类型。

users

GroupUser[]

(空值) 属于组的用户及其访问权限。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取组用户身份管理员 API 调用或带 getArtifactUsers 参数的 PostWorkspaceInfo API 调用,检索有关 Power BI 项 ((例如报表或仪表板) )的用户信息。

workbooks

Workbook[]

属于组的工作簿

响应

名称 类型 说明
200 OK

确定

示例

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

Sample Request

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"
  }
}

Sample Response

Example of unassigning Log Analytics workspace

Sample Request

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

Sample Response

Example of updating group description and defaultDatasetStorageFormat

Sample Request

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"
}

Sample Response

定义

名称 说明
AdminDashboard

管理员 API 返回的 Power BI 仪表板。 API 返回以下仪表板属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

AdminDataflow

管理员 API 返回的数据流的元数据。 下面是可能为数据流返回的属性列表。 根据调用的 API、调用方权限和 Power BI 数据库中数据的可用性,仅返回一部分属性。

AdminDataset

管理员 API 返回的 Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

AdminGroup

管理员 API 返回的 Power BI 组

AdminReport

管理员 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

AdminTile

管理员 API 返回的 Power BI 磁贴。

AzureResource

详细说明用户拥有的 Azure 资源(例如 Log Analytics 工作区)的响应。

DashboardUser

仪表板的 Power BI 用户访问权限条目

DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

DataflowUser

数据流的 Power BI 用户访问权限条目

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

DatasetUser

数据集的 Power BI 用户访问权限条目

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

DefaultDatasetStorageFormat

组中的默认数据集存储格式

DependentDataflow

依赖于 Power BI 的数据流

Encryption

数据集的加密信息

EncryptionStatus

数据集加密状态

GroupType

组类型

GroupUser

有权访问工作区的 Power BI 用户

GroupUserAccessRight

用户对工作区拥有的访问权限 (权限级别)

PrincipalType

主体类型

ReportUser

报表的 Power BI 用户访问权限条目

ReportUserAccessRight

用户对报表的访问权限 (权限级别)

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

Subscription

Power BI 项 (的电子邮件订阅,例如报表或仪表板)

SubscriptionUser

Power BI 电子邮件订阅用户

Workbook

Power BI 工作簿

AdminDashboard

管理员 API 返回的 Power BI 仪表板。 API 返回以下仪表板属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
appId

string

应用 ID,仅当仪表板属于应用时才返回

displayName

string

仪表板的显示名称

embedUrl

string

仪表板的嵌入 URL

id

string

仪表板 ID

isReadOnly

boolean

仪表板是否为只读

subscriptions

Subscription[]

(空值) Power BI 项 ((如报表或仪表板) )的订阅详细信息。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取报表订阅作为 管理员 API 调用来检索 Power BI 报表的订阅信息。

tiles

AdminTile[]

属于仪表板的磁贴

users

DashboardUser[]

(仪表板用户访问详细信息) 空值。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取仪表板用户作为 管理员 API 调用或使用 参数的 PostWorkspaceInfo API 调用来检索 Power BI 仪表板上的用户getArtifactUsers信息。

webUrl

string

仪表板的 Web URL

workspaceId

string

工作区 ID (仪表板的 GUID) 。 此属性仅在 GetDashboardsAsAdmin 中返回。

AdminDataflow

管理员 API 返回的数据流的元数据。 下面是可能为数据流返回的属性列表。 根据调用的 API、调用方权限和 Power BI 数据库中数据的可用性,仅返回一部分属性。

名称 类型 说明
configuredBy

string

数据流所有者

description

string

数据流说明

modelUrl

string

数据流定义文件的 URL (model.json)

modifiedBy

string

修改数据流的用户

modifiedDateTime

string

上次修改数据流的日期和时间

name

string

数据流名称

objectId

string

数据流 ID

users

DataflowUser[]

(数据流用户访问详细信息) 空值。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取数据流用户作为 管理员 API 调用或带 参数的 PostWorkspaceInfo API 调用来检索有关 Power BI 数据流的用户getArtifactUser信息。

workspaceId

string

数据流工作区 ID。

AdminDataset

管理员 API 返回的 Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
ContentProviderType

string

数据集的内容提供程序类型

CreateReportEmbedURL

string

数据集创建报表嵌入 URL

CreatedDate

string

数据集创建日期和时间

Encryption

Encryption

数据集加密信息。 仅在指定 时 $expand 适用。

IsEffectiveIdentityRequired

boolean

数据集是否需要有效的标识,必须在 GenerateToken API 调用中发送该标识。

IsEffectiveIdentityRolesRequired

boolean

是否在 Power BI .pbix 文件中定义行级别安全性。 如果是这样,则必须指定角色。

IsInPlaceSharingEnabled

boolean

是否可以与外部用户共享数据集,以在其自己的租户中使用

IsOnPremGatewayRequired

boolean

数据集是否需要本地数据网关

IsRefreshable

boolean

数据集是否可刷新。 Power BI 可刷新数据集是至少刷新一次或存在有效刷新计划的数据集。

QnaEmbedURL

string

数据集 Q&A 嵌入 URL

addRowsAPIEnabled

boolean

数据集是否允许添加新行

configuredBy

string

数据集所有者

description

string

数据集说明

id

string

数据集 ID

name

string

数据集名称

queryScaleOutSettings

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

targetStorageMode

string

数据集存储模式

upstreamDataflows

DependentDataflow[]

此项目所依赖的所有数据流的列表

users

DatasetUser[]

(数据集用户访问详细信息) 空值。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取数据集用户作为 管理员 API 或带 getArtifactUsers 参数的 PostWorkspaceInfo API,检索有关 Power BI 项 (的用户信息,例如报表或仪表板)

webUrl

string

数据集的 Web URL

workspaceId

string

数据集工作区 ID。 此属性仅在 GetDatasetsAsAdmin 中返回。

AdminGroup

管理员 API 返回的 Power BI 组

名称 类型 说明
capacityId

string

容量 ID

dashboards

AdminDashboard[]

属于组的仪表板

dataflowStorageId

string

Power BI 数据流存储帐户 ID

dataflows

AdminDataflow[]

属于组的数据流

datasets

AdminDataset[]

属于组的数据集

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作区中的默认数据集存储格式。 仅在 为 时 isOnDedicatedCapacity 返回 true

description

string

组说明

hasWorkspaceLevelSettings

boolean

工作区是否具有自定义设置

id

string

工作区 ID

isOnDedicatedCapacity

boolean

是否将组分配给专用容量

isReadOnly

boolean

组是否为只读

logAnalyticsWorkspace

AzureResource

分配给组的 Log Analytics 工作区。 仅当检索单个组时,才会返回此值。

name

string

组名称

pipelineId

string

工作区分配到的部署管道 ID。

reports

AdminReport[]

属于组的报表

state

string

组状态

type

GroupType

要返回的组的类型。

users

GroupUser[]

(空值) 属于组的用户及其访问权限。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取组用户身份管理员 API 调用或带 getArtifactUsers 参数的 PostWorkspaceInfo API 调用,检索有关 Power BI 项 ((例如报表或仪表板) )的用户信息。

workbooks

Workbook[]

属于组的工作簿

AdminReport

管理员 API 返回的 Power BI 报表。 API 返回以下报表属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
appId

string

仅当报表属于应用时才返回的应用 ID

createdBy

string

报表所有者。 仅适用于 2019 年 6 月之后创建的报表。

createdDateTime

string

报表创建日期和时间

datasetId

string

报表的数据集 ID

description

string

报表说明

embedUrl

string

报表的嵌入 URL

id

string

报表 ID

isOwnedByMe

boolean

确定报表是否由当前用户创建。

modifiedBy

string

最后一个修改报表的用户

modifiedDateTime

string

上次修改报表的日期和时间

name

string

报表的名称

originalReportId

string

将工作区发布为应用时的实际报表 ID。

reportType enum:
  • PaginatedReport
  • PowerBIReport

报表类型

subscriptions

Subscription[]

(空值) Power BI 项 ((如报表或仪表板) )的订阅详细信息。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取报表订阅作为 管理员 API 调用来检索 Power BI 报表的订阅信息。

users

ReportUser[]

() Power BI 报表的用户访问详细信息的空值。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取报表用户作为 管理员 API 调用或使用 参数的 PostWorkspaceInfo API 调用来检索 Power BI 报表上的用户getArtifactUsers信息。

webUrl

string

报表的 Web URL

workspaceId

string

工作区 ID (报表的 GUID) 。 此属性仅在 GetReportsAsAdmin 中返回。

AdminTile

管理员 API 返回的 Power BI 磁贴。

名称 类型 说明
colSpan

integer

磁贴跨度列数

datasetId

string

数据集 ID。 仅适用于从报表或使用数据集创建的磁贴,例如 Q&A 磁贴。

embedData

string

磁贴的嵌入数据

embedUrl

string

磁贴的嵌入 URL

id

string

磁贴 ID

reportId

string

报表 ID。 仅适用于从报表创建的磁贴。

rowSpan

integer

磁贴跨度行数

title

string

磁贴的显示名称

AzureResource

详细说明用户拥有的 Azure 资源(例如 Log Analytics 工作区)的响应。

名称 类型 说明
id

string

Power BI 中资源的标识符。

resourceGroup

string

资源所在的订阅中的资源组。

resourceName

string

资源的名称。

subscriptionId

string

资源所在的 Azure 订阅。

DashboardUser

仪表板的 Power BI 用户访问权限条目

名称 类型 说明
dashboardUserAccessRight

DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

DashboardUserAccessRight

用户对仪表板 (权限级别的访问权限)

名称 类型 说明
None

string

对 仪表板 中的内容没有权限

Owner

string

授予对报表中内容的读取、写入和重新共享访问权限

Read

string

授予对 仪表板 中内容的读取访问权限

ReadCopy

string

授予对 仪表板 中内容的读取和复制访问权限

ReadReshare

string

授予对 仪表板 中内容的读取和重新共享访问权限

ReadWrite

string

授予对 仪表板 中内容的读取和写入访问权限

DataflowUser

数据流的 Power BI 用户访问权限条目

名称 类型 说明
DataflowUserAccessRight

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

DataflowUserAccessRight

用户对数据流的访问权限 (权限级别)

名称 类型 说明
None

string

删除对数据流中内容的权限

Owner

string

授予对数据流中内容的读取、写入和重新共享访问权限

Read

string

授予对数据流中内容的读取访问权限

ReadReshare

string

授予对数据流中内容的读取和重新共享访问权限

ReadWrite

string

授予对数据流中内容的读取和写入访问权限

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

名称 类型 说明
autoSyncReadOnlyReplicas

boolean

数据集是否自动同步只读副本

maxReadOnlyReplicas

integer

数据集的最大只读副本数 (0-64,自动副本数为 -1)

DatasetUser

数据集的 Power BI 用户访问权限条目

名称 类型 说明
datasetUserAccessRight

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

名称 类型 说明
None

string

删除对数据集中内容的权限

Read

string

授予对数据集中内容的读取访问权限

ReadExplore

string

授予对数据集中内容的读取和浏览访问权限

ReadReshare

string

授予对数据集中内容的读取和重新共享访问权限

ReadReshareExplore

string

授予对数据集中内容的读取、重新共享和浏览访问权限

ReadWrite

string

授予对数据集中内容的读取和写入访问权限

ReadWriteExplore

string

授予对数据集中内容的读取、写入和浏览访问权限

ReadWriteReshare

string

授予对数据集中内容的读取、写入和重新共享访问权限

ReadWriteReshareExplore

string

授予对数据集中内容的读取、写入、重新共享和浏览访问权限

DefaultDatasetStorageFormat

组中的默认数据集存储格式

名称 类型 说明
Large

string

大型数据集存储格式

Small

string

小型数据集存储格式

DependentDataflow

依赖于 Power BI 的数据流

名称 类型 说明
groupId

string

目标组 ID

targetDataflowId

string

目标数据流 ID

Encryption

数据集的加密信息

名称 类型 说明
EncryptionStatus

EncryptionStatus

数据集加密状态

EncryptionStatus

数据集加密状态

名称 类型 说明
InSyncWithWorkspace

string

支持加密,并且与加密设置同步

NotInSyncWithWorkspace

string

支持加密,但与加密设置不同步

NotSupported

string

此数据集不支持加密

Unknown

string

由于数据集损坏,加密状态未知

GroupType

组类型

名称 类型 说明
Group

string

共享工作区的 V1 版本。 Microsoft 将所有工作区迁移到最新版本的共享工作区时,将弃用此类型的工作区

Personal

string

适用于 SharePoint 列表和 OneDrive 集成的特殊工作区类型

PersonalGroup

string

“我的工作区”,也称为个人工作区

Workspace

string

用于与组织中的其他用户共享内容的共享工作区或简单工作区

GroupUser

有权访问工作区的 Power BI 用户

名称 类型 说明
displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

groupUserAccessRight

GroupUserAccessRight

访问权限 (用户对工作区拥有的权限级别)

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

GroupUserAccessRight

用户对工作区拥有的访问权限 (权限级别)

名称 类型 说明
Admin

string

工作区内容的管理员权限

Contributor

string

读取和浏览 (ReadExplore) 工作区内容的访问权限

Member

string

读取、重新共享和浏览 (ReadReshareExplore) 工作区内容的访问权限

None

string

无法访问工作区内容

Viewer

string

只读 (对工作区内容的读取) 访问权限

PrincipalType

主体类型

名称 类型 说明
App

string

服务主体类型

Group

string

组主体类型

None

string

无主体类型。 用于整个组织级别的访问。

User

string

用户主体类型

ReportUser

报表的 Power BI 用户访问权限条目

名称 类型 说明
displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

reportUserAccessRight

ReportUserAccessRight

用户对报表的访问权限 (权限级别)

userType

string

用户的类型。

ReportUserAccessRight

用户对报表的访问权限 (权限级别)

名称 类型 说明
None

string

对报表中的内容没有权限

Owner

string

授予对报表中内容的读取、写入和重新共享访问权限

Read

string

授予对报表中内容的读取访问权限

ReadCopy

string

授予对报表中内容的读取和复制访问权限

ReadReshare

string

授予对报表中内容的读取和重新共享访问权限

ReadWrite

string

授予对报表中内容的读取和写入访问权限

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

名称 类型 说明
displayName

string

服务主体配置文件名称

id

string

服务主体配置文件 ID

Subscription

Power BI 项 (的电子邮件订阅,例如报表或仪表板)

名称 类型 说明
artifactDisplayName

string

订阅的 Power BI 项 (的名称,例如报表或仪表板)

artifactId

string

订阅的 Power BI 项 (的 ID,例如报表或仪表板)

artifactType

string

Power BI 项的类型 (例如 ReportDashboardDataset)

attachmentFormat

string

电子邮件订阅中附加的报表的格式

endDate

string

电子邮件订阅的结束日期和时间

frequency

string

电子邮件订阅的频率

id

string

订阅 ID

isEnabled

boolean

是否启用电子邮件订阅

linkToContent

boolean

电子邮件订阅中是否存在订阅链接

previewImage

boolean

电子邮件订阅中是否存在报表的屏幕截图

startDate

string

电子邮件订阅的开始日期和时间

subArtifactDisplayName

string

订阅的 Power BI 项的页面名称(如果它是报表)。

title

string

应用名称

users

SubscriptionUser[]

每个电子邮件订阅者的详细信息。 使用获取用户订阅作为 管理员 API 调用时,返回的值是空数组, (null) 。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用将报表订阅作为管理员获取或获取仪表板订阅作为管理员 API 调用来检索 Power BI 报表或仪表板上的订阅信息。

SubscriptionUser

Power BI 电子邮件订阅用户

名称 类型 说明
displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

Workbook

Power BI 工作簿

名称 类型 说明
datasetId

string

与工作簿关联的数据集的 ID。 仅当工作簿具有关联的数据集时适用。

name

string

工作簿名称