次の方法で共有

Items - Get Item

サービス:
Admin
API バージョン:
v1

指定した Fabric または PowerBI 項目を返します。

Note

この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。

Permissions

呼び出し元は、ファブリック管理者であるか、サービス プリンシパルを使用して認証されている必要があります。

必要な委任されたスコープ

Tenant.Read.All または Tenant.ReadWrite.All

Limitations

1 時間あたり最大 200 要求。

Microsoft Entra でサポートされている ID

この API では、このセクションに記載されている Microsoft ID がサポートされています。

Identity Support
User Yes
サービス プリンシパルとマネージド ID 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

ID または Microsoft Entra グループを表します。
PrincipalType

プリンシパルの型。 プリンシパルの種類は、時間の経過と同時に追加される場合があります。
ServicePrincipalDetails

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。
ServicePrincipalProfileDetails

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。
UserDetails

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

ErrorRelatedResource

Object

エラー関連のリソース詳細オブジェクト。

名前 型 説明
resourceId

string

エラーに関係するリソース ID。
resourceType

string

エラーに関係するリソースの種類。

ErrorResponse

Object

エラー応答。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
moreDetails

ErrorResponseDetails[]

その他のエラーの詳細の一覧。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。
requestId

string

エラーに関連付けられている要求の ID。

ErrorResponseDetails

Object

エラー応答の詳細。

名前 型 説明
errorCode

string

エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。
message

string

エラーの人間が判読できる表現。
relatedResource

ErrorRelatedResource

エラー関連のリソースの詳細。

GroupDetails

Object

グループ固有の詳細。 プリンシパルの種類が Group場合に適用されます。

名前 型 説明
groupType

GroupType

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

GroupType

列挙

グループの種類。 グループの種類は、時間の経過と同時に追加される場合があります。

値 説明
Unknown

プリンシパル グループの種類が不明です。
SecurityGroup

プリンシパルはセキュリティ グループです。
DistributionList

プリンシパルは配布リストです。

Item

Object

アイテムの詳細。

名前 型 説明
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

Object

アイテムに適用されるタグを表します。

名前 型 説明
displayName

string

タグの名前。
id

string (uuid)

タグ ID。

ItemType

列挙

アイテムの種類。 追加の項目の種類は、時間の経過と同時に追加される場合があります。

値 説明
Dashboard

PowerBI ダッシュボード。
Report

PowerBI レポート。
SemanticModel

PowerBI セマンティック モデル。
PaginatedReport

PowerBI のページ分割されたレポート。
Datamart

PowerBI データマート。
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

Warehouse スナップショット。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

デジタル ツイン ビルダー フロー。
MirroredAzureDatabricksCatalog

ミラー化された Azure databricks カタログ。
Map

マップ。
AnomalyDetector

Anomaly Detector。
UserDataFunction

ユーザー データ関数。
GraphModel

GraphModel。
GraphQuerySet

Graph QuerySet。
SnowflakeDatabase

Snowflake アカウントから作成された Iceberg テーブルを格納する Snowflake データベース。
OperationsAgent

OperationsAgent。
CosmosDBDatabase

Cosmos DB データベース。
Ontology

オントロジ。
EventSchemaSet

EventSchemaSet。

Principal

Object

ID または 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

Object

サービス プリンシパル固有の詳細。 プリンシパルの種類が ServicePrincipal場合に適用されます。

名前 型 説明
aadAppId

string (uuid)

サービス プリンシパルの Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

サービス プリンシパル プロファイルの詳細。 プリンシパルの種類が ServicePrincipalProfile場合に適用されます。

名前 型 説明
parentPrincipal

Principal

サービス プリンシパル プロファイルの親プリンシパル。

UserDetails

Object

ユーザー プリンシパル固有の詳細。 プリンシパルの種類が User場合に適用されます。

名前 型 説明
userPrincipalName

string

ユーザー プリンシパル名。