Items - Create Graph Model

Service:
GraphModel
Version d'API:
v1

Crée un GraphModel dans l’espace de travail spécifié.

Note

L’élément GraphModel est actuellement en préversion (en savoir plus).

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

Pour créer GraphModel avec une définition publique, reportez-vous à l’article GraphModel .

Permissions

L’appelant doit avoir un rôle d’espace de travail contributeur .

Étendues déléguées requises

Item.ReadWrite.All

Limites

  • Pour créer un GraphModel, l’espace de travail doit se trouver sur une capacité de Fabric prise en charge. 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é Support
Utilisateur Oui
Service principal et identités gérées Oui

Interface

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

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Obligatoire Type Description
displayName True

string

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

GraphModelPublicDefinition

Définition publique graphModel.
description

string

Description de GraphModel. La longueur maximale est de 256 caractères.
folderId

string (uuid)

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

SensitivityLabelSettings

Paramètres d’étiquette de confidentialité pour GraphModel.

Réponses

Nom Type Description
201 Created

GraphModel

Création réussie
202 Accepted

Demande acceptée, provisionnement GraphModel 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 :

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

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

Exemples

Create a GraphModel example
Create a GraphModel with public definition example

Create a GraphModel example

Exemple de requête

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

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description."
}

Exemple de réponse

Code d’état:
201 
{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "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 GraphModel with public definition example

Exemple de requête

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

{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exemple de réponse

Code d’état:
201 
{
  "displayName": "GraphModel 1",
  "description": "A GraphModel description.",
  "type": "GraphModel",
  "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

Définitions

Nom Description
CreateGraphModelRequest

Créez une charge utile de requête GraphModel.
EntireTenantPrincipal

Représente un principal de locataire
ErrorRelatedResource

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

Réponse d’erreur.
ErrorResponseDetails

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

Objet GraphModel.
GraphModelDefinitionFormat

Format de la définition du modèle de graphe. Des types format supplémentaires peuvent être ajoutés au fil du temps.
GraphModelPublicDefinition

Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .
GraphModelPublicDefinitionPart

Objet de partie de définition GraphModel.
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.
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.

CreateGraphModelRequest

Objet

Créez une charge utile de requête GraphModel.

Nom Type Description
definition

GraphModelPublicDefinition

Définition publique graphModel.
description

string

Description de GraphModel. La longueur maximale est de 256 caractères.
displayName

string

Nom complet graphModel. 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, GraphModel est créé avec l’espace de travail en tant que dossier.
sensitivityLabelSettings

SensitivityLabelSettings

Paramètres d’étiquette de confidentialité pour GraphModel.

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.

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 (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.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GraphModel

Objet

Objet GraphModel.

Nom Type Description
defaultIdentity Principal:

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

Identifiant de l’espace de travail.

GraphModelDefinitionFormat

Énumération

Format de la définition du modèle de graphe. Des types format supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
json

Format JSON pour la définition publique GraphModel, spécifiquement conçu pour prendre en charge les scénarios CI/CD dans Fabric.

GraphModelPublicDefinition

Objet

Objet de définition publique GraphModel. Pour plus d’informations sur la structure de la définition GraphModel, consultez cet article .

Nom Type Description
format

GraphModelDefinitionFormat

Format de la définition du modèle de graphe. Des types format supplémentaires peuvent être ajoutés au fil du temps.
parts

GraphModelPublicDefinitionPart[]

Liste des parties de définition.

GraphModelPublicDefinitionPart

Objet

Objet de partie de définition GraphModel.

Nom Type Description
path

string

Chemin du composant de définition publique GraphModel.
payload

string

Charge utile du composant de définition publique GraphModel.
payloadType

PayloadType

Type de charge utile.

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

A DataAgent.
MirroredCatalog

A MirroredCatalog.

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.

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:

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.