Items - List Items

Tjeneste:: Admin

API-versjon:: v1

Returnerer en liste over aktive Fabric- og PowerBI-elementer.

Note

Denne API-en er en del av en forhåndsversjon, og er bare tilgjengelig for evaluerings- og utviklingsformål. Det kan endres basert på tilbakemelding og anbefales ikke for produksjonsbruk.

Denne API-en støtter paginering. Maksimalt 10 000 poster kan returneres per forespørsel. Med det kontinuerlige tokenet som er angitt i svaret, kan du få de neste 10 000 postene.

Siderekkefølge:

Fabric elementer
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

Innringeren må være en Fabric administrator eller godkjenne ved hjelp av en tjenestekontohaver.

Nødvendige delegerte omfang

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 forespørsler per time.

Microsoft Entra støttede identiteter

Denne API-en støtter Microsoft identiteter oppført i denne delen.

Identity	Support
User	Yes
tjenestekontohaver og administrerte identiteter	Yes

Interface

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

Med valgfrie parametere:

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

URI-parametere

Navn	I	Type	Beskrivelse
capacityId	query	string (uuid)	Kapasitets-ID-en for arbeidsområdet.
continuationToken	query	string	Kontinuerlig token brukes til å hente de neste sideelementene.
state	query	string	Elementtilstanden. Støttede tilstander er aktive.
type	query	string	Elementtypen.
workspaceId	query	string (uuid)	Arbeidsområde-ID-en.

Svar

Navn Type Beskrivelse

200 OK

Navn	Type	Beskrivelse
200 OK	Items	Operasjonen var vellykket.
429 Too Many Requests	ErrorResponse	Grensen for tjenestesats ble overskredet. Serveren returnerer en `Retry-After` topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler. Overskrifter Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: ItemNotFound – Element-ID finnes ikke. InvalidItemType – elementtypen er ikke gyldig. InvalidItemState – elementtilstanden er ikke gyldig.

Items

Operasjonen var vellykket.

429 Too Many Requests

ErrorResponse

Grensen for tjenestesats ble overskredet. Serveren returnerer en Retry-After topptekst som angir, i sekunder, hvor lenge klienten må vente før du sender flere forespørsler.

Overskrifter

Retry-After: integer

Other Status Codes

ErrorResponse

Vanlige feilkoder:

ItemNotFound – Element-ID finnes ikke.
InvalidItemType – elementtypen er ikke gyldig.
InvalidItemState – elementtilstanden er ikke gyldig.

Eksempler

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

Eksempelforespørsel

HTTP

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

Eksempelsvar

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

Eksempelforespørsel

HTTP

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

Eksempelsvar

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

Eksempelforespørsel

HTTP

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

Eksempelsvar

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

Definisjoner

Navn	Beskrivelse
EntireTenantPrincipal	Representerer en leierkontohaver
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
GroupPrincipal	Representerer en sikkerhetsgruppe.
GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.
Item	Elementdetaljer.
Items	En liste over elementer.
ItemState	Elementtilstanden. Flere elementtilstander kan legges til over tid.
ItemTag	Representerer en kode som brukes på et element.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PrincipalType	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
ServicePrincipalPrincipal	Representerer en Microsoft Entra tjenestekontohaver.
ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerer en tjenestekontohaverprofil.
UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.
UserPrincipal	Representerer en Microsoft Entra brukerkontohaver.

EntireTenantPrincipal

Objekt

Representerer en leierkontohaver

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: EntireTenant	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string (uuid)	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

GroupDetails

Objekt

Grupper bestemte detaljer. Gjelder når hovedtypen er Group.

Navn	Type	Beskrivelse
groupType	GroupType	Typen gruppe. Flere gruppetyper kan legges til over tid.

GroupPrincipal

Objekt

Representerer en sikkerhetsgruppe.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
groupDetails	GroupDetails	Grupper bestemte detaljer. Gjelder når hovedtypen er `Group`.
id	string (uuid)	Hovedkontohaverens ID.
type	string: Group	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

GroupType

Opplisting

Typen gruppe. Flere gruppetyper kan legges til over tid.

Verdi	Beskrivelse
Unknown	Hovedgruppetypen er ukjent.
SecurityGroup	Hovedstol er en sikkerhetsgruppe.
DistributionList	Hovedstol er en distribusjonsliste.

Item

Objekt

Elementdetaljer.

Navn	Type	Beskrivelse
capacityId	string (uuid)	Kapasitets-ID-en for arbeidsområdet.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Eieren av elementet.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Elementets standardidentitet.
description	string	Elementdetaljer, inkludert elementtype og elementbruk.
folderId	string (uuid)	Mappe-ID-en for elementet.
id	string (uuid)	Element-ID-en.
lastUpdatedDate	string (date-time)	Siste oppdaterte dato og klokkeslett.
name	string	Elementnavnet.
state	ItemState	Elementstatusen.
tags	ItemTag[]	Liste over brukte merker.
type	ItemType	Elementtypen. Inkluderer verdier som Synapse, Notebook, Kqldatabase og SynapseWorkbook.
workspaceId	string (uuid)	Arbeidsområde-ID-en for elementet.

Items

Objekt

En liste over elementer.

Navn	Type	Beskrivelse
continuationToken	string	Tokenet for den neste resultatsettgruppen. Hvis det ikke er flere poster, fjernes den fra svaret.
continuationUri	string	URI-en for neste satsvise resultatsett. Hvis det ikke er flere poster, fjernes den fra svaret.
itemEntities	Item[]	Listen over elementer for en gitt leier.

ItemState

Opplisting

Elementtilstanden. Flere elementtilstander kan legges til over tid.

Verdi	Beskrivelse
Active	Et aktivt element.

ItemTag

Objekt

Representerer en kode som brukes på et element.

Navn	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaset.
DataAgent	En DataAgent.

PrincipalType

Opplisting

Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

Verdi	Beskrivelse
User	Hovedstol er en Microsoft Entra brukerkontohaver.
ServicePrincipal	Principal er en Microsoft Entra tjenestekontohaver.
Group	Hovedstol er en sikkerhetsgruppe.
ServicePrincipalProfile	Principal er en tjenestekontohaverprofil.
EntireTenant	Hovedstol representerer alle leierbrukere.

ServicePrincipalDetails

Objekt

Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er ServicePrincipal.

Navn	Type	Beskrivelse
aadAppId	string (uuid)	Tjenestekontohaverens Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerer en Microsoft Entra tjenestekontohaver.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalDetails	ServicePrincipalDetails	Spesifikke detaljer for tjenestekontohaver. Gjelder når hovedtypen er `ServicePrincipal`.
type	string: ServicePrincipal	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

ServicePrincipalProfileDetails

Objekt

Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er ServicePrincipalProfile.

Navn	Type	Beskrivelse
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Overordnet hovedkontohaver for tjenestekontohaverprofilen.

ServicePrincipalProfilePrincipal

Objekt

Representerer en tjenestekontohaverprofil.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Detaljer for tjenestekontohaverprofil. Gjelder når hovedtypen er `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.

UserDetails

Objekt

Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er User.

Navn	Type	Beskrivelse
userPrincipalName	string	Brukerhovednavn.

UserPrincipal

Objekt

Representerer en Microsoft Entra brukerkontohaver.

Navn	Type	Beskrivelse
displayName	string	Hovedkontohaverens visningsnavn.
id	string (uuid)	Hovedkontohaverens ID.
type	string: User	Typen hovedstol. Flere hovedstoltyper kan legges til over tid.
userDetails	UserDetails	Spesifikke detaljer for brukerkontohaver. Gjelder når hovedtypen er `User`.