Items - List Items

Tjänst:: Admin

API-version:: v1

Returnerar en lista över aktiva Fabric- och PowerBI-objekt.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Det här API:et stöder sidnumrering. Högst 10 000 poster kan returneras per begäran. Med den kontinuerliga token som anges i svaret kan du hämta de kommande 10 000 posterna.

Sidordning:

Fabric objekt
Datamarts
Reports
Dashboards
SemanticModels
Apps
Dataflows

Permissions

Anroparen måste vara en Fabric administratör eller autentisera med hjälp av tjänstens huvudnamn.

Obligatoriska delegerade omfång

Tenant.Read.All eller Tenant.ReadWrite.All

Limitations

Maximalt 200 begäranden per timme.

Microsoft Entra identiteter som stöds

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity	Support
User	Yes
Tjänsthuvudnamn och hanterade identiteter	Yes

Interface

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

Med valfria parametrar:

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

URI-parametrar

Name	I	Typ	Description
capacityId	query	string (uuid)	Arbetsytans kapacitets-ID.
continuationToken	query	string	Kontinuerlig token som används för att hämta nästa sidobjekt.
state	query	string	Objekttillståndet. Tillstånd som stöds är aktiva.
type	query	string	Objekttypen.
workspaceId	query	string (uuid)	Arbetsytans ID.

Svar

Name Typ Description

200 OK

Name	Typ	Description
200 OK	Items	Åtgärden lyckades.
429 Too Many Requests	ErrorResponse	Gränsen för tjänstfrekvens överskreds. Servern returnerar ett `Retry-After` huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas. Sidhuvuden Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – objekt-ID finns inte. InvalidItemType – Objekttypen är inte giltig. InvalidItemState – Objekttillståndet är inte giltigt.

Items

Åtgärden lyckades.

429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer

Other Status Codes

ErrorResponse

Vanliga felkoder:

ItemNotFound – objekt-ID finns inte.
InvalidItemType – Objekttypen är inte giltig.
InvalidItemState – Objekttillståndet är inte giltigt.

Exempel

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

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

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

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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	Description
EntireTenantPrincipal	Representerar ett klientorganisationsobjekt
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
GroupPrincipal	Representerar en säkerhetsgrupp.
GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
Item	Objektinformation.
Items	En lista över objekt.
ItemState	Objekttillståndet. Ytterligare objekttillstånd kan läggas till över tid.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PrincipalType	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
ServicePrincipalPrincipal	Representerar ett Microsoft Entra tjänstens huvudnamn.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Representerar en profil för tjänstens huvudnamn.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.
UserPrincipal	Representerar ett Microsoft Entra användarens huvudnamn.

EntireTenantPrincipal

Objekt

Representerar ett klientorganisationsobjekt

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: EntireTenant	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string (uuid)	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name	Typ	Description
groupType	GroupType	Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Objekt

Representerar en säkerhetsgrupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string (uuid)	Huvudmannens ID.
type	string: Group	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde	Description
Unknown	Huvudgrupptypen är okänd.
SecurityGroup	Huvudnamn är en säkerhetsgrupp.
DistributionList	Huvudnamn är en distributionslista.

Item

Objekt

Objektinformation.

Name	Typ	Description
capacityId	string (uuid)	Arbetsytans kapacitets-ID.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Objektets ägare.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Objektets standardidentitet.
description	string	Objektinformation, inklusive objekttyp och objektanvändning.
folderId	string (uuid)	Objektets mapp-ID.
id	string (uuid)	Objekt-ID:t.
lastUpdatedDate	string (date-time)	Senaste uppdaterade datum och tid.
name	string	Objektnamnet.
state	ItemState	Objektstatus.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen. Innehåller värden som Synapse, Notebook, Kqldatabase och SynapseWorkbook.
workspaceId	string (uuid)	Arbetsytans ID för objektet.

Items

Objekt

En lista över objekt.

Name	Typ	Description
continuationToken	string	Token för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
continuationUri	string	URI:n för nästa resultatuppsättningsbatch. Om det inte finns några fler poster tas den bort från svaret.
itemEntities	Item[]	Listan över objekt för en viss klientorganisation.

ItemState

Uppräkning

Objekttillståndet. Ytterligare objekttillstånd kan läggas till över tid.

Värde	Description
Active	Ett aktivt objekt.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En anteckningsbok.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.
Ontology	En ontologi.
EventSchemaSet	En EventSchemaSet.
DataAgent	En DataAgent.
MirroredCatalog	En MirroredCatalog.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde	Description
User	Huvudkontot är ett Microsoft Entra användarens huvudnamn.
ServicePrincipal	Huvudnamn är ett Microsoft Entra tjänstens huvudnamn.
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant	Huvudkontot representerar alla klientanvändare.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name	Typ	Description
aadAppId	string (uuid)	Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerar ett Microsoft Entra tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
type	string: ServicePrincipal	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name	Typ	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Objekt

Representerar en profil för tjänstens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

UserPrincipal

Objekt

Representerar ett Microsoft Entra användarens huvudnamn.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
id	string (uuid)	Huvudmannens ID.
type	string: User	Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails	UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.