Delen via


Items - Get Item

Retourneert het opgegeven Fabric- of PowerBI-item.

Note

Deze API maakt deel uit van een preview-versie en is alleen beschikbaar voor evaluatie- en ontwikkelingsdoeleinden. Het kan veranderen op basis van feedback en wordt niet aanbevolen voor productiegebruik.

Permissions

De aanroeper moet een Fabric-beheerder zijn of verifiëren met behulp van een service-principal.

Vereiste gedelegeerde bereiken

Tenant.Read.All of Tenant.ReadWrite.All

Limitations

Maximaal 200 aanvragen per uur.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft-identiteiten die in deze sectie worden vermeld.

Identity Support
User Yes
serviceprincipal en beheerde identiteiten Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}
GET https://api.fabric.microsoft.com/v1/admin/workspaces/{workspaceId}/items/{itemId}?type={type}

URI-parameters

Name In Vereist Type Description
itemId
path True

string (uuid)

De item-id

workspaceId
path True

string (uuid)

De werkruimte-id.

type
query

string

Het type item. Bij het uitvoeren van query's op de volgende typen is deze parameter vereist:

  • Report

  • Dashboard

  • SemanticModel

  • App

  • Dataflow

Antwoorden

Name Type Description
200 OK

Item

OK

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • ItemNotFound - Item-id bestaat niet.

  • InvalidItemType - Itemtype is niet geldig.

Voorbeelden

Get item details by ID and type example
Get item details by ID example

Get item details by ID and type example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48?type=Report

Voorbeeldrespons

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Report",
  "name": "Test",
  "description": "Test Jacob's Report,",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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"
    }
  }
}

Get item details by ID example

Voorbeeldaanvraag

GET https://api.fabric.microsoft.com/v1/admin/workspaces/7f4496db-9929-47bd-89c0-d7eb2f517a98/items/f089354e-8366-4e18-aea3-4cb4a3a50b48

Voorbeeldrespons

{
  "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2",
  "type": "Kusto",
  "name": "Test",
  "description": "Test Jacob's notebook.",
  "state": "Active",
  "lastUpdatedDate": "2022-04-29T17:47:29.98673",
  "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"
    }
  }
}

Definities

Name Description
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.

ErrorResponse

Het foutbericht.

ErrorResponseDetails

De details van het foutbericht.

GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Item

Itemdetails.

ItemState

De itemstatus. Er kunnen in de loop van de tijd extra itemstatussen worden toegevoegd.

ItemTag

Vertegenwoordigt een tag die is toegepast op een item.

ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Principal

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.

PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.

resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.

message

string

Een leesbare weergave van de fout.

moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.

relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.

message

string

Een leesbare weergave van de fout.

relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.

GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

Name Type Description
groupType

GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

GroupType

Het type groep. Er kunnen in de loop van de tijd extra groepstypen worden toegevoegd.

Waarde Description
Unknown

Het type Principal-groep is onbekend.

SecurityGroup

Principal is een beveiligingsgroep.

DistributionList

Principal is een distributielijst.

Item

Itemdetails.

Name Type Description
capacityId

string (uuid)

De capaciteits-id van de werkruimte.

creatorPrincipal

Principal

De eigenaar van het item.

description

string

Itemdetails, waaronder itemtype en itemgebruik.

folderId

string (uuid)

De map-id van het item.

id

string (uuid)

De item-id.

lastUpdatedDate

string (date-time)

De laatst bijgewerkte datum en tijd.

name

string

De itemnaam.

state

ItemState

De itemstatus.

tags

ItemTag[]

Lijst met toegepaste tags.

type

ItemType

Het itemtype. Bevat waarden zoals Synapse, Notebook, Kqldatabase en SynapseWorkbook.

workspaceId

string (uuid)

De werkruimte-id van het item.

ItemState

De itemstatus. Er kunnen in de loop van de tijd extra itemstatussen worden toegevoegd.

