Items - Get Item

Service:: Admin

Version d'API:: v1

Retourne l’élément Fabric ou PowerBI spécifié.

Note

Cette API fait partie d’une préversion et est fournie uniquement à des fins d’évaluation et de développement. Il peut changer en fonction des commentaires et n’est pas recommandé pour une utilisation en production.

Permissions

L’appelant doit être un administrateur Fabric ou s’authentifier à l’aide d’un principal de service.

Étendues déléguées requises

Tenant.Read.All ou Tenant.ReadWrite.All

Limitations

Maximum 200 requêtes par heure.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identity	Support
User	Yes
Service principal et identités gérées	Yes

Interface

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
itemId	path	True	string (uuid)	ID de l’élément
workspaceId	path	True	string (uuid)	Identifiant de l’espace de travail.
type	query		string	Type de l’élément. Lorsque vous interrogez les types suivants, ce paramètre est requis : Report Dashboard SemanticModel App Dataflow

Nom

Dans

Obligatoire

Type

Description

itemId

path

True

string (uuid)

ID de l’élément

workspaceId

path

True

string (uuid)

Identifiant de l’espace de travail.

type

query

string

Type de l’élément. Lorsque vous interrogez les types suivants, ce paramètre est requis :

Report
Dashboard
SemanticModel
App
Dataflow

Réponses

Nom	Type	Description
200 OK	Item	OK
Other Status Codes	ErrorResponse	Codes d’erreur courants : ItemNotFound : l’ID d’élément n’existe pas. InvalidItemType : le type d’élément n’est pas valide.

Nom

Type

Description

200 OK

Item

Other Status Codes

ErrorResponse

Codes d’erreur courants :

ItemNotFound : l’ID d’élément n’existe pas.
InvalidItemType : le type d’élément n’est pas valide.

Exemples

Get item details by ID and type example

Get item details by ID example

Get item details by ID and type example

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 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"
    }
  }
}

Définitions

Nom	Description
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.
Item	Détails de l’élément.
ItemState	État de l’élément. Des états d’élément supplémentaires peuvent être ajoutés au fil du temps.
ItemTag	Représente une balise appliquée à un élément.
ItemType	Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.
Principal	Représente une identité ou un groupe Microsoft Entra.
PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.

ErrorRelatedResource

Objet

Objet de détails de ressource associé à l’erreur.

Nom	Type	Description
resourceId	string	ID de ressource impliqué dans l’erreur.
resourceType	string	Type de la ressource impliquée dans l’erreur.

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string	ID de la demande associée à l’erreur.

ErrorResponseDetails

Objet

Détails de la réponse d’erreur.

Nom	Type	Description
errorCode	string	Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message	string	Représentation lisible humaine de l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.

GroupDetails

Objet

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.

Nom	Type	Description
groupType	GroupType	Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

GroupType

Énumération

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Unknown	Le type de groupe principal est inconnu.
SecurityGroup	Principal est un groupe de sécurité.
DistributionList	Principal est une liste de distribution.

Item

Objet

Détails de l’élément.

Nom	Type	Description
capacityId	string (uuid)	ID de capacité de l’espace de travail.
creatorPrincipal	Principal	Propriétaire de l’élément.
description	string	Détails de l’élément, y compris le type d’élément et l’utilisation des éléments.
folderId	string (uuid)	ID de dossier de l’élément.
id	string (uuid)	ID d’élément.
lastUpdatedDate	string (date-time)	Date et heure de la dernière mise à jour.
name	string	Nom de l’élément.
state	ItemState	État de l’élément.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément. Inclut des valeurs telles que Synapse, Notebook, Kqldatabase et SynapseWorkbook.
workspaceId	string (uuid)	ID de l’espace de travail de l’élément.

ItemState

Énumération

État de l’élément. Des états d’élément supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Active	Élément actif.

ItemTag

Objet

Représente une balise appliquée à un élément.

Nom	Type	Description
displayName	string	Nom de la balise.
id	string (uuid)	ID de balise.

ItemType

Énumération

Type de l’élément. Des types d’éléments supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
Dashboard	Tableau de bord PowerBI.
Report	Rapport PowerBI.
SemanticModel	Modèle sémantique PowerBI.
PaginatedReport	Rapport paginé PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Un lac.
Eventhouse	Un eventhouse.
Environment	Environnement.
KQLDatabase	Base de données KQL.
KQLQueryset	Ensemble de requêtes KQL.
KQLDashboard	Tableau de bord KQL.
DataPipeline	Un pipeline de données.
Notebook	Un notebook.
SparkJobDefinition	Définition d’un travail Spark.
MLExperiment	Une expérience de Machine Learning.
MLModel	Modèle Machine Learning.
Warehouse	Un entrepôt.
Eventstream	Flux d’événements.
SQLEndpoint	Point de terminaison SQL.
MirroredWarehouse	Un entrepôt mis en miroir.
MirroredDatabase	Une base de données mise en miroir.
Reflex	Un réflexe.
GraphQLApi	API pour l’élément GraphQL.
MountedDataFactory	Un MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Tâche de copie.
VariableLibrary	A VariableLibrary.
Dataflow	Flux de données.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Capture instantanée de l’entrepôt.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flux de générateur de jumeaux numériques.
MirroredAzureDatabricksCatalog	Catalogue Azure databricks mis en miroir.
Map	Carte.
AnomalyDetector	Détecteur d’anomalies.
UserDataFunction	Fonction de données utilisateur.
GraphModel	A GraphModel.
GraphQuerySet	Ensemble de requêtes Graph.
SnowflakeDatabase	Une base de données Snowflake pour stocker les tables Iceberg créées à partir du compte Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Base de données Cosmos DB.
Ontology	Une ontologie.
EventSchemaSet	An EventSchemaSet.

Principal

Objet

Représente une identité ou un groupe Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
groupDetails	GroupDetails	Détails spécifiques du groupe. Applicable lorsque le type principal est `Group`.
id	string (uuid)	ID du principal.
servicePrincipalDetails	ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
type	PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
userDetails	UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.

PrincipalType

Énumération

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
User	Principal est un principal d’utilisateur Microsoft Entra.
ServicePrincipal	Principal est un principal de service Microsoft Entra.
Group	Principal est un groupe de sécurité.
ServicePrincipalProfile	Le principal est un profil de principal de service.
EntireTenant	Le principal représente tous les utilisateurs du locataire.

ServicePrincipalDetails

Objet

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.

Nom	Type	Description
aadAppId	string (uuid)	Microsoft EntraId du principal de service.

ServicePrincipalProfileDetails

Objet

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.

Nom	Type	Description
parentPrincipal	Principal	Principal parent du profil de principal de service.

UserDetails

Objet

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

Nom	Type	Description
userPrincipalName	string	Nom d’utilisateur principal.

Partager via

Items - Get Item

Permissions

Étendues déléguées requises

Limitations

Identités prises en charge par Microsoft Entra

Interface

Paramètres URI

Réponses

Exemples

Get item details by ID and type example

Exemple de requête

Exemple de réponse

Get item details by ID example

Exemple de requête

Exemple de réponse

Définitions

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Item

ItemState

ItemTag

ItemType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails