Items - List Items

Layanan:: Admin

Versi API:: v1

Mengembalikan daftar item Fabric aktif dan PowerBI.

Note

API ini adalah bagian dari rilis Pratinjau dan disediakan hanya untuk tujuan evaluasi dan pengembangan. Ini dapat berubah berdasarkan umpan balik dan tidak disarankan untuk penggunaan produksi.

API ini mendukung penomoran halaman. Maksimal 10.000 rekaman dapat dikembalikan per permintaan. Dengan token berkelanjutan yang disediakan dalam respons, Anda bisa mendapatkan 10.000 rekaman berikutnya.

Urutan halaman:

item Fabric
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

Pemanggil harus menjadi administrator Fabric atau mengautentikasi menggunakan perwakilan layanan.

Cakupan yang Didelegasikan yang Diperlukan

Tenant.Read.All atau Tenant.ReadWrite.All

Limitations

Maksimum 200 permintaan per jam.

Microsoft Entra identitas yang didukung

API ini mendukung Microsoft identities yang tercantum di bagian ini.

Identity	Support
User	Yes
Prinsipal Layanan dan Identitas Terkelola	Yes

Interface

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

Dengan parameter opsional:

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

Parameter URI

Nama	Dalam	Jenis	Deskripsi
capacityId	query	string (uuid)	ID kapasitas ruang kerja.
continuationToken	query	string	Token berkelanjutan digunakan untuk mendapatkan item halaman berikutnya.
state	query	string	Status item. Status yang didukung aktif.
type	query	string	Jenis item.
workspaceId	query	string (uuid)	ID ruang kerja.

Respons

Nama Jenis Deskripsi

200 OK

Nama	Jenis	Deskripsi
200 OK	Items	Operasi berhasil.
429 Too Many Requests	ErrorResponse	Batas tarif layanan terlampaui. Server mengembalikan header yang `Retry-After` menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan. Header Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: ItemNotFound - ID Item tidak ada. InvalidItemType - Tipe item tidak valid. InvalidItemState - Status item tidak valid.

Items

Operasi berhasil.

429 Too Many Requests

ErrorResponse

Batas tarif layanan terlampaui. Server mengembalikan header yang Retry-After menunjukkan, dalam detik, berapa lama klien harus menunggu sebelum mengirim permintaan tambahan.

Header

Retry-After: integer

Other Status Codes

ErrorResponse

Kode kesalahan umum:

ItemNotFound - ID Item tidak ada.
InvalidItemType - Tipe item tidak valid.
InvalidItemState - Status item tidak valid.

Contoh

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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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"
        }
      },
      "defaultIdentity": {
        "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"
        }
      },
      "defaultIdentity": {
        "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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 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
}

Definisi

Nama	Deskripsi
EntireTenantPrincipal	Mewakili perwakilan penyewa
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
GroupPrincipal	Mewakili grup keamanan.
GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.
Item	Detail item.
Items	Daftar item.
ItemState	Status item. Status item tambahan dapat ditambahkan dari waktu ke waktu.
ItemTag	Mewakili tag yang diterapkan pada item.
ItemType	Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
PrincipalType	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
ServicePrincipalPrincipal	Mewakili perwakilan layanan Microsoft Entra.
ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Mewakili profil perwakilan layanan.
UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.
UserPrincipal	Mewakili prinsipal pengguna Microsoft Entra.

EntireTenantPrincipal

Objek

Mewakili perwakilan penyewa

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
type	string: EntireTenant	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
isRetriable	boolean	Jika benar, permintaan dapat dicoba kembali. `Retry-After` Gunakan header respons untuk menentukan penundaan, jika tersedia.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string (uuid)	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

GroupDetails

Objek

Mengelompokkan detail spesifik. Berlaku ketika jenis utama Group.

Nama	Jenis	Deskripsi
groupType	GroupType	Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

GroupPrincipal

Objek

Mewakili grup keamanan.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
groupDetails	GroupDetails	Mengelompokkan detail spesifik. Berlaku ketika jenis utama `Group`.
id	string (uuid)	Id utama.
type	string: Group	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

GroupType

Enumerasi

Jenis grup. Jenis grup tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Unknown	Jenis grup utama tidak diketahui.
SecurityGroup	Prinsipal adalah kelompok keamanan.
DistributionList	Prinsipal adalah daftar distribusi.

Item

Objek

Detail item.

