Items - Get Item

Palvelu:: Admin

Ohjelmointirajapinnan versio:: v1

Palauttaa määritetyn Fabric tai PowerBI -kohteen.

Note

Tämä ohjelmointirajapinta on osa esikatseluversiota, ja se on saatavilla vain arviointi- ja kehitystarkoituksiin. Muutos saattaa perustua palautteeseen, eikä sitä suositella tuotantokäyttöön.

Permissions

Soittajan on oltava Fabric järjestelmänvalvoja tai todennettava palvelun päänimen avulla.

Vaaditut delegoidut vaikutusalueet

Tenant.Read.All tai Tenant.ReadWrite.All

Limitations

Enintään 200 pyyntöä tuntia kohti.

tuettujen käyttäjätietojen Microsoft Entra

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft identities.

Identity	Support
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

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

Valinnaisilla parametreilla:

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
itemId	path	True	string (uuid)	Kohteen tunnus
workspaceId	path	True	string (uuid)	Työtilan tunnus.
type	query		string	Kohteen tyyppi. Kun kysely tehdään seuraavantyyppisille kyselyille, tämä parametri vaaditaan: Report Dashboard SemanticModel App Dataflow

Nimi

Kohteessa

Pakollinen

Tyyppi

Description

itemId

path

True

string (uuid)

Kohteen tunnus

workspaceId

path

True

string (uuid)

Työtilan tunnus.

type

query

string

Kohteen tyyppi. Kun kysely tehdään seuraavantyyppisille kyselyille, tämä parametri vaaditaan:

Report
Dashboard
SemanticModel
App
Dataflow

Vastaukset

Nimi Tyyppi Description

200 OK

Nimi	Tyyppi	Description
200 OK	Item	OK
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: ItemNotFound – Kohdetunnusta ei ole. InvalidItemType – Kohdetyyppi ei ole kelvollinen.

Item

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

ItemNotFound – Kohdetunnusta ei ole.
InvalidItemType – Kohdetyyppi ei ole kelvollinen.

Esimerkit

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 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"
    }
  },
  "defaultIdentity": {
    "id": "ff3c8689-591c-4298-a228-4ffcc77cb661",
    "displayName": "Caleb Foster",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "caleb@example.com"
    }
  }
}

Get item details by ID example

Mallipyyntö

HTTP

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

Mallivastaus

Tilakoodi:: 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"
    }
  }
}

Määritelmät

Nimi	Description
EntireTenantPrincipal	Edustaa vuokraajan päänimeä
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
GroupPrincipal	Edustaa käyttöoikeusryhmää.
GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.
Item	Kohteen tiedot.
ItemState	Kohteen tila. Kohteen lisätiloja voidaan lisätä ajan kuluessa.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PrincipalType	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
ServicePrincipalPrincipal	Ilmaisee Microsoft Entra palvelun päänimen.
ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Edustaa palvelun pääprofiilia.
UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.
UserPrincipal	Edustaa Microsoft Entra käyttäjäobjektia.

EntireTenantPrincipal

Kohde

Edustaa vuokraajan päänimeä

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: EntireTenant	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GroupDetails

Kohde

Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on Group.

Nimi	Tyyppi	Description
groupType	GroupType	Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

GroupPrincipal

Kohde

Edustaa käyttöoikeusryhmää.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
groupDetails	GroupDetails	Ryhmäkohtaiset tiedot. Soveltuu, kun päätyyppi on `Group`.
id	string (uuid)	Päänimen tunnus.
type	string: Group	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

GroupType

Luettelointi

Ryhmän tyyppi. Muita ryhmätyyppejä voidaan lisätä ajan mittaan.

Arvo	Description
Unknown	Pääryhmän tyyppi on tuntematon.
SecurityGroup	Principal on käyttöoikeusryhmä.
DistributionList	Principal on jakeluluettelo.

Item

Kohde

Kohteen tiedot.

Nimi	Tyyppi	Description
capacityId	string (uuid)	Tämä on työtilan kapasiteetin tunnus.
creatorPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Kohteen omistaja.
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Kohteen oletusarvoiset käyttäjätiedot.
description	string	Kohteen tiedot, mukaan lukien kohdetyyppi ja kohteen käyttö.
folderId	string (uuid)	Kohteen kansiotunnus.
id	string (uuid)	Kohdetunnus.
lastUpdatedDate	string (date-time)	Viimeisin päivityspäivämäärä ja -aika.
name	string	Kohteen nimi.
state	ItemState	Kohteen tila.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi. Sisältää arvot, kuten Synapse, Notebook, Kqldatabase ja SynapseWorkbook.
workspaceId	string (uuid)	Kohteen työtilan tunnus.

ItemState

Luettelointi

Kohteen tila. Kohteen lisätiloja voidaan lisätä ajan kuluessa.

Arvo	Description
Active	Aktiivinen kohde.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.
Ontology	Ontologia.
EventSchemaSet	An EventSchemaSet.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.

PrincipalType

Luettelointi

Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
User	Principal on Microsoft Entra käyttäjäobjekti.
ServicePrincipal	Principal on Microsoft Entra palvelun päänimi.
Group	Principal on käyttöoikeusryhmä.
ServicePrincipalProfile	Principal on palvelun pääprofiili.
EntireTenant	Principal edustaa kaikkia vuokraajan käyttäjiä.

ServicePrincipalDetails

Kohde

Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on ServicePrincipal.

Nimi	Tyyppi	Description
aadAppId	string (uuid)	Palvelun päänimen Microsoft Entra AppId.

ServicePrincipalPrincipal

Kohde

Ilmaisee Microsoft Entra palvelun päänimen.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalDetails	ServicePrincipalDetails	Palvelun päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `ServicePrincipal`.
type	string: ServicePrincipal	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

ServicePrincipalProfileDetails

Kohde

Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on ServicePrincipalProfile.

Nimi	Tyyppi	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Palvelun pääprofiilin pääobjekti.

ServicePrincipalProfilePrincipal

Kohde

Edustaa palvelun pääprofiilia.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Palvelun pääprofiilin tiedot. Soveltuu, kun päätyyppi on `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.

UserDetails

Kohde

Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on User.

Nimi	Tyyppi	Description
userPrincipalName	string	Täydellinen käyttäjänimi.

UserPrincipal

Kohde

Edustaa Microsoft Entra käyttäjäobjektia.

Nimi	Tyyppi	Description
displayName	string	Tämä on päänimen näyttönimi.
id	string (uuid)	Päänimen tunnus.
type	string: User	Principal-kohteen tyyppi. Muita päänimityyppejä voidaan lisätä ajan kuluessa.
userDetails	UserDetails	Käyttäjän päänimen tarkat tiedot. Soveltuu, kun päätyyppi on `User`.