共用方式為


Admin - Groups UpdateGroupAsAdmin

更新指定工作區的屬性。

若要取消指派 Log Analytics 工作區,請明確將值設定為 null。

權限

用戶必須具有系統管理員許可權(例如 Office 365 全域管理員或 Power BI 服務管理員)。

必要範圍

Tenant.ReadWrite.All

局限性

  • 每小時最多 200 個要求。
  • 針對共用容量,只能更新名稱和描述。
  • 針對 Premium 容量,只能更新名稱、描述、defaultDatasetStorageFormat 和 Log Analytics 工作區。
  • 名稱在組織內必須是唯一的。

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

URI 參數

名稱 位於 必要 類型 Description
groupId
path True

string

uuid

工作區標識碼

要求本文

名稱 必要 類型 Description
id True

string

工作區標識碼

capacityId

string

容量標識碼

dashboards

AdminDashboard[]

屬於群組的儀錶板

dataflowStorageId

string

Power BI 數據流記憶體帳戶標識碼

dataflows

AdminDataflow[]

屬於群組的數據流

datasets

AdminDataset[]

屬於群組的數據集

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作區中的預設數據集記憶體格式。 只有在 isOnDedicatedCapacitytrue 時才會傳回

description

string

群組描述

hasWorkspaceLevelSettings

boolean

工作區是否有自定義設定

isOnDedicatedCapacity

boolean

群組是否已指派給專用容量

isReadOnly

boolean

群組是否為唯讀

logAnalyticsWorkspace

AzureResource

指派給群組的Log Analytics工作區。 只有在擷取單一群組時,才會傳回這個值。

name

string

組名

pipelineId

string

指派工作區的部署管線標識碼。

reports

AdminReport[]

屬於群組的報表

state

string

群組狀態

type

GroupType

要傳回的群組類型。

users

GroupUser[]

(空白值)屬於群組的使用者及其訪問許可權。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得群組使用者身分 API 呼叫,或使用 getArtifactUsers 參數 PostWorkspaceInfo API 呼叫,來擷取 Power BI 專案的使用者資訊(例如報表或儀錶板)。

workbooks

Workbook[]

屬於群組的活頁簿

回應

名稱 類型 Description
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

定義

名稱 Description
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 資料庫中數據的可用性。

名稱 類型 Description
appId

string

只有在儀錶板屬於應用程式時,才會傳回應用程式識別符

displayName

string

儀錶板的顯示名稱

embedUrl

string

儀錶板的內嵌 URL

id

string

儀錶板標識碼

isReadOnly

boolean

儀錶板是否為唯讀

subscriptions

Subscription[]

(空白值)Power BI 專案的訂用帳戶詳細數據(例如報表或儀錶板)。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表訂閱做為系統管理員 API 呼叫,來擷取 Power BI 報表的訂閱資訊。

tiles

AdminTile[]

屬於儀錶板的磚

users

DashboardUser[]

(空白值)儀錶板使用者存取詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得儀錶板使用者做為系統管理員 API 呼叫,或使用 getArtifactUsers 參數 PostWorkspaceInfo API 呼叫,來擷取 Power BI 儀錶板上的用戶資訊。

webUrl

string

儀錶板的Web URL

workspaceId

string

儀錶板的工作區標識碼 (GUID)。 此屬性只會在 GetDashboardsAsAdmin 中傳回。

AdminDataflow

系統管理員 API 所傳回之數據流的元數據。 以下是可能針對數據流傳回的屬性清單。 根據呼叫的 API、呼叫端許可權和 Power BI 資料庫中數據的可用性,只會傳回屬性的子集。

名稱 類型 Description
configuredBy

string

數據流擁有者

description

string

數據流描述

modelUrl

string

資料串流定義檔的網址(model.json)

modifiedBy

string

修改數據流的使用者

modifiedDateTime

string

上次修改數據流的日期和時間

name

string

數據流名稱

objectId

string

數據流標識碼

users

DataflowUser[]

(空白值)數據流使用者存取詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得數據流使用者做為系統管理員 API 呼叫,或使用 getArtifactUser 參數 PostWorkspaceInfo API 呼叫來擷取 Power BI 數據流的用戶資訊。