Nama	Jenis	Deskripsi
capacityId	string (uuid)	ID kapasitas ruang kerja.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Pemilik item.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identitas default item.
description	string	Detail item termasuk jenis item dan penggunaan item.
folderId	string (uuid)	ID folder item.
id	string (uuid)	ID item.
lastUpdatedDate	string (date-time)	Tanggal dan waktu terakhir diperbarui.
name	string	Nama item.
state	ItemState	Status item.
tags	ItemTag[]	Daftar tag yang diterapkan.
type	ItemType	Jenis item. Menyertakan nilai seperti Synapse, Notebook, Kqldatabase, dan SynapseWorkbook.
workspaceId	string (uuid)	ID ruang kerja item.

Items

Objek

Daftar item.

Nama	Jenis	Deskripsi
continuationToken	string	Token untuk batch tataan hasil berikutnya. Jika tidak ada rekaman lagi, rekaman akan dihapus dari respons.
continuationUri	string	URI dari batch tataan hasil berikutnya. Jika tidak ada rekaman lagi, rekaman akan dihapus dari respons.
itemEntities	Item[]	Daftar item untuk penyewa tertentu.

ItemState

Enumerasi

Status item. Status item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Active	Item aktif.

ItemTag

Objek

Mewakili tag yang diterapkan pada item.

Nama	Jenis	Deskripsi
displayName	string	Nama dari tag.
id	string (uuid)	ID tag.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Dashboard	Dasbor PowerBI.
Report	Laporan PowerBI.
SemanticModel	Model semantik PowerBI.
PaginatedReport	Laporan paginasi PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Sebuah lakehouse.
Eventhouse	Sebuah rumah acara.
Environment	Lingkungan.
KQLDatabase	Database KQL.
KQLQueryset	Set kueri KQL.
KQLDashboard	Dasbor KQL.
DataPipeline	Alur data.
Notebook	Buku catatan.
SparkJobDefinition	Definisi pekerjaan spark.
MLExperiment	Eksperimen pembelajaran mesin.
MLModel	Model pembelajaran mesin.
Warehouse	Sebuah gudang.
Eventstream	Eventstream.
SQLEndpoint	Titik akhir SQL.
MirroredWarehouse	Sebuah gudang cermin.
MirroredDatabase	Database cermin.
Reflex	Sebuah Refleks.
GraphQLApi	API untuk item GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Sebuah SQLDatabase.
CopyJob	Pekerjaan Penyalinan.
VariableLibrary	VariabelLibrary.
Dataflow	Aliran Data.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Rekam jepret gudang.
DigitalTwinBuilder	Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow	Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog	Katalog azure databricks cermin.
Map	Peta.
AnomalyDetector	Detektor Anomali.
UserDataFunction	Fungsi data pengguna.
GraphModel	Sebuah GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Database Cosmos DB.
Ontology	Ontologi.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.

PrincipalType

Enumerasi

Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
User	Prinsipal adalah prinsipal pengguna Microsoft Entra.
ServicePrincipal	Perwakilan adalah perwakilan layanan Microsoft Entra.
Group	Prinsipal adalah kelompok keamanan.
ServicePrincipalProfile	Perwakilan adalah profil perwakilan layanan.
EntireTenant	Perwakilan mewakili semua pengguna penyewa.

ServicePrincipalDetails

Objek

Detail spesifik perwakilan layanan. Berlaku ketika jenis utama ServicePrincipal.

Nama	Jenis	Deskripsi
aadAppId	string (uuid)	AppId Microsoft Entra perwakilan layanan.

ServicePrincipalPrincipal

Objek

Mewakili perwakilan layanan Microsoft Entra.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
servicePrincipalDetails	ServicePrincipalDetails	Detail spesifik perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipal`.
type	string: ServicePrincipal	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

ServicePrincipalProfileDetails

Objek

Detail profil perwakilan layanan. Berlaku ketika jenis utama ServicePrincipalProfile.

Nama	Jenis	Deskripsi
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Perwakilan induk profil perwakilan layanan.

ServicePrincipalProfilePrincipal

Objek

Mewakili profil perwakilan layanan.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detail profil perwakilan layanan. Berlaku ketika jenis utama `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.

UserDetails

Objek

Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama User.

Nama	Jenis	Deskripsi
userPrincipalName	string	Nama prinsipal pengguna.

UserPrincipal

Objek

Mewakili prinsipal pengguna Microsoft Entra.

Nama	Jenis	Deskripsi
displayName	string	Nama tampilan utama.
id	string (uuid)	Id utama.
type	string: User	Jenis prinsipal. Jenis utama tambahan dapat ditambahkan dari waktu ke waktu.
userDetails	UserDetails	Detail spesifik perwakilan pengguna. Berlaku ketika jenis utama `User`.