通过

Items - Get Item

服务:
Admin
API 版本:
v1

返回指定的 Fabric 或 PowerBI 项。

Note

此 API 是预览版的一部分，仅用于评估和开发目的。 它可能会根据反馈进行更改，不建议将其用于生产。

Permissions

调用方必须是 Fabric 管理员或使用服务主体进行身份验证。

所需的委派范围

Tenant.Read.All 或 Tenant.ReadWrite.All

Limitations

每小时最多 200 个请求。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity Support
User Yes
服务主体和托管标识 Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}
具有可选参数: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}?type={type}

URI 参数

名称 在 必需 类型 说明
itemId
 path True

string (uuid)

项 ID
workspaceId
 path True

string (uuid)

工作区 ID。
type
 query

string

项的类型。 查询以下类型时，此参数是必需的：

  • 报表

  • Dashboard

  • SemanticModel

  • App

  • Dataflow

响应

名称 类型 说明
200 OK

Item

OK
Other Status Codes

ErrorResponse

常见错误代码：

  • ItemNotFound - 项 ID 不存在。

  • InvalidItemType - 项类型无效。

示例

Get item details by ID and type example
Get item details by ID example

Get item details by ID and type example

示例请求

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report

示例响应

状态代码:
200 
{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Report",
  "name": "Test",
  "description": "Test Jacob's Report,",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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"
    }
  }
}

Get item details by ID example

示例请求

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48

示例响应

状态代码:
200 
{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Kusto",
  "name": "Test",
  "description": "Test Jacob's notebook.",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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"
    }
  }
}

定义

名称 说明
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GroupDetails

组特定详细信息。 当主体类型 Group时适用。
GroupType

组的类型。 可能会随着时间的推移添加其他组类型。
Item

项详细信息。
ItemState

项状态。 可能会随着时间的推移添加其他项状态。
ItemTag

表示应用于项的标记。
ItemType

项的类型。 可能会随着时间的推移添加其他项类型。
Principal

表示标识或Microsoft Entra 组。
PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

ErrorRelatedResource

对象

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

对象

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

对象

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

GroupDetails

对象

组特定详细信息。 当主体类型 Group时适用。

名称 类型 说明
groupType

GroupType

组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

枚举

组的类型。 可能会随着时间的推移添加其他组类型。

值 说明
Unknown

主体组类型未知。
SecurityGroup

主体是安全组。
DistributionList

主体是通讯组列表。

Item

对象

项详细信息。

名称 类型 说明
capacityId

string (uuid)

工作区的容量 ID。
creatorPrincipal

Principal

项的所有者。
description

string

项目详细信息，包括项类型和项使用情况。
folderId

string (uuid)

项的文件夹 ID。
id

string (uuid)

项 ID。
lastUpdatedDate

string (date-time)

上次更新的日期和时间。
name

string

项目名称。
state

ItemState

项状态。
tags

ItemTag[]

已应用的标记列表。
type

ItemType

项目类型。 包括 Synapse、Notebook、Kqldatabase 和 SynapseWorkbook 等值。
workspaceId

string (uuid)

项的工作区 ID。

ItemState

枚举

项状态。 可能会随着时间的推移添加其他项状态。

值 说明
Active

活动项。

ItemTag

对象

表示应用于项的标记。

名称 类型 说明
displayName

string

标签的名称。
id

string (uuid)

标记 ID。

ItemType

枚举

项的类型。 可能会随着时间的推移添加其他项类型。

值 说明
Dashboard

PowerBI 仪表板。
Report

PowerBI 报表。
SemanticModel

PowerBI 语义模型。
PaginatedReport

PowerBI 分页报表。
Datamart

PowerBI Datamart。
Lakehouse

湖屋
Eventhouse

事件屋。
Environment

环境。
KQLDatabase

KQL 数据库。
KQLQueryset

KQL 查询集。
KQLDashboard

KQL 仪表板。
DataPipeline

数据管道。
Notebook

笔记本。
SparkJobDefinition

spark 作业定义。
MLExperiment

机器学习试验。
MLModel

机器学习模型。
Warehouse

仓库。
Eventstream

事件流。
SQLEndpoint

SQL 终结点。
MirroredWarehouse

镜像仓库。
MirroredDatabase

镜像数据库。
Reflex

反射。
GraphQLApi

GraphQL 项的 API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

复制作业。
VariableLibrary

VariableLibrary。
Dataflow

数据流。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

仓库快照。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

数字孪生生成器流。
MirroredAzureDatabricksCatalog

镜像的 Azure databricks 目录。
Map

地图。
AnomalyDetector

异常检测器。
UserDataFunction

用户数据函数。
GraphModel

GraphModel。
GraphQuerySet

图形查询集。
SnowflakeDatabase

用于存储从 Snowflake 帐户创建的 Iceberg 表的 Snowflake 数据库。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB 数据库。

Principal

对象

表示标识或Microsoft Entra 组。

名称 类型 说明
displayName

string

主体的显示名称。
groupDetails

GroupDetails

组特定详细信息。 当主体类型 Group时适用。
id

string (uuid)

主体的 ID。
servicePrincipalDetails

ServicePrincipalDetails

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type

PrincipalType

主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails

UserDetails

用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

枚举

主体的类型。 可能会随着时间的推移添加其他主体类型。

值 说明
User

主体是Microsoft Entra 用户主体。
ServicePrincipal

主体是Microsoft Entra 服务主体。
Group

主体是安全组。
ServicePrincipalProfile

主体是服务主体配置文件。
EntireTenant

主体表示所有租户用户。

ServicePrincipalDetails

对象

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称 类型 说明
aadAppId

string (uuid)

服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

对象

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称 类型 说明
parentPrincipal

Principal

服务主体配置文件的父主体。

UserDetails

对象

用户主体特定详细信息。 当主体类型 User时适用。

名称 类型 说明
userPrincipalName

string

用户主体名称。