Items - List Items

Referens

Tjänst:: Admin

API-version:: v1

Not

Det här API:et är i förhandsversion.

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

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:

Infrastrukturobjekt
Datamarter
Rapporter
Instrumentbrädor
SemanticModels
Apps
Dataflöden

Behörigheter

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

Obligatoriska delegerade omfång

Tenant.Read.All eller Tenant.ReadWrite.All

Begränsningar

Maximalt 200 begäranden per timme.

Identiteter som stöds av Microsoft Entra

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

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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	Items	Åtgärden lyckades.
Other Status Codes	ErrorResponse	Vanliga felkoder: ItemNotFound – objekt-ID finns inte. InvalidItemType – Objekttypen är inte giltig. InvalidItemState – Objekttillståndet är inte giltigt.

Name

Typ

Description

200 OK

Items

Åtgärden lyckades.

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

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"
        }
      }
    }
  ],
  "continuationUri": null,
  "continuationToken": null
}

Definitioner

Name	Description
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
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.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
Principal	Representerar en identitet eller en Microsoft Entra-grupp.
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`.
ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
UserDetails	Specifik information om användarens huvudnamn. Gäller när huvudtypen är `User`.

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	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.

GroupType

Uppräkning

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

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

Item

Objekt

Objektinformation.

Name	Typ	Description
capacityId	string uuid	Arbetsytans kapacitets-ID.
creatorPrincipal	Principal	Objektets ägare.
description	string	Objektinformation, inklusive objekttyp och objektanvändning.
id	string uuid	Objekt-ID:t.
lastUpdatedDate	string date-time	Senaste uppdaterade datum och tid.
name	string	Objektnamnet.
state	ItemState	Objektstatus.
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.

ItemType

Uppräkning

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

Värde	Description
Dashboard	PowerBI-instrumentpanel.
DataPipeline	En datapipeline.
Datamart	PowerBI-datamart.
Environment	En miljö.
Eventhouse	Ett eventhouse.
Eventstream	En händelseström.
GraphQLApi	Ett API för GraphQL-objekt.
KQLDashboard	En KQL-instrumentpanel.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
Lakehouse	Ett sjöhus.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
MirroredDatabase	En speglad databas.
MirroredWarehouse	Ett speglat lager.
MountedDataFactory	En MountedDataFactory.
Notebook	En notebook-fil.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Reflex	En reflex.
Report	PowerBI-rapport.
SQLDatabase	En SQLDatabase.
SQLEndpoint	En SQL-slutpunkt.
SemanticModel	PowerBI-semantisk modell.
SparkJobDefinition	En definition för Spark-jobb.
Warehouse	Ett lager.

Principal

Objekt

Representerar en identitet eller en Microsoft Entra-grupp.

Name	Typ	Description
displayName	string	Huvudkontots visningsnamn.
groupDetails	GroupDetails	Gruppera specifik information. Gäller när huvudtypen är `Group`.
id	string uuid	Huvudmannens ID.
servicePrincipalDetails	ServicePrincipalDetails	Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är `ServicePrincipalProfile`.
type	PrincipalType	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`.

PrincipalType

Uppräkning

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

Värde	Description
Group	Huvudnamn är en säkerhetsgrupp.
ServicePrincipal	Principal är microsoft entra-tjänstens huvudnamn.
ServicePrincipalProfile	Huvudnamn är en profil för tjänstens huvudnamn.
User	Principal är ett Microsoft Entra-användarhuvudnamn.

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.

ServicePrincipalProfileDetails

Objekt

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

Name	Typ	Description
parentPrincipal	Principal	Tjänstens huvudnamnsprofils överordnade huvudnamn.

UserDetails

Objekt

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

Name	Typ	Description
userPrincipalName	string	Användarens huvudnamn.

Dela via

Items - List Items

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Svar

Exempel

Get a list of items using type query parameter example

Exempelbegäran

Exempelsvar

Get all items in the tenant example

Exempelbegäran

Exempelsvar

Get list of datamarts using type query parameter example

Exempelbegäran

Exempelsvar

Definitioner

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

Items

ItemState

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails

Ytterligare resurser