Items - List Items

Tjeneste:: Admin

API-version:: v1

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

Note

Denne API er en del af en prøveversion og leveres kun til evaluerings- og udviklingsformål. Det kan ændre sig baseret på feedback og anbefales ikke til produktionsbrug.

Denne API understøtter sideinddeling. Der kan maksimalt returneres 10.000 poster pr. anmodning. Med det fortløbende token, der er angivet i svaret, kan du få de næste 10.000 poster.

Siderækkefølge:

Stofelementer
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

Den, der ringer op, skal være Fabric-administrator eller godkende ved hjælp af en tjenesteprincipal.

Påkrævede delegerede områder

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maksimalt 200 anmodninger pr. time.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identity	Support
User	Yes
tjenesteprincipal og administrerede identiteter	Yes

Interface

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

Med valgfrie parametre:

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

URI-parametre

Name	I	Type	Beskrivelse
capacityId	query	string (uuid)	Kapacitets-id'et for arbejdsområdet.
continuationToken	query	string	Fortløbende token bruges til at hente de næste sideelementer.
state	query	string	Elementtilstanden. Understøttede tilstande er aktive.
type	query	string	Elementtypen.
workspaceId	query	string (uuid)	Arbejdsområde-id'et.

Svar

Name	Type	Beskrivelse
200 OK	Items	Handlingen blev udført.
Other Status Codes	ErrorResponse	Almindelige fejlkoder: ItemNotFound – Element-id'et findes ikke. InvalidItemType – Elementtypen er ikke gyldig. InvalidItemState – Elementtilstanden er ikke gyldig.

Name

Type

Beskrivelse

200 OK

Items

Handlingen blev udført.

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

ItemNotFound – Element-id'et findes 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

Eksempelanmodning

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

Eksempelanmodning

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"
        }
      },
      "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

Eksempelanmodning

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
}

Definitioner

Name	Beskrivelse
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.
Item	Elementoplysninger.
Items	En liste over elementer.
ItemState	Elementtilstanden. Der kan tilføjes flere elementtilstande over tid.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
Principal	Repræsenterer en identitet eller en Microsoft Entra-gruppe.
PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GroupDetails

Objekt

Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.

Name	Type	Beskrivelse
groupType	GroupType	Gruppens type. Der kan tilføjes flere gruppetyper over tid.

GroupType

Optælling

Gruppens type. Der kan tilføjes flere gruppetyper over tid.

Værdi	Beskrivelse
Unknown	Hovedgruppetypen er ukendt.
SecurityGroup	Principal er en sikkerhedsgruppe.
DistributionList	Principal er en distributionsliste.

Item

Objekt

Elementoplysninger.

Name	Type	Beskrivelse
capacityId	string (uuid)	Kapacitets-id'et for arbejdsområdet.
creatorPrincipal	Principal	Elementets ejer.
description	string	Elementoplysninger, herunder elementtype og vareforbrug.
folderId	string (uuid)	Mappe-id'et for elementet.
id	string (uuid)	Element-id'et.
lastUpdatedDate	string (date-time)	Dato og klokkeslæt for seneste opdatering.
name	string	Elementnavnet.
state	ItemState	Elementstatus.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen. Indeholder værdier som Synapse, Notebook, Kqldatabase og SynapseWorkbook.
workspaceId	string (uuid)	Elementets arbejdsområde-id.

Items

Objekt

En liste over elementer.

Name	Type	Beskrivelse
continuationToken	string	Tokenet for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
continuationUri	string	URI'en for det næste resultatsætbatch. Hvis der ikke er flere poster, fjernes de fra svaret.
itemEntities	Item[]	Listen over elementer for en given lejer.

ItemState

Optælling

Elementtilstanden. Der kan tilføjes flere elementtilstande over tid.

Værdi	Beskrivelse
Active	Et aktivt element.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.
Ontology	En ontologi.
EventSchemaSet	Et EventSchemaSet.

Principal

Objekt

Repræsenterer en identitet eller en Microsoft Entra-gruppe.

Name	Type	Beskrivelse
displayName	string	Hovedprincipalens viste navn.
groupDetails	GroupDetails	Gruppér specifikke oplysninger. Gælder, når hovedtypen er `Group`.
id	string (uuid)	Hovedprincipalens id.
servicePrincipalDetails	ServicePrincipalDetails	Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er `ServicePrincipalProfile`.
type	PrincipalType	Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.
userDetails	UserDetails	Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er `User`.

PrincipalType

Optælling

Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid.

Værdi	Beskrivelse
User	Principal er en Microsoft Entra-brugerprincipal.
ServicePrincipal	Principal er en Microsoft Entra-tjenesteprincipal.
Group	Principal er en sikkerhedsgruppe.
ServicePrincipalProfile	Principal er en tjenesteprincipalprofil.
EntireTenant	Principal repræsenterer alle lejerbrugere.

ServicePrincipalDetails

Objekt

Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.

Name	Type	Beskrivelse
aadAppId	string (uuid)	Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.

Name	Type	Beskrivelse
parentPrincipal	Principal	Profilen for tjenesteprincipalens overordnede hoved.

UserDetails

Objekt

Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.

Name	Type	Beskrivelse
userPrincipalName	string	Brugerens hovednavn.

Del via

Items - List Items

Permissions

Påkrævede delegerede områder

Limitations

Microsoft Entra-understøttede identiteter

Interface

URI-parametre

Svar

Eksempler

Get a list of items using type query parameter example

Eksempelanmodning

Eksempelsvar

Get all items in the tenant example

Eksempelanmodning

Eksempelsvar

Get list of datamarts using type query parameter example

Eksempelanmodning

Eksempelsvar

Definitioner

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails