Items - Get Item
Returnerer det angivne Fabric eller PowerBI-element.
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.
Permissions
Kalderen 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 identities, der er angivet i dette afsnit.
| Identity | Support |
|---|---|
| User | Yes |
| tjenesteprincipal og administrerede identiteter | 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-parametre
| Name | I | Påkrævet | Type | Beskrivelse |
|---|---|---|---|---|
|
item
|
path | True |
string (uuid) |
Element-id |
|
workspace
|
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:
|
Svar
| Name | Type | Beskrivelse |
|---|---|---|
| 200 OK |
OK |
|
| 429 Too Many Requests |
Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Headere Retry-After: integer |
|
| Other Status Codes |
Almindelige fejlkoder:
|
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
{
"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"
}
},
"defaultIdentity": {
"id": "ff3c8689-591c-4298-a228-4ffcc77cb661",
"displayName": "Caleb Foster",
"type": "User",
"userDetails": {
"userPrincipalName": "caleb@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
{
"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 |
|---|---|
|
Entire |
Repræsenterer en lejerprincipal |
|
Error |
Objektet med fejlrelaterede ressourceoplysninger. |
|
Error |
Fejlsvaret. |
|
Error |
Oplysninger om fejlsvar. |
|
Group |
Gruppér specifikke oplysninger. Gælder, når hovedtypen er |
|
Group |
Repræsenterer en sikkerhedsgruppe. |
|
Group |
Gruppens type. Der kan tilføjes flere gruppetyper over tid. |
| Item |
Elementoplysninger. |
|
Item |
Elementtilstanden. Der kan tilføjes flere elementtilstande over tid. |
|
Item |
Repræsenterer et mærke, der er anvendt på et element. |
|
Item |
Elementets type. Der kan tilføjes flere elementtyper over tid. |
|
Principal |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
|
Service |
Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er |
|
Service |
Repræsenterer en Microsoft Entra tjenesteprincipal. |
|
Service |
Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er |
|
Service |
Repræsenterer en tjenesteprincipalprofil. |
|
User |
Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er |
|
User |
Repræsenterer en Microsoft Entra brugerprincipal. |
EntireTenantPrincipal
Repræsenterer en lejerprincipal
| Name | Type | Beskrivelse |
|---|---|---|
| displayName |
string |
Hovedprincipalens viste navn. |
| id |
string (uuid) |
Hovedprincipalens id. |
| type |
string:
Entire |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
ErrorRelatedResource
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
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 |
Liste over yderligere oplysninger om fejl. |
|
| relatedResource |
De fejlrelaterede ressourceoplysninger. |
|
| requestId |
string (uuid) |
Id'et for den anmodning, der er knyttet til fejlen. |
ErrorResponseDetails
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 |
De fejlrelaterede ressourceoplysninger. |
GroupDetails
Gruppér specifikke oplysninger. Gælder, når hovedtypen er Group.
| Name | Type | Beskrivelse |
|---|---|---|
| groupType |
Gruppens type. Der kan tilføjes flere gruppetyper over tid. |
GroupPrincipal
Repræsenterer en sikkerhedsgruppe.
| Name | Type | Beskrivelse |
|---|---|---|
| displayName |
string |
Hovedprincipalens viste navn. |
| groupDetails |
Gruppér specifikke oplysninger. Gælder, når hovedtypen er |
|
| id |
string (uuid) |
Hovedprincipalens id. |
| type |
string:
Group |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
GroupType
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
Elementoplysninger.
| Name | Type | Beskrivelse |
|---|---|---|
| capacityId |
string (uuid) |
Kapacitets-id'et for arbejdsområdet. |
| creatorPrincipal | Principal: |
Elementets ejer. |
| defaultIdentity | Principal: |
Elementets standardidentitet. |
| 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 |
Elementstatus. |
|
| tags |
Item |
Liste over anvendte mærker. |
| type |
Elementtypen. Indeholder værdier som Synapse, Notebook, Kqldatabase og SynapseWorkbook. |
|
| workspaceId |
string (uuid) |
Elementets arbejdsområde-id. |
ItemState
Elementtilstanden. Der kan tilføjes flere elementtilstande over tid.
| Værdi | Beskrivelse |
|---|---|
| Active |
Et aktivt element. |
ItemTag
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
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. |
| DataAgent |
En DataAgent. |
PrincipalType
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
Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipal.
| Name | Type | Beskrivelse |
|---|---|---|
| aadAppId |
string (uuid) |
Tjenesteprincipalens Microsoft Entra AppId. |
ServicePrincipalPrincipal
Repræsenterer en Microsoft Entra tjenesteprincipal.
| Name | Type | Beskrivelse |
|---|---|---|
| displayName |
string |
Hovedprincipalens viste navn. |
| id |
string (uuid) |
Hovedprincipalens id. |
| servicePrincipalDetails |
Specifikke oplysninger om tjenesteprincipal. Gælder, når hovedtypen er |
|
| type |
string:
Service |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
ServicePrincipalProfileDetails
Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er ServicePrincipalProfile.
| Name | Type | Beskrivelse |
|---|---|---|
| parentPrincipal | Principal: |
Profilen for tjenesteprincipalens overordnede hoved. |
ServicePrincipalProfilePrincipal
Repræsenterer en tjenesteprincipalprofil.
| Name | Type | Beskrivelse |
|---|---|---|
| displayName |
string |
Hovedprincipalens viste navn. |
| id |
string (uuid) |
Hovedprincipalens id. |
| servicePrincipalProfileDetails |
Profiloplysninger for tjenesteprincipal. Gælder, når hovedtypen er |
|
| type |
string:
Service |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
UserDetails
Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er User.
| Name | Type | Beskrivelse |
|---|---|---|
| userPrincipalName |
string |
Brugerens hovednavn. |
UserPrincipal
Repræsenterer en Microsoft Entra brugerprincipal.
| Name | Type | Beskrivelse |
|---|---|---|
| displayName |
string |
Hovedprincipalens viste navn. |
| id |
string (uuid) |
Hovedprincipalens id. |
| type |
string:
User |
Typen af hovedprincipal. Der kan tilføjes flere hovedtyper over tid. |
| userDetails |
Specifikke oplysninger om brugerens hovedprincipal. Gælder, når hovedtypen er |