Sdílet prostřednictvím

Items - Get Item

  • Reference
Služba:
Admin
Verze rozhraní API:
v1

Poznámka

Toto rozhraní API je ve verzi Preview.

Vrátí zadanou položku Fabric nebo PowerBI.

Dovolení

Volající musí být správce prostředků infrastruktury nebo se musí ověřit pomocí instančního objektu.

Požadované delegovaná rozsahy

Tenant.Read.All nebo Tenant.ReadWrite.All

Omezení

Maximálně 200 požadavků za hodinu.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita Podpora
Uživatel Ano
instančního objektu a spravované identity Ano

Rozhraní

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
itemId
 path True

string

uuid

ID položky
workspaceId
 path True

string

uuid

ID pracovního prostoru.
type
 query

string

Typ položky. Při dotazování na následující typy je tento parametr povinný:

  • Zpráva

  • Palubní deska

  • Sémantický model

  • App

  • Dataflow

Odpovědi

Name Typ Description
200 OK

Item

OK
Other Status Codes

ErrorResponse

Běžné kódy chyb:

  • ItemNotFound – ID položky neexistuje.

  • InvalidItemType – Typ položky není platný.

Příklady

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

Get item details by ID and type example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:
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"
    }
  }
}

Definice

Name Description
ErrorRelatedResource

Chyba související s objektem podrobností o prostředku.
ErrorResponse

Odpověď na chybu.
ErrorResponseDetails

Podrobnosti o odpovědi na chybu.
GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.
Item

Podrobnosti o položce
ItemState

Stav položky. Další stavy položek mohou být přidány v průběhu času.
ItemType

Typ položky. V průběhu času je možné přidat další typy položek.
Principal

Představuje identitu nebo skupinu Microsoft Entra.
PrincipalType

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name Typ Description
resourceId

string

ID prostředku, které je součástí chyby.
resourceType

string

Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
moreDetails

ErrorResponseDetails[]

Seznam dalších podrobností o chybě
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou
requestId

string

ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name Typ Description
errorCode

string

Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message

string

Lidské čitelné vyjádření chyby.
relatedResource

ErrorRelatedResource

Podrobnosti o prostředku souvisejícím s chybou

GroupDetails

Objekt

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.

Name Typ Description
groupType

GroupType

Typ skupiny. V průběhu času je možné přidat další typy skupin.

GroupType

Výčet

Typ skupiny. V průběhu času je možné přidat další typy skupin.

Hodnota Description
DistributionList

Objekt zabezpečení je distribuční seznam.
SecurityGroup

Objekt zabezpečení je skupina zabezpečení.
Unknown

Typ hlavní skupiny je neznámý.

Item

Objekt

Podrobnosti o položce

Name Typ Description
capacityId

string

uuid

ID kapacity pracovního prostoru.
creatorPrincipal

Principal

Vlastník položky.
description

string

Podrobnosti o položce, včetně typu položky a využití položek
id

string

uuid

ID položky.
lastUpdatedDate

string

date-time

Datum a čas poslední aktualizace.
name

string

Název položky.
state

ItemState

Stav položky.
type

ItemType

Typ položky. Obsahuje hodnoty, jako jsou Synapse, Notebook, Kqldatabase a SynapseWorkbook.
workspaceId

string

uuid

ID položky pracovního prostoru.

ItemState

Výčet

Stav položky. Další stavy položek mohou být přidány v průběhu času.

Hodnota Description
Active

Aktivní položka.

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota Description
Dashboard

Řídicí panel PowerBI
DataPipeline

Datový kanál.
Datamart

Datový diagram PowerBI
Environment

Prostředí.
Eventhouse

Eventhouse.
Eventstream

Eventstream.
GraphQLApi

Rozhraní API pro položku GraphQL
KQLDashboard

Řídicí panel KQL.
KQLDatabase

Databáze KQL.
KQLQueryset

Sada dotazů KQL.
Lakehouse

Jezero.
MLExperiment

Experiment strojového učení.
MLModel

Model strojového učení.
MirroredDatabase

Zrcadlené databáze.
MirroredWarehouse

Zrcadlený sklad.
MountedDataFactory

A MountedDataFactory.
Notebook

Poznámkový blok.
PaginatedReport

Stránkovaná sestava PowerBI
Reflex

A Reflex.
Report

Sestava PowerBI
SQLDatabase

Databáze SQLDatabase.
SQLEndpoint

Koncový bod SQL.
SemanticModel

Sémantický model PowerBI
SparkJobDefinition

Definice úlohy Sparku.
Warehouse

Sklad.

Principal

Objekt

Představuje identitu nebo skupinu Microsoft Entra.

Name Typ Description
displayName

string

Zobrazovaný název objektu zabezpečení.
groupDetails

GroupDetails

Seskupte konkrétní podrobnosti. Použitelné, pokud je typ objektu zabezpečení Group.
id

string

uuid

ID objektu zabezpečení.
servicePrincipalDetails

ServicePrincipalDetails

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.
type

PrincipalType

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.
userDetails

UserDetails

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

PrincipalType

Výčet

Typ objektu zabezpečení. V průběhu času je možné přidat další typy objektů zabezpečení.

Hodnota Description
Group

Objekt zabezpečení je skupina zabezpečení.
ServicePrincipal

Instanční objekt je instanční objekt Microsoft Entra.
ServicePrincipalProfile

Instanční objekt je profil instančního objektu.
User

Objekt zabezpečení je objekt zabezpečení uživatele Microsoft Entra.

ServicePrincipalDetails

Objekt

Podrobnosti specifické pro instanční objekt Použitelné, pokud je typ objektu zabezpečení ServicePrincipal.

Name Typ Description
aadAppId

string

uuid

Instanční objekt Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Podrobnosti profilu instančního objektu Použitelné, pokud je typ objektu zabezpečení ServicePrincipalProfile.

Name Typ Description
parentPrincipal

Principal

Nadřazený objekt profilu instančního objektu.

UserDetails

Objekt

Podrobnosti specifické pro objekt zabezpečení uživatele. Použitelné, pokud je typ objektu zabezpečení User.

Name Typ Description
userPrincipalName

string

Hlavní název uživatele.