Items - List Items

Služba:: Admin

Verzia rozhrania API:: v1

Vráti zoznam položiek active Fabric a PowerBI.

Poznámka

Toto rozhranie API je súčasťou vydania ukážky a je určené len na účely vyhodnocovania a vývoja. Môže sa zmeniť na základe pripomienok a neodporúča sa na použitie v produkčnom prostredí.

Toto rozhranie API podporuje stránkovanie. Na jednu požiadavku možno vrátiť maximálne 10 000 záznamov. Pomocou spojitého tokenu uvedeného v odpovedi môžete získať nasledujúcich 10 000 záznamov.

Poradie strán:

Položky tkaniny
Údajovémarty
Zostavy
Tabule
Sémantické modelky
Aplikácie
Toky údajov

Povolenia

Volajúci musí byť správcom služby Fabric alebo ho overovať pomocou objektu služby.

Povinné delegované rozsahy

Tenant.Read.All alebo Tenant.ReadWrite.All

Obmedzenia

Maximálne 200 žiadostí za hodinu.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

S voliteľnými parametrami:

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

Parametre URI

Name	V	Typ	Description
capacityId	query	string (uuid)	ID kapacity pracovného priestoru.
continuationToken	query	string	Continuous token used to get the next page items.
state	query	string	Stav položky. Podporované stavy sú aktívne.
type	query	string	Typ položky.
workspaceId	query	string (uuid)	ID pracovného priestoru.

Odpovede

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Items	Operácia bola úspešná.
429 Too Many Requests	ErrorResponse	Prekročil sa limit rýchlosti služby. Server vráti hlavičku `Retry-After` v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky. Hlavičky Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: ItemNotFound – ID položky neexistuje. InvalidItemType – Typ položky nie je platný. InvalidItemState – Stav položky nie je platný.

Items

Operácia bola úspešná.

429 Too Many Requests

ErrorResponse

Prekročil sa limit rýchlosti služby. Server vráti hlavičku Retry-After v sekundách, ako dlho musí klient počkať, kým odošle ďalšie požiadavky.

Hlavičky

Retry-After: integer

Other Status Codes

ErrorResponse

Bežné kódy chýb:

ItemNotFound – ID položky neexistuje.
InvalidItemType – Typ položky nie je platný.
InvalidItemState – Stav položky nie je platný.

Príklady

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

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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

Vzorová požiadavka

HTTP

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

Vzorová odpoveď

Kód stavu:: 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ície

Name	Description
EntireTenantPrincipal	Predstavuje objekt nájomníka
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
GroupPrincipal	Predstavuje skupinu zabezpečenia.
GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.
Item	Podrobnosti o položke.
Items	Zoznam položiek.
ItemState	Stav položky. V priebehu času je možné pridať ďalšie stavy položiek.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PrincipalType	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
ServicePrincipalPrincipal	Predstavuje objekt služby Microsoft Entra.
ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
ServicePrincipalProfilePrincipal	Predstavuje profil objektu služby.
UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .
UserPrincipal	Predstavuje objekt používateľa entra spoločnosti Microsoft.

EntireTenantPrincipal

Object

Predstavuje objekt nájomníka

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: EntireTenant	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string (uuid)	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GroupDetails

Object

Podrobnosti špecifické pre skupinu. Platí, ak je Grouptyp objektu .

Name	Typ	Description
groupType	GroupType	Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

GroupPrincipal

Object

Predstavuje skupinu zabezpečenia.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
groupDetails	GroupDetails	Podrobnosti špecifické pre skupinu. Platí, ak je `Group`typ objektu .
id	string (uuid)	ID objektu.
type	string: Group	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

GroupType

Enumerácia

Typ skupiny. V priebehu času je možné pridať ďalšie typy skupín.

Hodnota	Description
Unknown	Typ hlavnej skupiny nie je známy.
SecurityGroup	Principal je skupina zabezpečenia.
DistributionList	Principal je distribučný zoznam.

Item

Object

Podrobnosti o položke.

