다음을 통해 공유

Items - List Items

서비스:
Admin
API 버전:
v1

활성 패브릭 및 PowerBI 항목의 목록을 반환합니다.

Note

이 API는 미리 보기 릴리스의 일부이며 평가 및 개발 목적으로만 제공됩니다. 피드백에 따라 변경 될 수 있으며 프로덕션 사용에는 권장되지 않습니다.

이 API는 페이지 매김지원합니다. 요청당 최대 10,000개의 레코드를 반환할 수 있습니다. 응답에 제공된 연속 토큰을 사용하여 다음 10,000개의 레코드를 가져올 수 있습니다.

페이지 순서:

  1. 패브릭 항목
  2. Datamarts
  3. Reports
  4. Dashboards
  5. SemanticModels
  6. Apps
  7. Dataflows

Permissions

호출자는 패브릭 관리자이거나 서비스 주체를 사용하여 인증해야 합니다.

필요한 위임된 범위

Tenant.Read.All 또는 Tenant.ReadWrite.All

Limitations

시간당 최대 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 매개 변수

Name In(다음 안에) 필수 형식 Description
capacityId
 query

string (uuid)

작업 영역의 용량 ID입니다.
continuationToken
 query

string

다음 페이지 항목을 가져오는 데 사용되는 연속 토큰입니다.
state
 query

string

항목 상태입니다. 지원되는 상태는 활성 상태입니다.
type
 query

string

항목 유형입니다.
workspaceId
 query

string (uuid)

작업 영역 ID입니다.

응답

Name 형식 Description
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"
        }
      },
      "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

샘플 요청

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

샘플 요청

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
}

정의

Name Description
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
GroupDetails

특정 세부 정보를 그룹화합니다. 보안 주체 형식이 Group경우에 적용됩니다.
GroupType

그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다.
Item

항목 세부 정보입니다.
Items

항목 목록입니다.
ItemState

항목 상태입니다. 추가 항목 상태는 시간이 지남에 따라 추가될 수 있습니다.
ItemTag

항목에 적용된 태그를 나타냅니다.
ItemType

항목의 형식입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.
Principal

ID 또는 Microsoft Entra 그룹을 나타냅니다.
PrincipalType

보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다.
ServicePrincipalDetails

서비스 주체별 세부 정보입니다. 보안 주체 형식이 ServicePrincipal경우에 적용됩니다.
ServicePrincipalProfileDetails

서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 ServicePrincipalProfile경우에 적용됩니다.
UserDetails

사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 User경우에 적용됩니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

GroupDetails

Object

특정 세부 정보를 그룹화합니다. 보안 주체 형식이 Group경우에 적용됩니다.

Name 형식 Description
groupType

GroupType

그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다.

GroupType

열거형

그룹의 형식입니다. 추가 그룹 유형은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
Unknown

보안 주체 그룹 유형을 알 수 없습니다.
SecurityGroup

보안 주체는 보안 그룹입니다.
DistributionList

보안 주체는 메일 그룹입니다.

Item

Object

항목 세부 정보입니다.

Name 형식 Description
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

항목 목록입니다.

Name 형식 Description
continuationToken

string

다음 결과 집합 일괄 처리에 대한 토큰입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
continuationUri

string

다음 결과 집합 일괄 처리의 URI입니다. 레코드가 더 이상 없으면 응답에서 제거됩니다.
itemEntities

Item[]

지정된 테넌트에 대한 항목 목록입니다.

ItemState

열거형

항목 상태입니다. 추가 항목 상태는 시간이 지남에 따라 추가될 수 있습니다.

값 Description
Active

활성 항목입니다.

ItemTag

Object

항목에 적용된 태그를 나타냅니다.

Name 형식 Description
displayName

string

태그의 이름입니다.
id

string (uuid)

태그 ID입니다.

ItemType

열거형

항목의 형식입니다. 추가 항목 유형은 시간이 지남에 따라 추가될 수 있습니다.

값 Description
Dashboard

PowerBI 대시보드.
Report

PowerBI 보고서입니다.
SemanticModel

PowerBI 의미 체계 모델입니다.
PaginatedReport

PowerBI 페이지를 매긴 보고서입니다.
Datamart

