Items - Create Semantic Model

Service:: SemanticModel

Version d’API:: v1

Crée un modèle sémantique dans l’espace de travail spécifié.
Cette API prend en charge opérations longues (LRO).

L’API prend en charge trois modes de création : (1) fournir un definition contrôle total sur la structure du modèle, (2) fournir une creationPayload URL de table OneLake pour créer un modèle DirectLake ou (3) omettre les deux pour créer un modèle sémantique vide. Utilisez definition ou creationPayload. Vous ne pouvez pas utiliser les deux en même temps.

Autorisations

L’appelant doit avoir un rôle d’espace de travail contributeur . Lors de la création d’un modèle DirectLake avec une creationPayload référence à des tables OneLake, l’appelant doit également avoir accès à chaque élément source source ou élément de données référencé, notamment lorsque ces sources résident dans un autre espace de travail (sources inter-espaces de travail).

Étendues déléguées requises

SemanticModel.ReadWrite.All ou Item.ReadWrite.All

Limites

Pour créer un modèle sémantique, l’utilisateur doit disposer de la licence appropriée. Pour plus d’informations, consultez : Microsoft Fabric types de licences.

Microsoft Entra identités prises en charge

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

Identité	Soutien
Utilisateur	Oui
Service principal et identités gérées	Oui

Interface

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

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 d’affichage du modèle sémantique. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
creationPayload		SemanticModelCreationPayload	Charge utile de création d’un modèle sémantique sans définition complète. Fournissez des URL de table OneLake pour créer un modèle DirectLake, ou omettre les deux `definition` et `creationPayload` créer un modèle sémantique vide. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
definition		SemanticModelDefinition	Définition publique du modèle sémantique. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
description		string	Description du modèle sémantique. La longueur maximale est de 256 caractères.
folderId		string (uuid)	ID du dossier. S’il n’est pas spécifié ou null, le modèle sémantique est créé avec l’espace de travail en tant que dossier.
sensitivityLabelSettings		SensitivityLabelSettings	Paramètres d’étiquette de confidentialité pour le modèle sémantique.

Réponses

Nom	Type	Description
201 Created	SemanticModel	Création réussie
202 Accepted		Demande acceptée, approvisionnement de modèle sémantique en cours. En-têtes Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	La limite de débit de service a été dépassée. Le serveur retourne un `Retry-After` en-tête indiquant, en secondes, combien de temps le client doit attendre avant d’envoyer des demandes supplémentaires. En-têtes Retry-After: integer
Other Status Codes	ErrorResponse	Codes d’erreur courants : ItemDisplayNameAlreadyInUse : le nom d’affichage de l’élément est déjà utilisé. CorruptedPayload : la charge utile fournie est endommagée. MutuallyExclusiveProperties : les `definitioncreationPayload` deux ne peuvent pas être fournis. InvalidOneLakeTableUrl : une ou plusieurs URL de table OneLake ne sont pas valides. DuplicateTableName : les noms de tables en double ne sont pas autorisés.

Exemples

Create a semantic model example

Create a semantic model with OneLake tables example

Create an empty semantic model example

Create a semantic model example

Exemple de requête

HTTP

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

