Admin - WorkspaceInfo GetScanResult

參考

Service:: Power BI REST APIs

API Version:: v1.0

取得指定掃描的掃描結果。

只有在成功呼叫 GetScanStatus API 之後，才進行此 API 呼叫。掃描結果將保留 24 小時。

權限

用戶必須具有系統管理員許可權 (，例如 Microsoft 365 全域管理員或 Power BI 服務管理員) 或使用服務主體進行驗證。

在服務主體驗證下執行時，應用程式不得在 Azure 入口網站中設定Power BI的任何系統管理員同意許可權。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取令牌進行驗證時才相關。使用透過服務主體進行驗證時，不得存在。

限制

每小時最多500個要求。

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{scanId}

URI 參數

名稱	位於	必要	類型	Description
scanId	path	True	string uuid	掃描標識碼，包含在來自工作區的回應或觸發掃描的管理員 - WorkspaceInfo PostWorkspaceInfo API 呼叫中。

回應

名稱	類型	Description
200 OK	WorkspaceInfoResponse	確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

Status code:: 200

{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [
            {
              "name": "DW_Revenues",
              "columns": [
                {
                  "name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
                  "dataType": "Int64",
                  "isHidden": true
                }
              ],
              "measures": [
                {
                  "name": "MyMeasure",
                  "expression": "CALCULATE(SELECTEDVALUE('DW_Revenues DW_RevenuesTestToBeDeleted'[Numbers])*10)",
                  "description": "My measure",
                  "isHidden": false
                }
              ],
              "isHidden": false,
              "description": "My table",
              "source": [
                {
                  "expression": "let\n    Source = Revenues,\n    Param = RevenuesParam\nin\n    Source"
                }
              ]
            }
          ],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "expressions": [
            {
              "name": "Revenues",
              "description": "revenues",
              "expression": "let\n    Source = Sql.Database(\"sqlserver.database.windows.net\", \"DB\"),\n    RevenuesTable = Source{[Schema=\"DB_SCHEMA\",Item=\"DB_SCHEMA_ITEM\"]}[Data]\nin\n    RevenuesTable"
            },
            {
              "name": "RevenuesParam",
              "description": "revenues param",
              "expression": "\"revenues param value\" meta [IsParameterQuery=true, Type=\"Text\", IsParameterQueryRequired=true]"
            }
          ],
          "roles": [
            {
              "name": "Teams",
              "modelPermission": "Read",
              "members": [
                {
                  "memberName": "john@contoso.com",
                  "memberId": "ee96296b-fb71-4f65-a8af-c0ec5a7daced",
                  "memberType": "User",
                  "identityProvider": "AzureAD"
                },
                {
                  "memberName": "group@contoso.com",
                  "memberId": "0a1cdbc3-f82c-4001-8b96-be04ae9d25a3",
                  "memberType": "Group",
                  "identityProvider": "AzureAD"
                }
              ],
              "tablePermissions": [
                {
                  "name": "DW_Revenues DW_RevenuesTest",
                  "filterExpression": "[InTeams] = \"True\""
                }
              ]
            }
          ],
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "misconfiguredDatasourceUsages": [
            {
              "datasourceInstanceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "datamarts": [
        {
          "id": "9df8d63c-db5b-44c3-a8e3-9f8c8ec1eec2",
          "name": "MyDatamart",
          "description": "SQL datamart",
          "type": "Sql",
          "configuredBy": "john@contoso.com",
          "configuredById": "5c9f8c24-2a94-4fd2-a105-9a8b096cdsew",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "UpstreamDataflows": [
            {
              "targetDataflowId": "5c9f8c24-2a94-34fd-a105-9a8b096c4555",
              "groupId": "5c9f8c24-4dsc-4fd2-a105-9a8b096c4fgt"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "Users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User",
              "userType": "User",
              "profile": {
                "id": "45416453",
                "displayName": "John's profile"
              },
              "datamartUserAccessRight": "Read"
            }
          ]
        }
      ],
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "appUserAccessRight": "ReadExplore",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ],
  "misconfiguredDatasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "sqlserver.database.windows.net",
        "database": "dbo.table"
      },
      "datasourceId": "80ec28bc-fe81-43ea-be52-a07a95cfbcab",
      "gatewayId": "505a19c1-4190-4e8e-a4f6-dd72722feced"
    }
  ]
}

