Items - List Items

Szolgáltatás:
Admin
API-verzió:
v1

Az aktív Fabric és PowerBI-elemek listáját adja vissza.

Note

Ez az API egy előzetes kiadás része, és csak kiértékelési és fejlesztési célokra érhető el. A visszajelzések alapján változhat, és éles használatra nem ajánlott.

Ez az API támogatja lapozási. Kérésenként legfeljebb 10 000 rekord adható vissza. A válaszban megadott folyamatos jogkivonattal lekérheti a következő 10 000 rekordot.

Oldalsorrend:

  1. Fabric elemek
  2. Datamarts
  3. Reports
  4. Dashboards
  5. SemanticModels
  6. Apps
  7. Dataflows

Permissions

A hívónak Fabric rendszergazdának kell lennie, vagy hitelesítést kell végeznie egy szolgáltatásnévvel.

Kötelező delegált hatókörök

Tenant.Read.All vagy Tenant.ReadWrite.All

Limitations

Óránként legfeljebb 200 kérelem.

Microsoft Entra támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft dentitásokat.

Identity Support
User Yes
szolgáltatás-princípium és felügyelt identitások Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/items
Opcionális paraméterekkel: 
GET https://api.fabric.microsoft.com/v1/admin/items?workspaceId={workspaceId}&capacityId={capacityId}&state={state}&type={type}&continuationToken={continuationToken}

URI-paraméterek

Name In Kötelező Típus Description
capacityId
 query

string (uuid)

A munkaterület kapacitásazonosítója.
continuationToken
 query

string

A következő oldalelemek lekéréséhez használt folyamatos jogkivonat.
state
 query

string

Az elem állapota. A támogatott állapotok aktívak.
type
 query

string

Az elem típusa.
workspaceId
 query

string (uuid)

A munkaterület azonosítója.

Válaszok

Name Típus Description
200 OK

Items

A művelet sikeres volt.
429 Too Many Requests

ErrorResponse

Túllépte a szolgáltatási sebesség korlátját. A kiszolgáló egy Retry-After fejlécet ad vissza másodpercek alatt, amely jelzi, hogy az ügyfélnek mennyi ideig kell várnia a további kérések elküldése előtt.

Fejlécek

Retry-After: integer
Other Status Codes

ErrorResponse

Gyakori hibakódok:

  • ItemNotFound – Az elemazonosító nem létezik.

  • InvalidItemType – Az elem típusa érvénytelen.

  • InvalidItemState – Az elem állapota érvénytelen.

Példák

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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
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

Mintakérelem

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

Mintaválasz

Állapotkód:
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
}

Definíciók

Name Description
EntireTenantPrincipal

Bérlői tagot jelöl
ErrorRelatedResource

A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse

A hibaválasz.
ErrorResponseDetails

A hibaválasz részletei.
GroupDetails

Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus Group.
GroupPrincipal

Biztonsági csoportot jelöl.
GroupType

A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.
Item

Elem részletei.
Items

Elemek listája.
ItemState

Az elem állapota. Idővel további elemállapotok is hozzáadhatók.
ItemTag

Egy elemre alkalmazott címkét jelöl.
ItemType

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.
PrincipalType

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
ServicePrincipalDetails

A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus ServicePrincipal.
ServicePrincipalPrincipal

Egy Microsoft Entra szolgáltatásnevet jelöl.
ServicePrincipalProfileDetails

A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Szolgáltatásnév-profilt jelöl.
UserDetails

A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus User.
UserPrincipal

Egy Microsoft Entra felhasználónevet jelöl.

EntireTenantPrincipal

Tárgy

Bérlői tagot jelöl

Name Típus Description
displayName

string

Az egyszerű megjelenítendő neve.
id

string (uuid)

Az igazgató azonosítója.
type string:

EntireTenant

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

ErrorRelatedResource

Tárgy

A hibával kapcsolatos erőforrás-részletek objektum.

Name Típus Description
resourceId

string

