Megosztás a következőn keresztül:

Items - List Items

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

Jegyzet

Ez az API előzetes verzióban érhető el.

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

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. Hálóelemek
  2. Datamarts
  3. Jelentések
  4. Irányítópultok
  5. SzemanticModels
  6. Apps
  7. Adatfolyamok

Engedélyek

A hívónak háló-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

Korlátozások

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

Microsoft Entra által támogatott identitások

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

Azonosság Támogat
Felhasználó Igen
szolgáltatásnév és felügyelt identitások Igen

Interfész

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

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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definíciók

Name Description
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.
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.
ItemType

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

Identitást vagy Microsoft Entra-csoportot jelöl.
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.
ServicePrincipalProfileDetails

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

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

ErrorRelatedResource

Objektum

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

Objektum

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

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

ErrorResponseDetails

Objektum

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

Objektum

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.

GroupType

Enumerálás

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

Érték Description
DistributionList

Az egyszerű egy terjesztési lista.
SecurityGroup

Az egyszerű egy biztonsági csoport.
Unknown

Az egyszerű csoport típusa ismeretlen.

Item

Objektum

Elem részletei.

Name Típus Description
capacityId

string

uuid

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

Principal

Az elem tulajdonosa.
description

string

Az elem részletei, beleértve az elemtípust és az elemhasználatot.
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.
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

Objektum

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

Enumerálás

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

Érték Description
Active

Aktív elem.

ItemType

Enumerálás

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

Érték Description
Dashboard

PowerBI-irányítópult.
DataPipeline

Egy adatfolyam.
Datamart

PowerBI datamart.
Environment

Egy környezet.
Eventhouse

Egy rendezvényház.
Eventstream

Eseménystream.
GraphQLApi

Api a GraphQL-elemhez.
KQLDashboard

KQL-irányítópult.
KQLDatabase

KQL-adatbázis.
KQLQueryset

KQL-lekérdezéskészlet.
Lakehouse

Egy tóház.
MLExperiment

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

Gépi tanulási modell.
MirroredDatabase

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

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

A MountedDataFactory.
Notebook

Egy jegyzetfüzet.
PaginatedReport

Többoldalas PowerBI-jelentés.
Reflex

Egy reflex.
Report

PowerBI-jelentés.
SQLDatabase

A SQLDatabase.
SQLEndpoint

EGY SQL-végpont.
SemanticModel

PowerBI szemantikai modell.
SparkJobDefinition

Spark-feladat definíciója.
Warehouse

Egy raktár.

Principal

Objektum

Identitást vagy Microsoft Entra-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.
servicePrincipalDetails

ServicePrincipalDetails

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

ServicePrincipalProfileDetails

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

PrincipalType

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.

PrincipalType

Enumerálás

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

Érték Description
Group

Az egyszerű egy biztonsági csoport.
ServicePrincipal

Az egyszerű szolgáltatásnév a Microsoft Entra szolgáltatásnév.
ServicePrincipalProfile

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

Az egyszerű felhasználó a Microsoft Entra egyik egyszerű felhasználója.

ServicePrincipalDetails

Objektum

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 azonosítója.

ServicePrincipalProfileDetails

Objektum

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.

UserDetails

Objektum

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

Name Típus Description
userPrincipalName

string

A felhasználónév.