共用方式為


Items - List Items

注意

此 API 處於預覽狀態。

傳回使用中網狀架構和PowerBI項目的清單。

此 API 支援 分頁。 每個要求最多可以傳回 10,000 筆記錄。 透過回應中提供的連續令牌,您可以取得接下來的 10,000 筆記錄。

頁面順序:

  1. 網狀架構專案
  2. Datamarts
  3. 報告
  4. 儀錶板
  5. SemanticModels
  6. 應用程式
  7. 數據流

權限

呼叫端必須是網狀架構系統管理員,或使用服務主體進行驗證。

必要的委派範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

局限性

每小時最多 200 個要求。

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別

身份 支援
使用者 是的
服務主體受控識別 是的

介面

GET https://api.fabric.microsoft.com/v1/admin/items
GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

URI 參數

名稱 位於 必要 類型 Description
capacityId
query

string

uuid

工作區的容量標識碼。

continuationToken
query

string

用來取得下一頁項目的連續令牌。

state
query

string

項目狀態。 支援的狀態為作用中。

type
query

string

項目類型。

workspaceId
query

string

uuid

工作區標識碼。

回應

名稱 類型 Description
200 OK

Items

作業成功。

Other Status Codes

ErrorResponse

常見的錯誤碼:

  • ItemNotFound - 項目識別碼不存在。

  • InvalidItemType - 項目類型無效。

  • InvalidItemState - 項目狀態無效。

範例

Get a list of items using type query parameter example
Get all items in the tenant example
Get list of datamarts using type query parameter example

Get a list of items using type query parameter example

範例要求

GET https://api.fabric.microsoft.com/v1/admin/items?type=Report

範例回覆

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Report",
      "name": "Test Report",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "Jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

範例要求

GET https://api.fabric.microsoft.com/v1/admin/items

範例回覆

{
  "itemEntities": [
    {
      "id": "17d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "Notebook",
      "name": "Test",
      "description": "Test notebook.",
      "state": "Active",
      "lastUpdatedDate": "2022-04-29T17:47:29.98673",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Caleb Foster",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "caleb@example.com"
        }
      }
    },
    {
      "id": "37d8929d-ab32-46d1-858b-fdea74e93bff",
      "type": "KQLDatabase",
      "name": "TestKusto",
      "description": "Test KQL database.",
      "state": "Active",
      "lastUpdatedDate": "2022-06-30T17:47:29.98673",
      "workspaceId": "8f4496db-9929-47bd-89c0-d7eb2f517a95",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F881A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/items?continuationToken=MSwxMDAwMCww",
  "continuationToken": "MSwxMDAwMCww"
}

Get list of datamarts using type query parameter example

範例要求

GET https://api.fabric.microsoft.com/v1/admin/items?type=Lakehouse

範例回覆

