Items - List Items

บริการ:

Admin

เวอร์ชัน API:

v1

แสดงรายการของสิ่งของ Fabric ที่ใช้งานได้และ PowerBI

Note

API นี้เป็นส่วนหนึ่งของการเผยแพร่ตัวอย่าง และมีไว้เพื่อวัตถุประสงค์ในการประเมินและการพัฒนาเท่านั้น ซึ่งอาจเปลี่ยนแปลงตามคําติชมและไม่แนะนําสําหรับการใช้งานด้านการผลิต

API นี้สนับสนุนการแบ่งหน้า สามารถส่งกลับบันทึกได้สูงสุด 10,000 รายการต่อคําขอ ด้วยโทเค็นแบบต่อเนื่องที่ให้ไว้ในการตอบกลับ คุณจะได้รับบันทึก 10,000 รายการถัดไป

ลําดับของหน้า:

1. รายการผ้า
2. Datamarts
3. Reports
4. Dashboards
5. SemanticModels
6. Apps
7. Dataflows

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

คำขอตัวอย่าง

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	แสดงข้อมูลประจําตัวหรือกลุ่ม 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	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

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)	รหัสสินค้า
lastUpdatedDate	string (date-time)	วันที่และเวลาที่อัปเดตล่าสุด
name	string	ชื่อรายการ
state	ItemState	สถานะของสินค้า
tags	ItemTag[]	รายการของแท็กที่ใช้
type	ItemType	ชนิดหน่วยข้อมูล รวมค่าต่างๆ เช่น Synapse, Notebook, Kqldatabase และ SynapseWorkbook
workspaceId	string (uuid)	ID พื้นที่ทํางานของรายการ

Items

วัตถุ

รายการข้อมูล

ชื่อ	พิมพ์	คำอธิบาย
continuationToken	string	โทเค็นสําหรับชุดผลลัพธ์ชุดถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
continuationUri	string	URI ของชุดงานชุดผลลัพธ์ถัดไป ถ้าไม่มีระเบียนเพิ่มเติม จะถูกลบออกจากการตอบสนอง
itemEntities	Item[]	รายการข้อมูลสําหรับผู้เช่าที่กําหนด

ItemState

การแจงนับ

สถานะหน่วยข้อมูล รัฐของรายการเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Active	รายการที่ใช้งานอยู่

ItemTag

วัตถุ

แสดงแท็กที่ใช้กับรายการ

ชื่อ	พิมพ์	คำอธิบาย
displayName	string	ชื่อของแท็ก
id	string (uuid)	ID แท็ก

ItemType

การแจงนับ

ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า	คำอธิบาย
Dashboard	แดชบอร์ด PowerBI
Report	รายงาน PowerBI
SemanticModel	แบบจําลองความหมายของ PowerBI
PaginatedReport	รายงานที่มีการแบ่งหน้าของ PowerBI
Datamart	Datamart ของ PowerBI
Lakehouse	เลคเฮ้าส์
Eventhouse	อาคารจัดงาน
Environment	สภาพแวดล้อม
KQLDatabase	ฐานข้อมูล KQL
KQLQueryset	ชุดคิวรี KQL
KQLDashboard	แดชบอร์ด KQL
DataPipeline	ไปป์ไลน์ข้อมูล
Notebook	โน๊ตบุ๊ค
SparkJobDefinition	ข้อกําหนดงานแบบประกายไฟ
MLExperiment	การทดลองการเรียนรู้ของเครื่อง
MLModel	แบบจําลองการเรียนรู้ของเครื่อง
Warehouse	คลังสินค้า
Eventstream	เหตุการณ์กระแสข้อมูล
SQLEndpoint	จุดสิ้นสุด SQL
MirroredWarehouse	คลังสินค้าที่มิเรอร์
MirroredDatabase	ฐานข้อมูลที่มิเรอร์
Reflex	รีเฟล็กซ์
GraphQLApi	API สําหรับรายการ GraphQL
MountedDataFactory	เมาท์ DataFactory
SQLDatabase	SQLDatabase
CopyJob	งานคัดลอก
VariableLibrary	VariableLibrary
Dataflow	กระแสข้อมูล
ApacheAirflowJob	ApacheAirflowJob
WarehouseSnapshot	สแนปช็อตของคลังสินค้า
DigitalTwinBuilder	DigitalTwinBuilder
DigitalTwinBuilderFlow	โฟลว์ Digital Twin Builder
MirroredAzureDatabricksCatalog	แค็ตตาล็อก azure databricks ที่มิเรอร์
Map	แผนที่.
AnomalyDetector	การตรวจหาความผิดปกติ
UserDataFunction	ฟังก์ชันข้อมูลผู้ใช้
GraphModel	GraphModel
GraphQuerySet	ชุดคิวรีกราฟ
SnowflakeDatabase	ฐานข้อมูล Snowflake เพื่อจัดเก็บตาราง Iceberg ที่สร้างขึ้นจากบัญชี Snowflake
OperationsAgent	OperationsAgent
CosmosDBDatabase	ฐานข้อมูล Cosmos DB
Ontology	โทโพโลยี
EventSchemaSet	EventSchemaSet

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	ชื่อหลักของผู้ใช้