Partager via

Items - Create Item

  • Référence
Service:
Core
Version d'API:
v1

Crée un élément dans l’espace de travail spécifié.
Cette API est prise en charge pour un certain nombre de types d’éléments, recherchez les types d’éléments pris en charge dans vue d’ensemble de la gestion des éléments. Vous pouvez utiliser 'API Obtenir une définition d’élément pour obtenir une définition d’élément.

Cette API prend en charge opérations longues (LRO).

Autorisations

L’appelant doit avoir rôle de contributeur ou supérieur.

Étendues déléguées requises

Pour les API d’élément, utilisez ces types d’étendue :

  • Étendue générique : Item.ReadWrite.All
  • Étendue spécifique : itemType. ReadWrite.All (par exemple : Notebook.ReadWrite.All)

pour plus d’informations sur les étendues, consultez article sur les étendues.

Limitations

  • Pour créer un élément non PowerBI Fabric, l’espace de travail doit se trouver sur une capacité Fabric prise en charge. Pour plus d’informations, consultez types de licences Microsoft Fabric.
  • Pour créer un élément PowerBI, l’utilisateur doit disposer de la licence appropriée. Pour plus d’informations, consultez types de licences Microsoft Fabric.
  • Lors de la création d’un élément, utilisez creationPayload ou definition, mais n’utilisez pas les deux en même temps.

Identités prises en charge par Microsoft Entra

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

Identité Soutien
Utilisateur Oui
principal de service et identités managées Lorsque le type d’élément dans l’appel est pris en charge. Vérifiez l’API correspondante pour le type d’élément que vous appelez pour voir si votre appel est pris en charge. Par exemple, les modèles sémantiques sont pris en charge.

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/items

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string

uuid

ID de l’espace de travail.

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

Nom complet de l’élément. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
type True

ItemType

Type d’élément.
creationPayload

object

Ensemble de propriétés utilisées pour créer l’élément. La page Créer un élément du type approprié indique si creationPayload est pris en charge et répertorie les propriétés de l’élément. Utilisez creationPayload ou definition. Vous ne pouvez pas utiliser les deux en même temps.
definition

ItemDefinition

Définition de l’élément. La page Créer un élément du type approprié indique si la définition est prise en charge et détaille sa structure. Utilisez definition ou creationPayload. Vous ne pouvez pas utiliser les deux en même temps.
description

string

Description de l’élément. La longueur maximale est de 256 caractères.

Réponses

Nom Type Description
201 Created

Item

Création réussie
202 Accepted

Demande acceptée, approvisionnement d’éléments en cours

En-têtes

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • InvalidItemType : le type d’élément n’est pas valide.

  • ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé.

  • CorruptedPayload - La charge utile fournie est endommagée

Exemples

Create an item example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/items

{
  "displayName": "Item 1",
  "type": "Lakehouse"
}

Exemple de réponse

Code d’état:
201 
{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
Code d’état:
202 
Location: https://api.fabric.microsoft.com/v1/operations/0acd697c-1550-43cd-b998-91bfbfbd47c6
x-ms-operation-id: 0acd697c-1550-43cd-b998-91bfbfbd47c6
Retry-After: 30

Définitions

Nom Description
CreateItemRequest

Créez une charge utile de demande d’élément.
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Objet d’élément.
ItemDefinition

Objet de définition d’élément.
ItemDefinitionPart

Objet de partie définition d’élément.
ItemType

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

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

CreateItemRequest

Object

Créez une charge utile de demande d’élément.

Nom Type Description
creationPayload

object

Ensemble de propriétés utilisées pour créer l’élément. La page Créer un élément du type approprié indique si creationPayload est pris en charge et répertorie les propriétés de l’élément. Utilisez creationPayload ou definition. Vous ne pouvez pas utiliser les deux en même temps.
definition

ItemDefinition

Définition de l’élément. La page Créer un élément du type approprié indique si la définition est prise en charge et détaille sa structure. Utilisez definition ou creationPayload. Vous ne pouvez pas utiliser les deux en même temps.
description

string

Description de l’élément. La longueur maximale est de 256 caractères.
displayName

string

Nom complet de l’élément. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
type

ItemType

Type d’élément.

ErrorRelatedResource

Object

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

Object

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

Object

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.

Item

Object

Objet d’élément.

Nom Type Description
description

string

Description de l’élément.
displayName

string

Nom complet de l’élément.
id

string

uuid

ID d’élément.
type

ItemType

Type d’élément.
workspaceId

string

uuid

ID de l’espace de travail.

ItemDefinition

Object

Objet de définition d’élément.

Nom Type Description
format

string

Format de la définition d’élément.
parts

ItemDefinitionPart[]

Liste des parties de définition.

ItemDefinitionPart

Object

Objet de partie définition d’élément.

Nom Type Description
path

string

Chemin d’accès de la partie élément.
payload

string

Charge utile de la partie élément.
payloadType

PayloadType

Type de charge utile.

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

Un pipeline de données.
Datamart

Datamart PowerBI.
Environment

Environnement.
Eventhouse

Un eventhouse.
Eventstream

Flux d’événements.
GraphQLApi

API pour l’élément GraphQL.
KQLDashboard

Tableau de bord KQL.
KQLDatabase

Base de données KQL.
KQLQueryset

Ensemble de requêtes KQL.
Lakehouse

Un lac.
MLExperiment

Une expérience de Machine Learning.
MLModel

Modèle Machine Learning.
MirroredDatabase

Une base de données mise en miroir.
MirroredWarehouse

Un entrepôt mis en miroir.
MountedDataFactory

Un MountedDataFactory.
Notebook

Un bloc-notes.
PaginatedReport

Rapport paginé PowerBI.
Reflex

Un réflexe.
Report

Rapport PowerBI.
SQLDatabase

A SQLDatabase.
SQLEndpoint

Point de terminaison SQL.
SemanticModel

Modèle sémantique PowerBI.
SparkJobDefinition

Définition d’un travail Spark.
Warehouse

Un entrepôt.

PayloadType

Énumération

Type de la charge utile du composant de définition. Des types de charge utile supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
InlineBase64

Base 64 inline.