Waarde Description
Active

Een actief item.

ItemTag

Vertegenwoordigt een tag die is toegepast op een item.

Name Type Description
displayName

string

De naam van de tag.

id

string (uuid)

De tag-id.

ItemType

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde Description
Dashboard

PowerBI-dashboard.

Report

PowerBI-rapport.

SemanticModel

Semantisch Power BI-model.

PaginatedReport

Gepagineerd Power BI-rapport.

Datamart

PowerBI-datamart.

Lakehouse

Een lakehouse.

Eventhouse

Een eventhouse.

Environment

Een omgeving.

KQLDatabase

Een KQL-database.

KQLQueryset

Een KQL-queryset.

KQLDashboard

Een KQL-dashboard.

DataPipeline

Een gegevenspijplijn.

Notebook

Een notitieblok.

SparkJobDefinition

Een Spark-taakdefinitie.

MLExperiment

Een machine learning-experiment.

MLModel

Een machine learning-model.

Warehouse

Een magazijn.

Eventstream

Een eventstream.

SQLEndpoint

Een SQL-eindpunt.

MirroredWarehouse

Een gespiegeld magazijn.

MirroredDatabase

Een gespiegelde database.

Reflex

Een reflex.

GraphQLApi

Een API voor GraphQL-item.

MountedDataFactory

Een MountedDataFactory.

SQLDatabase

Een SQLDatabase.

CopyJob

Een kopieertaak.

VariableLibrary

Een VariableLibrary.

Dataflow

Een gegevensstroom.

ApacheAirflowJob

Een ApacheAirflowJob.

WarehouseSnapshot

Een momentopname van een magazijn.

DigitalTwinBuilder

Een DigitalTwinBuilder.

DigitalTwinBuilderFlow

Een Digital Twin Builder Flow.

MirroredAzureDatabricksCatalog

Een gespiegelde Azure Databricks-catalogus.

Map

Een kaart.

AnomalyDetector

Een Anomaly Detector.

UserDataFunction

Een gebruikersgegevensfunctie.

GraphModel

Een GraphModel.

GraphQuerySet

Een Graph QuerySet.

SnowflakeDatabase

Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.

OperationsAgent

Een OperationsAgent.

CosmosDBDatabase

Een Cosmos DB-database.

Ontology

Een Ontologie.

EventSchemaSet

Een EventSchemaSet.

Principal

Vertegenwoordigt een identiteit of een Microsoft Entra-groep.

Name Type Description
displayName

string

De weergavenaam van de principal.

groupDetails

GroupDetails

Groepsspecifieke details. Van toepassing wanneer het principal-type is Group.

id

string (uuid)

De id van de principal.

servicePrincipalDetails

ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

type

PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

userDetails

UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

PrincipalType

Het type principal. Er kunnen in de loop van de tijd extra principal-typen worden toegevoegd.

Waarde Description
User

Principal is een Microsoft Entra-gebruikersprincipaal.

ServicePrincipal

Principal is een Microsoft Entra-service-principal.

Group

Principal is een beveiligingsgroep.

ServicePrincipalProfile

Principal is een service-principalprofiel.

EntireTenant

Principal vertegenwoordigt alle tenantgebruikers.

ServicePrincipalDetails

Specifieke details van de service-principal. Van toepassing wanneer het principal-type is ServicePrincipal.

Name Type Description
aadAppId

string (uuid)

De Microsoft Entra AppId van de service-principal.

ServicePrincipalProfileDetails

Details van service-principalprofiel. Van toepassing wanneer het principal-type is ServicePrincipalProfile.

Name Type Description
parentPrincipal

Principal

De bovenliggende principal van het service-principalprofiel.

UserDetails

Specifieke details van gebruikersprincipaal. Van toepassing wanneer het principal-type is User.

Name Type Description
userPrincipalName

string

De principal-naam van de gebruiker.