A hibában érintett erőforrás-azonosító.
resourceType

string

A hibában érintett erőforrás típusa.

ErrorResponse

Tárgy

A hibaválasz.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
isRetriable

boolean

Ha igaz, a kérés újrapróbálkozott. Ha elérhető, a Retry-After válaszfejléc használatával állapítsa meg a késést.
message

string

A hiba emberi olvasható ábrázolása.
moreDetails

ErrorResponseDetails[]

További hibaadatok listája.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.
requestId

string (uuid)

A hibához társított kérés azonosítója.

ErrorResponseDetails

Tárgy

A hibaválasz részletei.

Name Típus Description
errorCode

string

Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message

string

A hiba emberi olvasható ábrázolása.
relatedResource

ErrorRelatedResource

A hibával kapcsolatos erőforrásadatok.

GroupDetails

Tárgy

Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus Group.

Name Típus Description
groupType

GroupType

A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

GroupPrincipal

Tárgy

Biztonsági csoportot jelöl.

Name Típus Description
displayName

string

Az egyszerű megjelenítendő neve.
groupDetails

GroupDetails

Csoportosítsa a részleteket. Akkor alkalmazható, ha az egyszerű típus Group.
id

string (uuid)

Az igazgató azonosítója.
type string:

Group

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

GroupType

Felsorolás

A csoport típusa. Idővel további csoporttípusok is hozzáadhatók.

Érték Description
Unknown

Az egyszerű csoport típusa ismeretlen.
SecurityGroup

Az egyszerű egy biztonsági csoport.
DistributionList

Az egyszerű egy terjesztési lista.

Item

Tárgy

Elem részletei.

Name Típus Description
capacityId

string (uuid)

A munkaterület kapacitásazonosítója.
creatorPrincipal Principal:

Az elem tulajdonosa.
defaultIdentity Principal:

Az elem alapértelmezett identitása.
description

string

Az elem részletei, beleértve az elemtípust és az elemhasználatot.
folderId

string (uuid)

Az elem mappaazonosítója.
id

string (uuid)

Az elem azonosítója.
lastUpdatedDate

string (date-time)

Az utolsó frissítés dátuma és időpontja.
name

string

Az elem neve.
state

ItemState

Az elem állapota.
tags

ItemTag[]

Az alkalmazott címkék listája.
type

ItemType

Az elem típusa. Olyan értékeket tartalmaz, mint a Synapse, a Notebook, a Kqldatabase és a SynapseWorkbook.
workspaceId

string (uuid)

Az elem munkaterület-azonosítója.

Items

Tárgy

Elemek listája.

Name Típus Description
continuationToken

string

A következő eredményhalmaz kötegének jogkivonata. Ha nincs több rekord, az törlődik a válaszból.
continuationUri

string

A következő eredményhalmaz köteg URI-ja. Ha nincs több rekord, az törlődik a válaszból.
itemEntities

Item[]

Egy adott bérlő elemeinek listája.

ItemState

Felsorolás

Az elem állapota. Idővel további elemállapotok is hozzáadhatók.

Érték Description
Active

Aktív elem.

ItemTag

Tárgy

Egy elemre alkalmazott címkét jelöl.

Name Típus Description
displayName

string

A címke neve.
id

string (uuid)

A címke azonosítója.

ItemType

Felsorolás

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.

Érték Description
Dashboard

PowerBI-irányítópult.
Report

PowerBI-jelentés.
SemanticModel

PowerBI szemantikai modell.
PaginatedReport

Többoldalas PowerBI-jelentés.
Datamart

PowerBI datamart.
Lakehouse

Egy tóház.
Eventhouse

Egy rendezvényház.
Environment

Egy környezet.
KQLDatabase

KQL-adatbázis.
KQLQueryset

KQL-lekérdezéskészlet.
KQLDashboard

KQL-irányítópult.
DataPipeline

Egy adatfolyam.
Notebook

Egy jegyzetfüzet.
SparkJobDefinition

Spark-feladat definíciója.
MLExperiment

