次の方法で共有

Items - List Items

  • リファレンス
サービス:
Admin
API バージョン:
v1

手記

この API はプレビュー段階です。

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

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

ページの順序:

  1. ファブリックアイテム
  2. Datamarts
  3. レポート
  4. ダッシュ ボード
  5. SemanticModels
  6. アプリ
  7. データフロー

権限

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

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

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

制限

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

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

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

同一性 支える
利用者 はい
サービス プリンシパルの とマネージド ID の はい

インターフェイス

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 - アイテムの状態が無効です。

例

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

応答のサンプル

状態コード:
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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Get all items in the tenant example

要求のサンプル

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"
        }
      }
    },
    {
      "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

応答のサンプル

状態コード:
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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

定義

名前 説明
ErrorRelatedResource

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

エラー応答。
ErrorResponseDetails

エラー応答の詳細。
GroupDetails

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

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

アイテムの詳細。
Items

項目の一覧。
ItemState

項目の状態。 アイテムの状態は、時間の経過と同時に追加される場合があります。
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

列挙

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

値 説明
DistributionList

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

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

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

Item

Object

アイテムの詳細。

名前 型 説明
capacityId

string

uuid

ワークスペースの容量 ID。
creatorPrincipal

Principal

アイテムの所有者。
description

string

アイテムの種類やアイテムの使用状況など、アイテムの詳細。
id

string

uuid

アイテム ID。
lastUpdatedDate

string

date-time

最後に更新された日付と時刻。
name

string

アイテム名。
state

ItemState

アイテムの状態。
type

ItemType

アイテムの種類。 Synapse、Notebook、Kqldatabase、SynapseWorkbook などの値が含まれます。
workspaceId

string

uuid

アイテムのワークスペース ID。

Items

Object

項目の一覧。

名前 型 説明
continuationToken

string

次の結果セット バッチのトークン。 これ以上レコードがない場合は、応答から削除されます。
continuationUri

string

次の結果セット バッチの URI。 これ以上レコードがない場合は、応答から削除されます。
itemEntities

Item[]

特定のテナントの項目の一覧。

ItemState

列挙

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

値 説明
Active

アクティブなアイテム。

ItemType

列挙

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

値 説明
Dashboard

PowerBI ダッシュボード。
DataPipeline

データ パイプライン。
Datamart

PowerBI データマート。
Environment

環境。
Eventhouse

イベントハウス。
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

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

列挙

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

値 説明
Group

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

プリンシパルは Microsoft Entra サービス プリンシパルです。
ServicePrincipalProfile

プリンシパルはサービス プリンシパル プロファイルです。
User

プリンシパルは Microsoft Entra ユーザー プリンシパルです。

ServicePrincipalDetails

Object

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

名前 型 説明
aadAppId

string

uuid

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

ServicePrincipalProfileDetails

Object

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

名前 型 説明
parentPrincipal

Principal

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

UserDetails

Object

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

名前 型 説明
userPrincipalName

string

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