Jaa

Items - List Items

  • Viite
Palvelu:
Admin
Ohjelmointirajapinnan versio:
v1

Muistiinpano

Tämä ohjelmointirajapinta on esikatselutilassa.

Palauttaa luettelon aktiivisista Fabric- ja PowerBI-kohteista.

Tämä ohjelmointirajapinta tukee sivutuksen. Enintään 10 000 tietuetta voidaan palauttaa pyyntöä kohden. Vastauksessa olevan jatkuvan tunnuksen avulla voit saada seuraavat 10 000 tietuetta.

Sivujärjestys:

  1. Fabric-kohteet
  2. Tietojoukot
  3. Raportit
  4. Koontinäyttöjen
  5. SemanticModels
  6. Sovellukset
  7. Tietovuot

Käyttöoikeudet

Soittajan on oltava Fabric-järjestelmänvalvoja tai todennettava palvelun päänimen avulla.

Vaaditut delegoidut vaikutusalueet

Tenant.Read.All tai Tenant.ReadWrite.All

Rajoitukset

Enintään 200 pyyntöä tuntia kohti.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti Tuki
Käyttäjä Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen Kyllä

Rajapinta

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

URI-parametrit

Nimi Kohteessa Pakollinen Tyyppi Description
capacityId
 query

string

uuid

Tämä on työtilan kapasiteetin tunnus.
continuationToken
 query

string

Jatkuva tunnus, jota käytetään seuraavan sivun kohteiden noutamiseen.
state
 query

string

Kohteen tila. Tuetut osavaltiot ovat aktiivisia.
type
 query

string

Kohdetyyppi.
workspaceId
 query

string

uuid

Työtilan tunnus.

Vastaukset

Nimi Tyyppi Description
200 OK

Items

Toiminto onnistui.
Other Status Codes

ErrorResponse

Yleiset virhekoodit:

  • ItemNotFound – Kohdetunnusta ei ole.

  • InvalidItemType – Kohdetyyppi ei ole kelvollinen.

  • InvalidItemState – Kohteen tila ei ole kelvollinen.

Esimerkit

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

Mallipyyntö

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

Mallivastaus

Tilakoodi:
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

Mallipyyntö

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

Mallivastaus

Tilakoodi:
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

Mallipyyntö

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

Mallivastaus

Tilakoodi:
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
}

Määritelmät

Nimi Description
ErrorRelatedResource

Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse

Virhevastaus.
ErrorResponseDetails

Virheen vastauksen tiedot.
GroupDetails

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.
GroupType

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
Item

Kohteen tiedot.
Items

Kohteiden luettelo.
ItemState

Kohteen tila. Kohteen lisätiloja voidaan lisätä ajan kuluessa.
ItemType

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
Principal

Edustaa käyttäjätietoja tai Microsoft Entra -ryhmää.
PrincipalType

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
ServicePrincipalDetails

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.
ServicePrincipalProfileDetails

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.
UserDetails

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

ErrorRelatedResource

Object

Virheeseen liittyvä resurssitieto-objekti.

Nimi Tyyppi Description
resourceId

string

Virheestä liittyvä resurssitunnus.
resourceType

string

Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Object

Virhevastaus.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
moreDetails

ErrorResponseDetails[]

Luettelo virheiden lisätiedoista.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.
requestId

string

Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Object

Virheen vastauksen tiedot.

Nimi Tyyppi Description
errorCode

string

Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message

string

Ihmisen luettavissa oleva esitys virheestä.
relatedResource

ErrorRelatedResource

Virheisiin liittyvät resurssitiedot.

GroupDetails

Object

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi Tyyppi Description
groupType

GroupType

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo Description
DistributionList

Principal on jakeluluettelo.
SecurityGroup

Principal on käyttöoikeusryhmä.
Unknown

Pääryhmän tyyppi on tuntematon.

Item

Object

Kohteen tiedot.

Nimi Tyyppi Description
capacityId

string

uuid

Tämä on työtilan kapasiteetin tunnus.
creatorPrincipal

Principal

Kohteen omistaja.
description

string

Kohteen tiedot, mukaan lukien kohdetyyppi ja kohteen käyttö.
id

string

uuid

Kohdetunnus.
lastUpdatedDate

string

date-time

Viimeisin päivityspäivämäärä ja -aika.
name

string

Kohteen nimi.
state

ItemState

Kohteen tila.
type

ItemType

Kohdetyyppi. Sisältää arvot, kuten Synapse, Notebook, Kqldatabase ja SynapseWorkbook.
workspaceId

string

uuid

Kohteen työtilan tunnus.

Items

Object

Kohteiden luettelo.

Nimi Tyyppi Description
continuationToken

string

Seuraavan tulosjoukkoerän tunnus. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
continuationUri

string

Seuraavan tulosjoukkoerän URI. Jos tietueita ei ole enempää, ne poistetaan vastauksesta.
itemEntities

Item[]

Tietyn vuokraajan kohteiden luettelo.

ItemState

Luettelointi

Kohteen tila. Kohteen lisätiloja voidaan lisätä ajan kuluessa.

Arvo Description
Active

Aktiivinen kohde.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo Description
Dashboard

Power BI -koontinäyttö.
DataPipeline

Tietoputki.
Datamart

PowerBI -tietomarssi.
Environment

Ympäristö.
Eventhouse

Tapahtumatalo.
Eventstream

Tapahtumavirta.
GraphQLApi

Ohjelmointirajapinta GraphQL-kohteelle.
KQLDashboard

KQL-koontinäyttö.
KQLDatabase

KQL-tietokanta.
KQLQueryset

KQL-kyselyjoukko.
Lakehouse

Tämä on lakehouse.
MLExperiment

Koneoppimisen kokeilu.
MLModel

Koneoppimismalli.
MirroredDatabase

Peilattu tietokanta.
MirroredWarehouse

Peilattu varasto.
MountedDataFactory

A MountedDataFactory.
Notebook

Muistikirja.
PaginatedReport

PowerBI:n sivutettu raportti.
Reflex

Refleksi.
Report

PowerBI -raportti.
SQLDatabase

A SQLDatabase.
SQLEndpoint

SQL-päätepiste.
SemanticModel

PowerBI:n semanttinen malli.
SparkJobDefinition

Spark-työn määritelmä.
Warehouse

Varasto.

Principal

Object

Edustaa käyttäjätietoja tai Microsoft Entra -ryhmää.

Nimi Tyyppi Description
displayName

string

Tämä on päänimen näyttönimi.
groupDetails

GroupDetails

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.
id

string

uuid

Päänimen tunnus.
servicePrincipalDetails

ServicePrincipalDetails

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.
type

PrincipalType

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails

UserDetails

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo Description
Group

Principal on käyttöoikeusryhmä.
ServicePrincipal

Principal on Microsoft Entra -palvelun päänimi.
ServicePrincipalProfile

Principal on palvelun pääprofiili.
User

Principal on Microsoft Entra -käyttäjäobjekti.

ServicePrincipalDetails

Object

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi Tyyppi Description
aadAppId

string

uuid

Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalProfileDetails

Object

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi Tyyppi Description
parentPrincipal

Principal

Palvelun pääprofiilin pääobjekti.

UserDetails

Object

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi Tyyppi Description
userPrincipalName

string

Täydellinen käyttäjänimi.