Gépi tanulási kísérlet.
MLModel

Gépi tanulási modell.
Warehouse

Egy raktár.
Eventstream

Eseménystream.
SQLEndpoint

EGY SQL-végpont.
MirroredWarehouse

Egy tükrözött raktár.
MirroredDatabase

Tükrözött adatbázis.
Reflex

Egy reflex.
GraphQLApi

Api a GraphQL-elemhez.
MountedDataFactory

A MountedDataFactory.
SQLDatabase

A SQLDatabase.
CopyJob

Másolási feladat.
VariableLibrary

Egy VariableLibrary.
Dataflow

Adatfolyam.
ApacheAirflowJob

An ApacheAirflowJob.
WarehouseSnapshot

Raktári pillanatkép.
DigitalTwinBuilder

Egy DigitalTwinBuilder.
DigitalTwinBuilderFlow

A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog

Tükrözött Azure Databricks-katalógus.
Map

Térkép.
AnomalyDetector

Anomáliadetektor.
UserDataFunction

Felhasználói adatfüggvény.
GraphModel

Egy GraphModel.
GraphQuerySet

Egy Graph Queryset.
SnowflakeDatabase

Snowflake-adatbázis a Snowflake-fiókból létrehozott Iceberg-táblák tárolására.
OperationsAgent

Egy OperationsAgent.
CosmosDBDatabase

Cosmos DB-adatbázis.
Ontology

Egy ontológia.
EventSchemaSet

An EventSchemaSet.
DataAgent

Egy DataAgent.
MirroredCatalog

Tükrözöttcatalog.
AppBackend

Egy AppBackend.

PrincipalType

Felsorolás

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

Érték Description
User

A rendszernév egy Microsoft Entra felhasználónév.
ServicePrincipal

Az egyszerű szolgáltatásnév egy Microsoft Entra szolgáltatásnév.
Group

Az egyszerű egy biztonsági csoport.
ServicePrincipalProfile

Az egyszerű szolgáltatásnév egy szolgáltatásnév-profil.
EntireTenant

Az egyszerűség az összes bérlőfelhasználót jelöli.

ServicePrincipalDetails

Tárgy

A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus ServicePrincipal.

Name Típus Description
aadAppId

string (uuid)

A szolgáltatásnév Microsoft Entra AppId.

ServicePrincipalPrincipal

Tárgy

Egy Microsoft Entra szolgáltatásnevet jelöl.

Name Típus Description
displayName

string

Az egyszerű megjelenítendő neve.
id

string (uuid)

Az igazgató azonosítója.
servicePrincipalDetails

ServicePrincipalDetails

A szolgáltatásnév konkrét részletei. Akkor alkalmazható, ha az egyszerű típus ServicePrincipal.
type string:

ServicePrincipal

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

ServicePrincipalProfileDetails

Tárgy

A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus ServicePrincipalProfile.

Name Típus Description
parentPrincipal Principal:

A szolgáltatásnév-profil szülőnevét.

ServicePrincipalProfilePrincipal

Tárgy

Szolgáltatásnév-profilt jelöl.

Name Típus Description
displayName

string

Az egyszerű megjelenítendő neve.
id

string (uuid)

Az igazgató azonosítója.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

A szolgáltatásnév profiladatai. Akkor alkalmazható, ha az egyszerű típus ServicePrincipalProfile.
type string:

ServicePrincipalProfile

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.

UserDetails

Tárgy

A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus User.

Name Típus Description
userPrincipalName

string

A felhasználónév.

UserPrincipal

Tárgy

Egy Microsoft Entra felhasználónevet jelöl.

Name Típus Description
displayName

string

Az egyszerű megjelenítendő neve.
id

string (uuid)

Az igazgató azonosítója.
type string:

User

A rendszernév típusa. Idővel további egyszerű típusok is hozzáadhatók.
userDetails

UserDetails

A felhasználó egyszerű adatai. Akkor alkalmazható, ha az egyszerű típus User.