workspaceId

string

數據流工作區標識碼。

AdminDataset

系統管理員 API 所傳回的 Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。 子集取決於呼叫的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。

名稱 類型 Description
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

當數據集最近重新整理或設定為自動重新整理時,此欄位會傳回 true,且連線模式特別設定為 [匯入]。 不論數據集是手動重新整理還是設定自動重新整理,值都會傳回其他連接模式的 false,例如 'DirectQuery' 和 'LiveConnection'。

QnaEmbedURL

string

數據集 Q&內嵌 URL

addRowsAPIEnabled

boolean

數據集是否允許新增數據列

configuredBy

string

數據集擁有者

description

string

數據集描述

id

string

數據集標識碼

name

string

數據集名稱

queryScaleOutSettings

DatasetQueryScaleOutSettings

查詢數據集的向外延展設定

targetStorageMode

string

數據集儲存模式

upstreamDataflows

DependentDataflow[]

此專案相依的所有資料流清單

users

DatasetUser[]

(空白值)數據集使用者存取詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得數據集使用者做為 Admin API,或使用 getArtifactUsers 參數的 PostWorkspaceInfo API 來擷取 Power BI 專案的使用者資訊(例如報表或儀錶板)。

webUrl

string

數據集的 Web URL

workspaceId

string

數據集工作區標識碼。 此屬性只會在 GetDatasetsAsAdmin 中傳回。

AdminGroup

由系統管理員 API 傳回的 Power BI 群組

名稱 類型 Description
capacityId

string

容量標識碼

dashboards

AdminDashboard[]

屬於群組的儀錶板

dataflowStorageId

string

Power BI 數據流記憶體帳戶標識碼

dataflows

AdminDataflow[]

屬於群組的數據流

datasets

AdminDataset[]

屬於群組的數據集

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作區中的預設數據集記憶體格式。 只有在 isOnDedicatedCapacitytrue 時才會傳回

description

string

群組描述

hasWorkspaceLevelSettings

boolean

工作區是否有自定義設定

id

string

工作區標識碼

isOnDedicatedCapacity

boolean

群組是否已指派給專用容量

isReadOnly

boolean

群組是否為唯讀

logAnalyticsWorkspace

AzureResource

指派給群組的Log Analytics工作區。 只有在擷取單一群組時,才會傳回這個值。

name

string

組名

pipelineId

string

指派工作區的部署管線標識碼。

reports

AdminReport[]

屬於群組的報表

state

string

群組狀態

type

GroupType

要傳回的群組類型。

users

GroupUser[]

(空白值)屬於群組的使用者及其訪問許可權。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得群組使用者身分 API 呼叫,或使用 getArtifactUsers 參數 PostWorkspaceInfo API 呼叫,來擷取 Power BI 專案的使用者資訊(例如報表或儀錶板)。

workbooks

Workbook[]

屬於群組的活頁簿

AdminReport

系統管理員 API 所傳回的 Power BI 報表。 API 會傳回下列報表屬性清單的子集。 子集取決於呼叫的 API、呼叫端許可權,以及 Power BI 資料庫中數據的可用性。

名稱 類型 Description
appId

string

只有在報表屬於應用程式時,才會傳回應用程式標識碼

createdBy

string

報表擁有者。 僅適用於在 2019 年 6 月之後建立的報告。

createdDateTime

string

報表建立日期和時間

datasetId

string

報表的數據集標識碼

description

string

報表描述

embedUrl

string

報表的內嵌 URL

id

string

報表標識碼

isOwnedByMe

boolean

判斷報表是否由目前使用者建立。

modifiedBy

string

修改報表的最後一個使用者

modifiedDateTime

string

上次修改報表的日期和時間

name

string

報表的名稱

originalReportId

string

當工作區發佈為應用程式時,實際的報表標識符。

reportType enum:
  • PaginatedReport
  • PowerBIReport

報表類型

subscriptions

Subscription[]