{
  "displayName": "SemanticModel 1",
  "description": "A semantic model description.",
  "definition": {
    "parts": [
      {
        "path": "model.bim",
        "payload": "ew0KICAiY29tcGF0a..GVzIjogWyBdDQogIH0NCn0=",
        "payloadType": "InlineBase64"
      },
      {
        "path": "definition.pbism",
        "payload": "ewogICJ2ZXJzaW9uI..NldHRpbmdzIjoge30KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "SemanticModel 1",
  "description": "A semantic model description.",
  "type": "SemanticModel",
  "workspaceId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "id": "5b218778-e7a5-4d73-8187-f10824047715",
  "sensitivityLabel": {
    "id": "b7b4f4d9-3f0d-4b3e-8f3d-4f6d3f4f3f4f"
  }
}

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

Create a semantic model with OneLake tables example

Exemple de requête

HTTP

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

{
  "displayName": "Sales Analytics Model",
  "description": "A semantic model connected to lakehouse tables.",
  "creationPayload": {
    "oneLakeTables": [
      "https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/dim_customer",
      "https://onelake.dfs.fabric.microsoft.com/aaaa0000-bb11-2222-33cc-444444dddddd/cccc0000-dd11-2222-33ee-444444ffffff/Tables/sales/dim_product",
      "https://onelake.dfs.fabric.microsoft.com/1111aaaa-bb22-3333-44cc-555555eeeeee/2222bbbb-cc33-4444-55dd-666666ffffff/Tables/dim_region"
    ]
  }
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "Sales Analytics Model",
  "description": "A semantic model connected to lakehouse tables.",
  "type": "SemanticModel",
  "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

Create an empty semantic model example

Exemple de requête

HTTP

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

{
  "displayName": "SemanticModel 1",
  "description": "An empty semantic model."
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "SemanticModel 1",
  "description": "An empty semantic model.",
  "type": "SemanticModel",
  "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
CreateSemanticModelRequest	Créez une charge utile de demande de modèle sémantique.
EntireTenantPrincipal	Représente un principal de locataire
ErrorParameter	Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.
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`.
GroupPrincipal	Représente un groupe de sécurité.
GroupType	Type du groupe. Des types de groupes 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.
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.
PrincipalType	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
SemanticModel	Objet de modèle sémantique.
SemanticModelCreationPayload	Charge utile de création d’un modèle sémantique sans définition.
SemanticModelDefinition	définition publique du modèle sémantique objet. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .
SemanticModelDefinitionPart	Objet de partie de définition de modèle sémantique.
SensitivityLabel	Représente une étiquette de confidentialité appliquée à un élément.
SensitivityLabelApplyStrategy	Stratégie d’application de l’étiquette de confidentialité. La valeur par défaut est ApplyOrFail. Des types supplémentaires peuvent être ajoutés au fil du temps.
SensitivityLabelSettings	Paramètres d’étiquette de confidentialité.
ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
ServicePrincipalPrincipal	Représente un principal de service Microsoft Entra.
ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
ServicePrincipalProfilePrincipal	Représente un profil de principal de service.
UserDetails	Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est `User`.
UserPrincipal	Représente un principal d’utilisateur Microsoft Entra.

CreateSemanticModelRequest

Objet

Créez une charge utile de demande de modèle sémantique.

Nom	Type	Description
creationPayload	SemanticModelCreationPayload	Charge utile de création d’un modèle sémantique sans définition complète. Fournissez des URL de table OneLake pour créer un modèle DirectLake, ou omettre les deux `definition` et `creationPayload` créer un modèle sémantique vide. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
definition	SemanticModelDefinition	Définition publique du modèle sémantique. Utilisez `definition` ou `creationPayload`. Vous ne pouvez pas utiliser les deux en même temps.
description	string	Description du modèle sémantique. La longueur maximale est de 256 caractères.
displayName	string	Nom d’affichage du modèle sémantique. 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, le modèle sémantique est créé avec l’espace de travail en tant que dossier.
sensitivityLabelSettings	SensitivityLabelSettings	Paramètres d’étiquette de confidentialité pour le modèle sémantique.

EntireTenantPrincipal

Objet

Représente un principal de locataire

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
type	string: EntireTenant	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

ErrorParameter

Objet

Paramètre structuré fournissant un contexte lisible par l’ordinateur supplémentaire à propos d’une erreur.

Nom	Type	Description
message	string	Description lisible par l’homme de la signification du paramètre.
name	string	L’identifiant de paramètre.
value	string	Représente la valeur du paramètre.

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.
isRetriable	boolean	Lorsque la valeur est true, la requête peut être retentée. Utilisez l’en-tête `Retry-After` de réponse pour déterminer le délai, le cas échéant.
message	string	Représentation lisible humaine de l’erreur.
moreDetails	ErrorResponseDetails[]	Liste des détails d’erreur supplémentaires.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur l’erreur.
relatedResource	ErrorRelatedResource	Détails de la ressource associée à l’erreur.
requestId	string (uuid)	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.
parameters	ErrorParameter[]	Paramètres structurés fournissant un contexte lisible par l’ordinateur supplémentaire sur 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.

GroupPrincipal

Objet

Représente un groupe de sécurité.

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.
type	string: Group	Type du principal. Des types principaux 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.

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 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.
DataAgent	A DataAgent.
MirroredCatalog	A MirroredCatalog.
PolicySet	Ensemble de stratégies.
AppBackend	An AppBackend.
OrgApp	Une application d’organisation.
OrgAppAudience	Audience d’application d’organisation.
DataBuildToolJob	A DataBuildToolJob.
AzureDatabricksStorage	Élément de stockage soutenu par OneLake pour Azure Databricks.
Plan	Un plan.
Monitoring	Élément de surveillance.
DeploymentPlan	Un plan de déploiement.
ShareSubscription	Un abonnement de partage.
Share	Un partage.

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.

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

SemanticModel

Objet

Objet de modèle sémantique.

Nom	Type	Description
defaultIdentity	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Identité par défaut de l’élément.
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.
logicalId	string (uuid)	Identificateur logique de l’élément. Les instances d’élément correspondantes partagent le même ID logique. La valeur est Null lorsqu’aucun ID logique n’a été affecté.
sensitivityLabel	SensitivityLabel	Étiquette de confidentialité de l’élément.
tags	ItemTag[]	Liste des balises appliquées.
type	ItemType	Type d’élément.
workspaceId	string (uuid)	ID de l’espace de travail.

SemanticModelCreationPayload

Objet

Charge utile de création d’un modèle sémantique sans définition.

Nom	Type	Description
oneLakeTables	string[] (uri)	Liste des URL de table OneLake pour connecter le modèle sémantique à (100 maximum). Chaque URL doit suivre l’un des deux formats suivants : `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{tableName}` pour une table dans le schéma par défaut `dbo` ou `https://onelake.dfs.fabric.microsoft.com/{workspaceId}/{dataItemId}/Tables/{schemaName}/{tableName}` pour une table dans un schéma personnalisé explicite. Les URL peuvent référencer différents espaces de travail et éléments de données, et une seule requête peut combiner des URL de schéma par défaut et de schéma personnalisé. Le système déduit les noms de tables et les colonnes de la source OneLake.

SemanticModelDefinition

Objet

définition publique du modèle sémantique objet. Pour plus d’informations sur la structure de la définition du modèle sémantique, consultez cet article .

Nom	Type	Description
format	string	Format de la définition du modèle sémantique.
parts	SemanticModelDefinitionPart[]	Liste des parties de définition.

SemanticModelDefinitionPart

Objet

Objet de partie de définition de modèle sémantique.

Nom	Type	Description
path	string	Chemin de la partie du modèle sémantique.
payload	string	Charge utile de la partie du modèle sémantique.
payloadType	PayloadType	Type de charge utile.

SensitivityLabel

Objet

Représente une étiquette de confidentialité appliquée à un élément.

Nom	Type	Description
id	string (uuid)	ID d’étiquette de confidentialité.

SensitivityLabelApplyStrategy

Énumération

Stratégie d’application de l’étiquette de confidentialité. La valeur par défaut est ApplyOrFail. Des types supplémentaires peuvent être ajoutés au fil du temps.

Valeur	Description
ApplyOrFail	Appliquez l’étiquette de confidentialité ou échouez l’opération si elle ne peut pas être appliquée.
Ignore	Ignorez l’étiquette de confidentialité si elle ne peut pas être appliquée et passez à l’opération sans appliquer l’étiquette.

SensitivityLabelSettings

Objet

Paramètres d’étiquette de confidentialité.

Nom	Type	Description
labelId	string (uuid)	ID d’étiquette de confidentialité.
sensitivityLabelApplyStrategy	SensitivityLabelApplyStrategy	Stratégie d’application de l’étiquette de confidentialité.

ServicePrincipalDetails

Objet

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

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

ServicePrincipalPrincipal

Objet

Représente un principal de service Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
servicePrincipalDetails	ServicePrincipalDetails	Détails spécifiques au principal de service. Applicable lorsque le type principal est `ServicePrincipal`.
type	string: ServicePrincipal	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

ServicePrincipalProfileDetails

Objet

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

Nom	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Principal parent du profil de principal de service.

ServicePrincipalProfilePrincipal

Objet

Représente un profil de principal de service.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Détails du profil du principal de service. Applicable lorsque le type principal est `ServicePrincipalProfile`.
type	string: ServicePrincipalProfile	Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

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.

UserPrincipal

Objet

Représente un principal d’utilisateur Microsoft Entra.

Nom	Type	Description
displayName	string	Nom complet du principal.
id	string (uuid)	ID du principal.
type	string: User	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`.