Name	Typ	Description
capacityId	string (uuid)	ID kapacity pracovného priestoru.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Vlastník položky.
description	string	Podrobnosti o položke vrátane typu položky a používania položky.
folderId	string (uuid)	ID priečinka položky.
id	string (uuid)	ID položky.
lastUpdatedDate	string (date-time)	Dátum a čas poslednej aktualizácie.
name	string	Názov položky.
state	ItemState	Stav položky.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky. Obsahuje hodnoty ako Synapse, Notebook, Kqldatabase a SynapseWorkbook.
workspaceId	string (uuid)	ID položky v pracovnom priestore.

Items

Object

Zoznam položiek.

Name	Typ	Description
continuationToken	string	Token pre ďalšiu dávku množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
continuationUri	string	Identifikátor URI ďalšej série množiny výsledkov. Ak už žiadne záznamy neexistujú, odstráni sa z odpovede.
itemEntities	Item[]	Zoznam položiek pre daného nájomníka.

ItemState

Enumerácia

Stav položky. V priebehu času je možné pridať ďalšie stavy položiek.

Hodnota	Description
Active	Aktívna položka.

ItemTag

Object

Predstavuje značku použitú na položke.

Name	Typ	Description
displayName	string	Názov značky.
id	string (uuid)	ID značky.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.
SnowflakeDatabase	Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.
OperationsAgent	OperationsAgent (Operácia).
CosmosDBDatabase	Databáza Cosmos DB.
Ontology	Ontológia.
EventSchemaSet	Množina schém udalosti.
DataAgent	DataAgent (Údajovýgens).

PrincipalType

Enumerácia

Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

Hodnota	Description
User	Principal je objekt používateľa služby Microsoft Entra.
ServicePrincipal	Principal je objekt služby Microsoft Entra.
Group	Principal je skupina zabezpečenia.
ServicePrincipalProfile	Principal je profil objektu služby.
EntireTenant	Možnosť Principal predstavuje všetkých používateľov nájomníka.

ServicePrincipalDetails

Object

Konkrétne podrobnosti objektu služby. Platí, ak je ServicePrincipaltyp objektu .

Name	Typ	Description
aadAppId	string (uuid)	Microsoft Entra AppId objektu služby.

ServicePrincipalPrincipal

Object

Predstavuje objekt služby Microsoft Entra.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalDetails	ServicePrincipalDetails	Konkrétne podrobnosti objektu služby. Platí, ak je `ServicePrincipal`typ objektu .
type	string: ServicePrincipal	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

ServicePrincipalProfileDetails

Object

Podrobnosti o profile objektu služby. Platí, ak je ServicePrincipalProfiletyp objektu .

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Nadradený objekt profilu služby.

ServicePrincipalProfilePrincipal

Object

Predstavuje profil objektu služby.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Podrobnosti o profile objektu služby. Platí, ak je `ServicePrincipalProfile`typ objektu .
type	string: ServicePrincipalProfile	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.

UserDetails

Object

Konkrétne podrobnosti o objekte používateľa. Platí, ak je Usertyp objektu .

Name	Typ	Description
userPrincipalName	string	Hlavné meno používateľa.

UserPrincipal

Object

Predstavuje objekt používateľa entra spoločnosti Microsoft.

Name	Typ	Description
displayName	string	Zobrazovaný názov objektu.
id	string (uuid)	ID objektu.
type	string: User	Typ objektu. V priebehu času je možné pridať ďalšie typy objektov.
userDetails	UserDetails	Konkrétne podrobnosti o objekte používateľa. Platí, ak je `User`typ objektu .

Zdieľať cez

Items - List Items

Povolenia

Povinné delegované rozsahy

Obmedzenia

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Odpovede

Príklady

Get a list of items using type query parameter example

Vzorová požiadavka

Vzorová odpoveď

Get all items in the tenant example

Vzorová požiadavka

Vzorová odpoveď

Get list of datamarts using type query parameter example

Vzorová požiadavka

Vzorová odpoveď

Definície

EntireTenantPrincipal

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupPrincipal

GroupType

Item

Items

ItemState

ItemTag

ItemType

PrincipalType

ServicePrincipalDetails

ServicePrincipalPrincipal

ServicePrincipalProfileDetails

ServicePrincipalProfilePrincipal

UserDetails

UserPrincipal