(空白值)Power BI 專案的訂用帳戶詳細數據(例如報表或儀錶板)。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表訂閱做為系統管理員 API 呼叫,來擷取 Power BI 報表的訂閱資訊。

users

ReportUser[]

(空白值)使用者存取 Power BI 報表的詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表使用者做為系統管理員 API 呼叫,或使用 getArtifactUsers 參數來擷取 Power BI 報表上的使用者資訊,或 PostWorkspaceInfo API 呼叫。

webUrl

string

報表的Web URL

workspaceId

string

報表的工作區標識碼 (GUID)。 此屬性只會在 GetReportsAsAdmin 中傳回。

AdminTile

系統管理員 API 所傳回的 Power BI 圖格。

名稱 類型 Description
colSpan

integer

磚範圍數據行的數目

datasetId

string

數據集標識碼。 僅適用於從報表或使用數據集建立的磚,例如 Q&A 磚。

embedData

string

磚的內嵌數據

embedUrl

string

圖格的內嵌 URL

id

string

磚標識碼

reportId

string

報表標識碼。 僅適用於從報表建立的磚。

rowSpan

integer

磚範圍數據列的數目

title

string

磚的顯示名稱

AzureResource

詳細說明用戶擁有的 Azure 資源,例如 Log Analytics 工作區的回應。

名稱 類型 Description
id

string

Power BI 內資源的標識碼。

resourceGroup

string

資源所在訂用帳戶內的資源群組。

resourceName

string

資源的名稱。

subscriptionId

string

資源所在的 Azure 訂用帳戶。

DashboardUser

儀錶板的Power BI使用者存取權專案

名稱 類型 Description
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

使用者對於儀表板的存取權 (權限等級)

名稱 類型 Description
None

string

儀錶板中的內容沒有許可權

Owner

string

授與報表中內容的讀取、寫入和重新共用存取權

Read

string

授與儀錶板中內容的讀取許可權

ReadCopy

string

授與儀錶板中內容的讀取和複製存取權

ReadReshare

string

授與儀錶板中內容的讀取和重新共用存取權

ReadWrite

string

授與儀錶板中內容的讀取和寫入存取權

DataflowUser

數據流的Power BI使用者存取權專案

名稱 類型 Description
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

使用者對於資料流的存取權 (權限等級)

名稱 類型 Description
None

string

拿掉資料流中內容的許可權

Owner

string

授與數據流中內容的讀取、寫入和重新共用存取權

Read

string

授與數據流中內容的讀取許可權

ReadReshare

string

授與數據流中內容的讀取和重新共用存取權

ReadWrite

string

授與數據流中內容的讀取和寫入存取權

DatasetQueryScaleOutSettings

查詢數據集的向外延展設定

名稱 類型 Description
autoSyncReadOnlyReplicas

boolean

數據集是否自動同步只讀複本

maxReadOnlyReplicas

integer

資料集的唯讀複本數目上限(0-64,-1 自動復本數目)

DatasetUser

數據集的 Power BI 使用者存取權專案

名稱 類型 Description
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

使用者對於資料集的存取權(權限等級)

名稱 類型 Description
None

string

拿掉資料集中內容的許可權

Read

string

授與數據集中內容的讀取許可權

ReadExplore

string

授與讀取和探索數據集中內容的存取權

ReadReshare

string

授與讀取和重新共享數據集中內容的存取權

ReadReshareExplore

string

授與讀取、重新共用和探索數據集中內容的存取權

ReadWrite

string

授與數據集中內容的讀取和寫入存取權

ReadWriteExplore

string

授與數據集中內容的讀取、寫入和探索存取權

ReadWriteReshare

string

授與數據集中內容的讀取、寫入和重新共用存取權

ReadWriteReshareExplore

string

授與讀取、寫入、重新共用和探索數據集中內容的存取權

DefaultDatasetStorageFormat

群組中的預設數據集記憶體格式

名稱 類型 Description
Large

string

大型數據集記憶體格式

Small

string

小型數據集記憶體格式

DependentDataflow

Power BI 相依數據流

名稱 類型 Description
groupId

string

目標組標識碼

targetDataflowId

string

目標數據流標識碼

