Items - Create GraphQLApi

Service:: GraphQLApi

Version de l’API:: v1

Crée une API pour l’élément GraphQL dans l’espace de travail spécifié.

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

Pour créer un élément GraphQLApi avec une définition publique, reportez-vous à la définition GraphQLApi.

Autorisations

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

Étendues déléguées requises

GraphQLApi.ReadWrite.All ou Item.ReadWrite.All

Limites

Pour créer un GraphQLApi, l’espace de travail doit se trouver sur une capacité Fabric prise en charge. Pour plus d’informations, consultez : types de licences Microsoft Fabric.

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	Oui

Interface

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

Paramètres d’URI

Nom	Dans	Obligatoire	Type	Description
workspaceId	path	True	string (uuid)	ID de l’espace de travail.

Corps de la requête

Nom	Obligatoire	Type	Description
displayName	True	string	L’API pour le nom complet GraphQL. Le nom complet doit suivre les règles d’affectation de noms en fonction du type d’élément.
definition		GraphQLApiPublicDefinition	L’API pour la définition publique GraphQL.
description		string	Description de l’API pour GraphQL. La longueur maximale est de 256 caractères.
folderId		string (uuid)	ID du dossier. Si elle n’est pas spécifiée ou null, l’API pour GraphQL est créée avec l’espace de travail en tant que dossier.

Réponses

Nom	Type	Description
201 Created	GraphQLApi	Création réussie
202 Accepted		Demande acceptée, approvisionnement GraphQLApi 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. WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Nom

Type

Description

201 Created

GraphQLApi

Création réussie

202 Accepted

Demande acceptée, approvisionnement GraphQLApi 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.
WorkspaceItemsLimitExceededed : limite d’élément d’espace de travail dépassée.

Exemples

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Demande d’échantillon

HTTP

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

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description."
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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 a GraphQLApi with public definition example

Demande d’échantillon

HTTP

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

{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "definition": {
    "format": "GraphQLApiV1",
    "parts": [
      {
        "path": "graphql-definition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 201

{
  "displayName": "GraphQLApi 1",
  "description": "An API for GraphQL item description.",
  "type": "GraphQLApi",
  "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
CreateGraphQLApiRequest	Créez une API pour la charge utile de requête GraphQL.
ErrorRelatedResource	Objet de détails de ressource associé à l’erreur.
ErrorResponse	Réponse d’erreur.
ErrorResponseDetails	Détails de la réponse d’erreur.
GraphQLApi	API pour l’élément GraphQL.
GraphQLApiPublicDefinition	API pour l’objet de définition publique GraphQL. Pour créer la définition, consultez la définition GraphQLApi.
GraphQLApiPublicDefinitionPart	API pour l’objet de composant de définition GraphQL.
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.

CreateGraphQLApiRequest

Objet

Créez une API pour la charge utile de requête GraphQL.

Nom	Type	Description
definition	GraphQLApiPublicDefinition	L’API pour la définition publique GraphQL.
description	string	Description de l’API pour GraphQL. La longueur maximale est de 256 caractères.
displayName	string	L’API pour le nom complet GraphQL. 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. Si elle n’est pas spécifiée ou null, l’API pour GraphQL est créée avec l’espace de travail en tant que dossier.

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.

GraphQLApi

Objet

API pour l’élément GraphQL.

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.

GraphQLApiPublicDefinition

Objet

API pour l’objet de définition publique GraphQL. Pour créer la définition, consultez la définition GraphQLApi.

Nom	Type	Description
format	string	Format de la définition d’élément.
parts	GraphQLApiPublicDefinitionPart[]	Liste des parties de définition.

GraphQLApiPublicDefinitionPart

Objet

API pour l’objet de composant de définition GraphQL.

Nom	Type	Description
path	string	Chemin d’accès du composant de définition GraphQL à l’API.
payload	string	Charge utile de la partie de définition GraphQL de l’API.
payloadType	PayloadType	Type de charge utile.

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.

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.

Partager via

Items - Create GraphQLApi

Autorisations

Étendues déléguées requises

Limites

Identités prises en charge par Microsoft Entra

Interface

Paramètres d’URI

Corps de la requête

Réponses

Exemples

Create a API for GraphQL example

Demande d’échantillon

Exemple de réponse

Create a GraphQLApi with public definition example

Demande d’échantillon

Exemple de réponse

Définitions

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType