Items - List Items

サービス:: Admin

API バージョン:: v1

アクティブな Fabric および PowerBI 項目の一覧を返します。

Note

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

この API では、改ページ位置の修正がサポートされています。要求ごとに最大 10,000 個のレコードを返すことができます。応答で提供される連続トークンを使用すると、次の 10,000 個のレコードを取得できます。

ページの順序:

ファブリックアイテム
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

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/items

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	型	説明
capacityId	query	string (uuid)	ワークスペースの容量 ID。
continuationToken	query	string	次のページ項目を取得するために使用される連続トークン。
state	query	string	項目の状態。サポートされている状態はアクティブです。
type	query	string	アイテムの種類。
workspaceId	query	string (uuid)	ワークスペース ID。

応答

名前	型	説明
200 OK	Items	操作が成功しました。
Other Status Codes	ErrorResponse	一般的なエラーコード: ItemNotFound - 項目 ID が存在しません。 InvalidItemType - 項目の種類が無効です。 InvalidItemState - アイテムの状態が無効です。

名前

型

説明

200 OK

Items

操作が成功しました。

Other Status Codes

ErrorResponse

一般的なエラーコード:

ItemNotFound - 項目 ID が存在しません。
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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        },
        {
          "displayName": "Tag 2",
          "id": "62d18d7e-3878-478a-b89b-2f38b73c18a4"
        }
      ]
    },
    {
      "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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "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"
        }
      },
      "tags": [
        {
          "displayName": "Tag 1",
          "id": "b4e54dd6-1d37-4e7a-9e9a-49a596ff4470"
        }
      ]
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

定義

名前	説明
ErrorRelatedResource	エラー関連のリソース詳細オブジェクト。
ErrorResponse	エラー応答。
ErrorResponseDetails	エラー応答の詳細。
GroupDetails	グループ固有の詳細。プリンシパルの種類が `Group`場合に適用されます。
GroupType	グループの種類。グループの種類は、時間の経過と同時に追加される場合があります。
Item	アイテムの詳細。
Items	項目の一覧。
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。

Items

Object

項目の一覧。

名前	型	説明
continuationToken	string	次の結果セットバッチのトークン。これ以上レコードがない場合は、応答から削除されます。
continuationUri	string	次の結果セットバッチの URI。これ以上レコードがない場合は、応答から削除されます。
itemEntities	Item[]	特定のテナントの項目の一覧。

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	ユーザープリンシパル名。

次の方法で共有

Items - List Items

Permissions

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

Limitations

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

Interface

URI パラメーター

応答

例

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

要求のサンプル

応答のサンプル

定義

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails