Partager via


Items - Create Item

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 un rôle d’espace de travail contributeur .

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

Limites

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

folderId

string (uuid)

ID du dossier. S’il n’est pas spécifié ou null, l’élément est créé avec l’espace de travail en tant que dossier.

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.

  • FolderNotFound - Impossible de trouver le dossier demandé.

  • WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Exemples

Create an item example
Create an item in folder example

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

{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715"
}
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

Create an item in folder example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb/items

{
  "displayName": "Item 1",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc"
}

Exemple de réponse

{
  "displayName": "Item 1",
  "description": "",
  "type": "Lakehouse",
  "folderId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
  "workspaceId": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
  "id": "cccccccc-2222-3333-4444-dddddddddddd"
}
Location: https://api.fabric.microsoft.com/v1/operations/0000aaaa-11bb-cccc-dd22-eeeeee333333
x-ms-operation-id: 0000aaaa-11bb-cccc-dd22-eeeeee333333
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.

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.

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

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.

folderId

string (uuid)

ID du dossier. S’il n’est pas spécifié ou null, l’élément est créé avec l’espace de travail en tant que dossier.

type

ItemType

Type d’élément.

ErrorRelatedResource

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

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

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

Objet d’élément.

Nom Type Description
description

string

Description de l’élément.

displayName

string

Nom complet de l’élément.

folderId

string (uuid)

ID du dossier.

id

string (uuid)

ID d’élément.

tags

ItemTag[]

Liste des balises appliquées.

type

ItemType

Type d’élément.

workspaceId

string (uuid)

ID de l’espace de travail.

ItemDefinition

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

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.

ItemTag

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

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 bloc-notes.

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.

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.

Valeur Description
InlineBase64

Base 64 inline.