定義

名稱	Description
ASMashupExpression	數據集數據表來源
Column	數據集數據行
DashboardUser	儀錶板的Power BI使用者存取權專案
DashboardUserAccessRight	用戶對於儀錶板的存取權 (許可權等級)
DataflowUser	數據流的 Power BI 使用者存取許可權專案
DataflowUserAccessRight	用戶對於數據流的存取權 (許可權等級)
datamartState	Datamart 目前狀態
datamartStatus	Datamart 狀態
datamartType	Datamart 類型
DatamartUser	報表的 Power BI 使用者存取權專案
DatamartUserAccessRight	用戶對於 datamart (許可權等級的存取權)
DatasetUser	數據集的 Power BI 使用者存取權專案
DatasetUserAccessRight	用戶對於數據集的存取權 (許可權等級)
Datasource	Power BI 數據源
DatasourceConnectionDetails	Power BI 數據源聯機詳細數據。請參閱取得數據源或取得群組中的數據源範例。
DatasourceUsage	資料來源使用方式
DefaultDatasetStorageFormat	群組中的預設數據集儲存格式
DependentDataflow	Power BI 相依數據流
DependentDatamart	Power BI 相依的數據超市
DependentDataset	Power BI 相依數據集
EndorsementDetails	Power BI 簽署詳細數據
Expression	數據集表達式
GroupUser	具有工作區存取權的Power BI使用者
GroupUserAccessRight	使用者) 工作區上的許可權層級 (訪問許可權
Measure	Power BI 量值
PrincipalType	主體類型
ReportUser	報表的 Power BI 使用者存取權專案
ReportUserAccessRight	用戶對於報表的存取權， (許可權等級)
Role	數據集 RLS 組態中的角色
RoleMember	角色成員
RoleTablePermission	角色篩選
Row	數據集中的數據列
SensitivityLabel	Power BI 專案 (的敏感度標籤資訊，例如報表或儀錶板)
ServicePrincipalProfile	Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。
Table	數據集數據表
WorkspaceInfo	工作區資訊詳細數據
WorkspaceInfoDashboard	WorkspaceInfo API 傳回的 Power BI 儀錶板。 API 會傳回下列儀錶板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
WorkspaceInfoDataflow	工作區資訊 API 所傳回之數據流的元數據。以下是可能會針對數據流傳回的屬性清單。根據呼叫的 API、呼叫端許可權和 Power BI 資料庫中數據的可用性，只會傳回屬性的子集。
WorkspaceInfoDatamart	工作區資訊 API 所傳回的 Power BI 數據超市。 API 會傳回下列 Datamart 屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
WorkspaceInfoDataset	WorkspaceInfo API 傳回的 Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
WorkspaceInfoReport	工作區資訊 API 傳回的 Power BI 報表。 API 會傳回下列報表屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
WorkspaceInfoResponse	工作區信息回應
WorkspaceInfoTile	WorkspaceInfo API 傳回的 Power BI 圖格

ASMashupExpression

數據集數據表來源

名稱	類型	Description
expression	string	來源表達式

Column

數據集數據行

名稱	類型	Description
dataCategory	string	選擇性。要用於描述此資料列內數據的數據類別目錄的字串值。
dataType	string	數據行數據類型
formatString	string	選擇性。 FORMAT_STRING中指定的數據行格式。
isHidden	boolean	選擇性。數據行是否隱藏。預設為 `false`。
name	string	數據行名稱
sortByColumn	string	選擇性。要用以排序目前資料行的相同資料表中，資料行的字串名稱。
summarizeBy	string	選擇性。要用於摘要此數據行的聚合函數。

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	授與數據流中內容的讀取和寫入存取權

datamartState

Datamart 目前狀態

名稱	類型	Description
Active	string	Datamart 作用中
Deleted	string	已刪除 Datamart
Evicted	string	數據超市已收回
Initialized	string	Datamart 已初始化
Invalid	string	Datamart 的狀態無效
Migrating	string	Datamart 正在移轉

datamartStatus

Datamart 狀態

名稱	類型	Description
Available	string	Datamart 可供使用
Error	string	Datamart 有錯誤狀態
InProgress	string	Datamart 正在進行中
Invalid	string	Datamart 的狀態無效
NoCapacity	string	Datamart 沒有容量
OutOfRegion	string	Datamart 不在區域
SuspendedInCriticalPhase	string	Datamart 在重大階段暫停

datamartType

Datamart 類型

名稱	類型	Description
Dataverse	string	Datamart 是 Dataverse 類型
Datawarehouse	string	Datamart 是 Datawarehouse 類型
Ignore	string	Datamart 沒有類型
Lakehouse	string	Datamart 的類型為 Lakehouse 類型
Sql	string	Datamart 是 Sql 類型
Unset	string	Datamart 類型未設定

DatamartUser

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

名稱	類型	Description
datamartUserAccessRight	DatamartUserAccessRight	用戶對於 datamart (許可權等級的存取權)
displayName	string	主體的顯示名稱
emailAddress	string	使用者的電子郵件地址
graphId	string	Microsoft Graph 中主體的標識碼。僅適用於系統管理員 API。
identifier	string	主體的標識碼
principalType	PrincipalType	主體類型
profile	ServicePrincipalProfile	Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。
userType	string	使用者的型別。

DatamartUserAccessRight

用戶對於 datamart (許可權等級的存取權)

名稱	類型	Description
Explore	string	授與數據超市中內容的探索存取權
None	string	數據超市中的內容沒有許可權
Read	string	授與數據超市中內容的讀取許可權
ReadExplore	string	授與數據超市中內容的讀取和探索存取權
ReadReshare	string	授與數據超市中內容的讀取和重新共用存取權
ReadReshareExplore	string	授與讀取和重新共用及探索 Datamart 中內容的存取權
ReadWrite	string	授與數據超市中內容的讀取和寫入存取權
ReadWriteExplore	string	授與數據超市中內容的讀取和寫入和探索存取權
ReadWriteReshare	string	授與數據超市中內容的讀取和寫入和重新共用存取權
ReadWriteReshareExplore	string	授與讀取和寫入和重新共用及探索 Datamart 中內容的存取權
Reshare	string	授與重新共享數據超市中內容的存取權
Write	string	授與 Datamart 中內容的寫入許可權

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	授與數據集中內容的讀取、寫入、重新共用和探索存取權

Datasource

Power BI 數據源

名稱	類型	Description
connectionDetails	DatasourceConnectionDetails	數據源聯機詳細數據
connectionString	string	() 數據源連接字串已被取代。僅適用於 DirectQuery。
datasourceId	string	系結數據源標識碼，當未系結至閘道時，這是空的
datasourceType	string	數據源類型
gatewayId	string	系結閘道標識碼，在未系結至閘道時是空的。使用閘道叢集時，閘道標識碼是指叢集中第一個) 網關的主要 (，類似於閘道叢集識別碼。
name	string	() 數據源名稱已被取代。僅適用於 DirectQuery。

DatasourceConnectionDetails

Power BI 數據源聯機詳細數據。請參閱取得數據源或取得群組中的數據源範例。

名稱	類型	Description
account	string	線上帳戶
classInfo	string	連接類別資訊
database	string	連接資料庫
domain	string	線上網域
emailAddress	string	線上電子郵件位址
kind	string	線上種類
loginServer	string	線上登入伺服器
path	string	線上路徑
server	string	連接伺服器
url	string	線上 URL

DatasourceUsage

資料來源使用方式

名稱	類型	Description
datasourceInstanceId	string	數據源實例標識碼

DefaultDatasetStorageFormat

群組中的預設數據集儲存格式

名稱	類型	Description
Large	string	大型資料集儲存格式
Small	string	小型數據集儲存格式

DependentDataflow

Power BI 相依數據流

名稱	類型	Description
groupId	string	目標組標識碼
targetDataflowId	string	目標數據流標識碼

DependentDatamart

Power BI 相依的數據超市

名稱	類型	Description
groupId	string	目標組標識碼
targetDatamartId	string	目標數據超市標識碼

DependentDataset

Power BI 相依數據集

名稱	類型	Description
groupId	string	目標組標識碼
targetDatasetId	string	目標數據集標識碼

EndorsementDetails

Power BI 簽署詳細數據

名稱	類型	Description
certifiedBy	string	認證 Power BI 專案的使用者 (，例如報表或儀錶板)
endorsement	string	簽署狀態

Expression

數據集表達式

名稱	類型	Description
description	string	表達式描述
expression	ASMashupExpression	數據集數據表來源
name	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	讀取和探索 (ReadExplore) 工作區內容的存取權
Member	string	讀取、重新共用和探索 (ReadReshareExplore) 工作區內容的訪問許可權
None	string	無法存取工作區內容
Viewer	string	唯讀 (讀取工作區內容的) 存取權

Measure

Power BI 量值

名稱	類型	Description
description	string	選擇性。量值描述。
expression	string	有效的 DAX 運算式
formatString	string	選擇性。字串，描述值在顯示為如 FORMAT_STRING 中所指定時應如何格式化。
isHidden	boolean	選擇性。量值是否隱藏。
name	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	授與報表中內容的讀取和寫入存取權

Role

數據集 RLS 組態中的角色

名稱	類型	Description
members	RoleMember	列出角色成員的陣列
modelPermission	string	角色在數據集上擁有的許可權。例如，讀取
name	string	角色的名稱
tablePermissions	RoleTablePermission	列出為角色定義之所有篩選條件的陣列

RoleMember

角色成員

名稱	類型	Description
identityProvider	string	角色成員識別提供者
memberId	string	識別提供者指派的角色成員 GUID
memberName	string	角色成員的名稱
memberType	string	角色成員類型 (使用者或群組)

RoleTablePermission

角色篩選

名稱	類型	Description
filterExpression	string	篩選篩選條件中指定的數據表的表達式
name	string	篩選中指定的數據表名稱

Row

數據集中的數據列

名稱	類型	Description
id	string	唯一的數據列標識碼

SensitivityLabel

Power BI 專案 (的敏感度標籤資訊，例如報表或儀錶板)

名稱	類型	Description
labelId	string	敏感度標籤標識碼

ServicePrincipalProfile

Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。

名稱	類型	Description
displayName	string	服務主體配置檔名稱
id	string	服務主體配置檔識別碼

Table

數據集數據表

名稱	類型	Description
columns	Column[]	此數據表的數據行架構
description	string	數據表描述
isHidden	boolean	選擇性。此數據集數據表是否隱藏。
measures	Measure[]	此數據表內的量值
name	string	資料表名稱
rows	Row[]	此數據表中的數據列
source	ASMashupExpression[]	數據表來源

WorkspaceInfo

工作區資訊詳細數據

名稱	類型	Description
capacityId	string	工作區容量標識碼
dashboards	WorkspaceInfoDashboard[]	與此工作區相關聯的儀錶板。傳回的儀錶板屬性清單會因不同的 API 呼叫而有所不同，因此您可能會在 API 回應中看到所有儀錶板屬性。
dataRetrievalState	string	工作區數據擷取狀態
dataflows	WorkspaceInfoDataflow[]	與此工作區相關聯的數據流。傳回的數據流屬性清單會因不同的 API 呼叫而有所不同，因此您可能看不到 API 回應中的所有資料流屬性。
datamarts	WorkspaceInfoDatamart[]	與此工作區相關聯的 Datamart。傳回的數據超市屬性清單會因不同的 API 呼叫而有所不同，因此您可能不會在 API 回應中看到所有數據超市屬性。
datasets	WorkspaceInfoDataset[]	與此工作區相關聯的數據集。傳回的數據集屬性清單會因不同的 API 呼叫而有所不同，因此您可能看不到 API 回應中的所有資料集屬性。
defaultDatasetStorageFormat	DefaultDatasetStorageFormat	工作區中的預設數據集儲存格式。只有在為時 `isOnDedicatedCapacity` 才會傳回 `true`
description	string	工作區描述
id	string	工作區物件標識碼
isOnDedicatedCapacity	boolean	工作區是否指派給專用容量
name	string	工作區名稱
reports	WorkspaceInfoReport[]	與此工作區相關聯的報表。傳回的報表屬性清單會因不同的 API 呼叫而有所不同，因此您可能看不到 API 回應中的所有報表屬性。
state	string	工作區狀態
type	string	工作區類型
users	GroupUser[]	具有工作區存取權的使用者。只有在明確要求時，才會傳回清單。若要擷取傳統工作區的使用者清單，請使用 Azure Active Directory 圖形 API。

WorkspaceInfoDashboard

WorkspaceInfo API 傳回的 Power BI 儀錶板。 API 會傳回下列儀錶板屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
appId	string	只有在儀錶板屬於應用程式時，才會傳回應用程式識別符
dataClassification	string	Power BI 專案的數據分類標記 (例如報表或儀錶板)
displayName	string	儀錶板的顯示名稱
id	string	儀錶板標識碼
isReadOnly	boolean	儀錶板是否為唯讀
sensitivityLabel	SensitivityLabel	敏感度標籤
tiles	WorkspaceInfoTile[]	屬於儀錶板的圖格
users	DashboardUser[]	(空白值) 儀錶板使用者存取詳細數據。這個屬性將會從即將發行的承載回應中移除。您可以使用取得儀錶板用戶作為 #D1A0EBCF6A6D64A30A5011AA6BD4B179E API 呼叫，或使用 `getArtifactUsers` 參數來擷取 Power BI 儀錶板上的用戶資訊。

WorkspaceInfoDataflow

工作區資訊 API 所傳回之數據流的元數據。以下是可能會針對數據流傳回的屬性清單。根據呼叫的 API、呼叫端許可權和 Power BI 資料庫中數據的可用性，只會傳回屬性的子集。

名稱	類型	Description
configuredBy	string	數據流擁有者
datasourceUsages	DatasourceUsage[]	數據源使用方式
description	string	數據流描述
endorsementDetails	EndorsementDetails	簽署詳細數據
misconfiguredDatasourceUsages	DatasourceUsage[]	數據源設定錯誤的使用方式
modelUrl	string	數據流定義檔案的 URL (model.json)
modifiedBy	string	修改數據流的使用者
modifiedDateTime	string	上次修改數據流的日期和時間
name	string	數據流名稱
objectId	string	數據流標識碼
sensitivityLabel	SensitivityLabel	敏感度標籤
upstreamDataflows	DependentDataflow[]	此專案的所有數據流清單取決於
upstreamDatamarts	DependentDatamart[]	此專案的所有數據超市清單取決於
users	DataflowUser[]	([空白] 值) 數據流使用者存取詳細數據。這個屬性將會從即將發行的承載回應中移除。您可以使用取得數據流使用者作為管理員 API 呼叫，或使用 `getArtifactUser` 參數來擷取 Power BI 資料流的使用者資訊。

WorkspaceInfoDatamart

工作區資訊 API 所傳回的 Power BI 數據超市。 API 會傳回下列 Datamart 屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
configuredBy	string	Datamart 擁有者的名稱
configuredById	string	Datamart 擁有者的標識碼
datasourceUsages	DatasourceUsage[]	數據源使用方式
description	string	Datamart 描述
endorsementDetails	EndorsementDetails	Datamart 簽署詳細數據
id	string	Datamart識別碼
modifiedBy	string	修改 Datamart 的最後一個使用者
modifiedById	string	修改 Datamart 之最後一位用戶的標識碼
modifiedDateTime	string	上次修改 Datamart 的日期和時間
name	string	Datamart 名稱
sensitivityLabel	SensitivityLabel	Datamart 敏感度標籤
state	datamartState	Datamart 目前狀態
status	datamartStatus	Datamart 狀態
suspendedBatchId	string	datamart 暫停的批次標識碼
type	datamartType	Datamart 類型
upstreamDataflows	DependentDataflow[]	此專案的所有數據流清單取決於
upstreamDatamarts	DependentDatamart[]	此專案的所有數據超市清單取決於
users	DatamartUser[]	使用者存取 Power BI 數據超市的詳細數據。

WorkspaceInfoDataset

WorkspaceInfo API 傳回的 Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
ContentProviderType	string	數據集的內容提供者類型
CreatedDate	string	數據集建立日期和時間
configuredBy	string	數據集擁有者
datasourceUsages	DatasourceUsage[]	數據源使用方式
description	string	數據集描述
endorsementDetails	EndorsementDetails	簽署詳細數據
expressions	Expression[]	數據集表達式
id	string	數據集標識碼
misconfiguredDatasourceUsages	DatasourceUsage[]	數據源設定錯誤的使用方式
name	string	數據集名稱
roles	Role[]	數據集角色
schemaMayNotBeUpToDate	boolean	數據集架構是否可能不是最新的
schemaRetrievalError	string	數據集架構擷取錯誤
sensitivityLabel	SensitivityLabel	敏感度標籤
tables	Table[]	數據集數據表
targetStorageMode	string	數據集儲存模式
upstreamDataflows	DependentDataflow[]	此專案的所有數據流清單取決於
upstreamDatamarts	DependentDatamart[]	此專案的所有數據超市清單取決於
upstreamDatasets	DependentDataset[]	上游數據集
users	DatasetUser[]	(空白值) 數據集使用者存取詳細數據。這個屬性將會從即將發行的承載回應中移除。您可以使用取得數據集使用者做為管理員 API，或使用參數的 PostWorkspaceInfo API`getArtifactUsers`，擷取 Power BI 專案的使用者資訊 (，例如報表或儀錶板) 。

WorkspaceInfoReport

工作區資訊 API 傳回的 Power BI 報表。 API 會傳回下列報表屬性清單的子集。子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
appId	string	只有在報表屬於應用程式時，才會傳回應用程式標識碼
createdBy	string	報表擁有者。僅適用於 2019 年 6 月之後建立的報告。
createdById	string	報表擁有者的標識碼。僅適用於 2019 年 6 月之後建立的報告。
createdDateTime	string	報表建立日期和時間
datasetId	string	報表的數據集標識碼
datasetWorkspaceId	string	只有在相關數據集屬於不同工作區時，才會傳回相關數據集的工作區標識符
description	string	報表描述
endorsementDetails	EndorsementDetails	簽署詳細數據
id	string	報表標識碼
isOwnedByMe	boolean	判斷報表是否由目前使用者建立。
modifiedBy	string	修改報表的最後一位使用者
modifiedById	string	上次修改報表的使用者標識碼
modifiedDateTime	string	上次修改報表的日期和時間
name	string	報表的名稱
originalReportId	string	當工作區發佈為應用程式時的實際報表標識碼。
reportType	enum: PaginatedReport PowerBIReport	報表類型
sensitivityLabel	SensitivityLabel	敏感度標籤
users	ReportUser[]	(空白值) Power BI 報表的使用者存取詳細數據。這個屬性將會從即將發行的承載回應中移除。您可以使用取得報表用戶作為管理員 API 呼叫，或使用 `getArtifactUsers` 參數來擷取 Power BI 報表上的使用者資訊。

WorkspaceInfoResponse

工作區信息回應

名稱	類型	Description
datasourceInstances	Datasource[]	與此掃描相關聯的數據源實例
misconfiguredDatasourceInstances	Datasource[]	與此掃描相關聯的數據源設定錯誤實例
workspaces	WorkspaceInfo[]	與此掃描相關聯的工作區資訊

WorkspaceInfoTile

WorkspaceInfo API 傳回的 Power BI 圖格

名稱	類型	Description
datasetId	string	數據集標識碼。僅適用於從報表或使用數據集建立的磚，例如 Q&A 磚。
datasetWorkspaceId	string	只有在相關數據集屬於不同工作區時，才會傳回相關數據集的工作區標識符
id	string	圖格標識碼
reportId	string	報表標識碼。僅適用於從報表建立的磚。
title	string	圖格的顯示名稱

共用方式為