Del via

Items - Get Item

  • Reference
Tjeneste:
Admin
API-version:
v1

Seddel

Denne API er en prøveversion.

Returnerer det angivne Fabric- eller PowerBI-element.

Tilladelser

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

Begrænsninger

Maksimalt 200 anmodninger pr. time.

Microsoft Entra-understøttede identiteter

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

Identitet Støtte
Bruger Ja
tjenesteprincipal og administrerede identiteter Ja

Grænseflade

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

URI-parametre

Name I Påkrævet Type Beskrivelse
itemId
 path True

string

uuid

Element-id
workspaceId
 path True

string

uuid

Arbejdsområde-id'et.
type
 query

string

Elementets type. Når du forespørger om følgende typer, er denne parameter påkrævet:

  • Rapport

  • Instrumentbræt

  • Semantisk model

  • App

  • Dataflow

Svar

Name Type Beskrivelse
200 OK

Item

OK
Other Status Codes

ErrorResponse

Almindelige fejlkoder:

  • ItemNotFound – Element-id'et findes ikke.

  • InvalidItemType – Elementtypen er ikke gyldig.

Eksempler

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

Get item details by ID and type example

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200 
{
  "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

Eksempelanmodning

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

Eksempelsvar

Statuskode:
200 
{
  "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"
    }
  }
}

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

Elementtilstanden. Der kan tilføjes flere elementtilstande over tid.
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

Object

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

Object

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

Object

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

Object

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
DistributionList

Principal er en distributionsliste.
SecurityGroup

Principal er en sikkerhedsgruppe.
Unknown

Hovedgruppetypen er ukendt.

Item

Object

Elementoplysninger.

Name Type Beskrivelse
capacityId

string

uuid

Kapacitets-id'et for arbejdsområdet.
creatorPrincipal

Principal

Elementets ejer.
description

string

Elementoplysninger, herunder elementtype og vareforbrug.
id

string

uuid

Element-id'et.
lastUpdatedDate

string

date-time

Dato og klokkeslæt for seneste opdatering.
name

string

Elementnavnet.
state

ItemState

Elementstatus.
type

ItemType

Elementtypen. Indeholder værdier som Synapse, Notebook, Kqldatabase og SynapseWorkbook.
workspaceId

string

uuid

Elementets arbejdsområde-id.

ItemState

Optælling

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

Værdi Beskrivelse
Active

Et aktivt element.

ItemType

Optælling

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

Værdi Beskrivelse
Dashboard

PowerBI-dashboard.
DataPipeline

En datapipeline.
Datamart

PowerBI-datamart.
Environment

Et miljø.
Eventhouse

Et eventhouse.
Eventstream

En hændelsesstream.
GraphQLApi

En API til GraphQL-element.
KQLDashboard

Et KQL-dashboard.
KQLDatabase

En KQL-database.
KQLQueryset

Et KQL-forespørgselssæt.
Lakehouse

Et søhus.
MLExperiment

Et maskinel indlæringseksperiment.
MLModel

En model til maskinel indlæring.
MirroredDatabase

En spejlet database.
MirroredWarehouse

Et spejlvendt lager.
MountedDataFactory

En MountedDataFactory.
Notebook

En notesbog.
PaginatedReport

Sideinddelt PowerBI-rapport.
Reflex

En refleks.
Report

PowerBI-rapport.
SQLDatabase

En SQLDatabase.
SQLEndpoint

Et SQL-slutpunkt.
SemanticModel

Semantisk PowerBI-model.
SparkJobDefinition

En spark jobdefinition.
Warehouse

Et lager.

Principal

Object

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
Group

Principal er en sikkerhedsgruppe.
ServicePrincipal

Principal er en Microsoft Entra-tjenesteprincipal.
ServicePrincipalProfile

Principal er en tjenesteprincipalprofil.
User

Principal er en Microsoft Entra-brugerprincipal.

ServicePrincipalDetails

Object

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

Name Type Beskrivelse
aadAppId

string

uuid

Tjenesteprincipalens Microsoft Entra AppId.

ServicePrincipalProfileDetails

Object

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

Name Type Beskrivelse
parentPrincipal

Principal

Profilen for tjenesteprincipalens overordnede hoved.

UserDetails

Object

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

Name Type Beskrivelse
userPrincipalName

string

Brugerens hovednavn.