Encryption

數據集的加密資訊

名稱 類型 Description
EncryptionStatus

EncryptionStatus

數據集加密狀態

EncryptionStatus

數據集加密狀態

名稱 類型 Description
InSyncWithWorkspace

string

支援加密,且與加密設定同步

NotInSyncWithWorkspace

string

支援加密,但未與加密設定同步

NotSupported

string

此數據集不支援加密

Unknown

string

由於數據集損毀,加密狀態不明

GroupType

群組類型

名稱 類型 Description
Group

string

V1 版的共用工作區。 此類型的工作區將會淘汰,因為Microsoft將所有工作區移轉至最新版本的共用工作區

Personal

string

適用於 SharePoint 列表和 OneDrive 整合的特殊工作區類型

PersonalGroup

string

“My workspace”,也稱為個人工作區

Workspace

string

用來與組織中的其他使用者共用內容的共用工作區或簡單工作區

GroupUser

可存取工作區的Power BI 使用者

名稱 類型 Description
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

使用者在工作區上擁有的存取權限(權限等級)

名稱 類型 Description
Admin

string

工作區內容的系統管理員許可權

Contributor

string

讀取和探索工作區內容的存取權

Member

string

讀取、重新共用和探索工作區內容的訪問許可權

None

string

沒有工作區內容的存取權

Viewer

string

工作區內容的唯讀存取權

PrincipalType

主體類型

名稱 類型 Description
App

string

服務主體類型

Group

string

群組主體類型

None

string

沒有主體類型。 用於整個組織層級存取。

User

string

用戶主體類型

ReportUser

報表的 Power BI 使用者存取權專案

名稱 類型 Description
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

使用者對於報表的存取權 (權限等級)

名稱 類型 Description
None

string

報表中的內容沒有許可權

Owner

string

授與報表中內容的讀取、寫入和重新共用存取權

Read

string

授與報表中內容的讀取許可權

ReadCopy

string

授與報表中內容的讀取和複製存取權

ReadReshare

string

授與讀取和重新共享報表中內容的存取權

ReadWrite

string

授與報表中內容的讀取和寫入存取權

ServicePrincipalProfile

Power BI 服務主體配置檔。 僅與 Power BI Embedded 多租使用者解決方案相關。

名稱 類型 Description
displayName

string

服務主體配置檔名稱

id

string

服務主體配置檔識別碼

Subscription

Power BI 專案的電子郵件訂閱(例如報表或儀錶板)

名稱 類型 Description
artifactDisplayName

string

已訂閱 Power BI 項目的名稱(例如報表或儀錶板)

artifactId

string

已訂閱 Power BI 專案的識別碼(例如報表或儀錶板)

artifactType

string

Power BI 專案的類型(例如 ReportDashboardDataset

attachmentFormat

string

電子郵件訂閱中所附加報表的格式

endDate

string

電子郵件訂閱的結束日期和時間

frequency

string

電子郵件訂閱的頻率

id

string

訂用帳戶標識碼

isEnabled

boolean

是否啟用電子郵件訂閱

linkToContent

boolean

電子郵件訂閱中是否存在訂用帳戶連結

previewImage

boolean

報表的螢幕快照是否存在於電子郵件訂閱中

startDate

string

電子郵件訂閱的開始日期和時間

subArtifactDisplayName

string

訂閱的Power BI項目的頁面名稱,如果是報表。

title

string

應用程式名稱

users

SubscriptionUser[]

每個電子郵件訂閱者的詳細數據。 使用 取得使用者訂用帳戶作為系統管理員 API 呼叫時,傳回的值是空陣列 (null)。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得報表訂閱做為系統管理員取得儀錶板訂閱做為系統管理員 API 呼叫,來擷取 Power BI 報表或儀錶板上的訂用帳戶資訊。

SubscriptionUser

Power BI 電子郵件訂閱使用者

名稱 類型 Description
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 活頁簿

名稱 類型 Description
datasetId

string

與活頁簿相關聯的數據集標識碼。 只有在活頁簿具有相關聯的數據集時才會套用。

name

string

活頁簿名稱