PowerBI datamart.
Lakehouse

레이크 하우스.
Eventhouse

이벤트 하우스.
Environment

환경입니다.
KQLDatabase

KQL 데이터베이스입니다.
KQLQueryset

KQL 쿼리 세트입니다.
KQLDashboard

KQL 대시보드.
DataPipeline

데이터 파이프라인입니다.
Notebook

공책.
SparkJobDefinition

Spark 작업 정의입니다.
MLExperiment

기계 학습 실험입니다.
MLModel

기계 학습 모델입니다.
Warehouse

창고.
Eventstream

eventstream입니다.
SQLEndpoint

SQL 엔드포인트입니다.
MirroredWarehouse

미러된 창고입니다.
MirroredDatabase

미러된 데이터베이스입니다.
Reflex

반사.
GraphQLApi

GraphQL 항목에 대한 API입니다.
MountedDataFactory

MountedDataFactory입니다.
SQLDatabase

SQLDatabase입니다.
CopyJob

복사 작업입니다.
VariableLibrary

VariableLibrary입니다.
Dataflow

데이터 흐름입니다.
ApacheAirflowJob

ApacheAirflowJob입니다.
WarehouseSnapshot

웨어하우스 스냅샷.
DigitalTwinBuilder

DigitalTwinBuilder입니다.
DigitalTwinBuilderFlow

디지털 트윈 빌더 흐름입니다.
MirroredAzureDatabricksCatalog

미러된 Azure Databricks 카탈로그입니다.
Map

지도입니다.
AnomalyDetector

Anomaly Detector입니다.
UserDataFunction

사용자 데이터 함수입니다.
GraphModel

GraphModel입니다.
GraphQuerySet

Graph QuerySet입니다.
SnowflakeDatabase

Snowflake 계정에서 만든 빙산 테이블을 저장하는 Snowflake 데이터베이스입니다.
OperationsAgent

OperationsAgent입니다.
CosmosDBDatabase

Cosmos DB 데이터베이스입니다.
Ontology

온톨로지입니다.
EventSchemaSet

EventSchemaSet입니다.

Principal

Object

ID 또는 Microsoft Entra 그룹을 나타냅니다.

Name 형식 Description
displayName

string

보안 주체의 표시 이름입니다.
groupDetails

GroupDetails

특정 세부 정보를 그룹화합니다. 보안 주체 형식이 Group경우에 적용됩니다.
id

string (uuid)

보안 주체의 ID입니다.
servicePrincipalDetails

ServicePrincipalDetails

서비스 주체별 세부 정보입니다. 보안 주체 형식이 ServicePrincipal경우에 적용됩니다.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 ServicePrincipalProfile경우에 적용됩니다.
type

PrincipalType

보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다.
userDetails

UserDetails

사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 User경우에 적용됩니다.

PrincipalType

열거형

보안 주체의 형식입니다. 시간이 지남에 따라 추가 보안 주체 형식을 추가할 수 있습니다.

값 Description
User

보안 주체는 Microsoft Entra 사용자 보안 주체입니다.
ServicePrincipal

보안 주체는 Microsoft Entra 서비스 주체입니다.
Group

보안 주체는 보안 그룹입니다.
ServicePrincipalProfile

보안 주체는 서비스 주체 프로필입니다.
EntireTenant

보안 주체는 모든 테넌트 사용자를 나타냅니다.

ServicePrincipalDetails

Object

서비스 주체별 세부 정보입니다. 보안 주체 형식이 ServicePrincipal경우에 적용됩니다.

Name 형식 Description
aadAppId

string (uuid)

서비스 주체의 Microsoft Entra AppId입니다.

ServicePrincipalProfileDetails

Object

서비스 주체 프로필 세부 정보입니다. 보안 주체 형식이 ServicePrincipalProfile경우에 적용됩니다.

Name 형식 Description
parentPrincipal

Principal

서비스 주체 프로필의 부모 보안 주체입니다.

UserDetails

Object

사용자 보안 주체별 세부 정보입니다. 보안 주체 형식이 User경우에 적용됩니다.

Name 형식 Description
userPrincipalName

string

사용자 계정 이름입니다.