{
  "itemEntities": [
    {
      "id": "b1a7e572-2585-4650-98ae-b92356f4460b",
      "type": "Lakehouse",
      "name": "Lakehouse 2022-03-16T21:42:38.442Z",
      "state": "Active",
      "lastUpdatedDate": "2022-06-27T16:55:04.893",
      "workspaceId": "7f4496db-9929-47bd-89c0-d7eb2f517a98",
      "capacityId": "D5E336D6-D919-4ECC-B424-1F771A506851",
      "creatorPrincipal": {
        "id": "f3052d1c-61a9-46fb-8df9-0d78916ae041",
        "displayName": "Jacob Hancock",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "jacob@example.com"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

定義

名稱 Description
ErrorRelatedResource

錯誤相關的資源詳細資料物件。

ErrorResponse

錯誤回應。

ErrorResponseDetails

錯誤回應詳細數據。

GroupDetails

群組特定詳細數據。 當主體類型 Group時適用。

GroupType

群組的類型。 可能會隨著時間新增其他群組類型。

Item

項目詳細數據。

Items

項目清單。

ItemState

項目狀態。 可能會隨著時間新增其他項目狀態。

ItemType

專案的型別。 可能會隨著時間新增其他項目類型。

Principal

代表身分識別或Microsoft Entra 群組。

PrincipalType

主體的類型。 可能會隨著時間新增其他主體類型。

ServicePrincipalDetails

服務主體特定詳細數據。 當主體類型 ServicePrincipal時適用。

ServicePrincipalProfileDetails

服務主體配置檔詳細數據。 當主體類型 ServicePrincipalProfile時適用。

UserDetails

用戶主體特定詳細數據。 當主體類型 User時適用。

ErrorRelatedResource

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。

resourceType

string

發生錯誤的資源類型。

ErrorResponse

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

message

string

錯誤的人類可讀取表示法。

moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。

relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼,允許服務與其使用者之間的標準化通訊。

message

string

錯誤的人類可讀取表示法。

relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

GroupDetails

群組特定詳細數據。 當主體類型 Group時適用。

名稱 類型 Description
groupType

GroupType

群組的類型。 可能會隨著時間新增其他群組類型。

GroupType

群組的類型。 可能會隨著時間新增其他群組類型。

Description
DistributionList

主體是通訊組清單。

SecurityGroup

主體是安全組。

Unknown

主體群組類型未知。

Item

項目詳細數據。

名稱 類型 Description
capacityId

string

uuid

工作區的容量標識碼。

creatorPrincipal

Principal

項目的擁有者。

description

string

專案詳細數據,包括項目類型和專案使用方式。

id

string

uuid

項目標識碼。

lastUpdatedDate

string

date-time

上次更新的日期和時間。

name

string

專案名稱。

state

ItemState

項目狀態。

type

ItemType

項目類型。 包含 Synapse、Notebook、Kqldatabase 和 SynapseWorkbook 等值。

workspaceId

string

uuid

專案的工作區標識碼。

Items

項目清單。

名稱 類型 Description
continuationToken

string

下一個結果集批次的令牌。 如果沒有其他記錄,則會從回應中移除。

continuationUri

string

下一個結果集批次的 URI。 如果沒有其他記錄,則會從回應中移除。

itemEntities

Item[]

指定租用戶的項目清單。

ItemState

項目狀態。 可能會隨著時間新增其他項目狀態。

Description
Active

使用中的專案。

ItemType

專案的型別。 可能會隨著時間新增其他項目類型。

Description
Dashboard

PowerBI 儀錶板。

DataPipeline

數據管線。

Datamart

PowerBI datamart。

Environment

環境。

Eventhouse

事件屋。

Eventstream

eventstream。

GraphQLApi

GraphQL 專案的 API。

KQLDashboard

KQL 儀錶板。

KQLDatabase

KQL 資料庫。

KQLQueryset

KQL 查詢集。

Lakehouse

湖屋

MLExperiment

機器學習實驗。

MLModel

機器學習模型。

MirroredDatabase

鏡像資料庫。

MirroredWarehouse

鏡像倉儲。

MountedDataFactory

MountedDataFactory。

Notebook

筆記本。

PaginatedReport

PowerBI 編頁報表。

Reflex

反射。

Report

PowerBI 報表。

SQLDatabase

SQLDatabase。

SQLEndpoint

SQL 端點。

SemanticModel

PowerBI 語意模型。

SparkJobDefinition

Spark 作業定義。

Warehouse

倉儲。

Principal

代表身分識別或Microsoft Entra 群組。

名稱 類型 Description
displayName

string

主體的顯示名稱。

groupDetails

GroupDetails

群組特定詳細數據。 當主體類型 Group時適用。

id

string

uuid

主體的標識碼。

servicePrincipalDetails

ServicePrincipalDetails

服務主體特定詳細數據。 當主體類型 ServicePrincipal時適用。

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服務主體配置檔詳細數據。 當主體類型 ServicePrincipalProfile時適用。

type

PrincipalType

主體的類型。 可能會隨著時間新增其他主體類型。

userDetails

UserDetails

用戶主體特定詳細數據。 當主體類型 User時適用。

PrincipalType

主體的類型。 可能會隨著時間新增其他主體類型。

Description
Group

主體是安全組。

ServicePrincipal

主體是Microsoft Entra 服務主體。

ServicePrincipalProfile

主體是服務主體配置檔。

User

主體是 entra 用戶主體Microsoft。

ServicePrincipalDetails

服務主體特定詳細數據。 當主體類型 ServicePrincipal時適用。

名稱 類型 Description
aadAppId

string

uuid

服務主體的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

服務主體配置檔詳細數據。 當主體類型 ServicePrincipalProfile時適用。

名稱 類型 Description
parentPrincipal

Principal

服務主體配置檔的父主體。

UserDetails

用戶主體特定詳細數據。 當主體類型 User時適用。

名稱 類型 Description
userPrincipalName

string

用戶主體名稱。