Items - Create GraphQLApi

Service:: GraphQLApi

API-versie:: v1

Hiermee maakt u een API voor GraphQL-item in de opgegeven werkruimte.

Deze API ondersteunt langlopende bewerkingen (LRO).

Als u GraphQLApi-item met een openbare definitie wilt maken, raadpleegt u de GraphQLApi-definitie.

Machtigingen

De aanroeper moet een werkruimterol inzender hebben.

Vereiste gedelegeerde bereiken

GraphQLApi.ReadWrite.All of Item.ReadWrite.All

Beperkingen

Als u een GraphQLApi wilt maken, moet de werkruimte zich in een ondersteunde infrastructuurcapaciteit bevinden. Zie voor meer informatie: Microsoft Fabric-licentietypen.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit	Steunen
Gebruiker	Ja
service-principal en beheerde identiteiten	Ja

gebruikersinterface

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

URI-parameters

Name	In	Vereist	Type	Description
workspaceId	path	True	string (uuid)	De werkruimte-id.

Aanvraagbody

Name	Vereist	Type	Description
displayName	True	string	De weergavenaam van de API voor GraphQL. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.
definition		GraphQLApiPublicDefinition	De openbare definitie van de API voor GraphQL.
description		string	De API voor GraphQL-beschrijving. De maximale lengte is 256 tekens.
folderId		string (uuid)	De map-id. Als deze niet is opgegeven of null, wordt de API voor GraphQL gemaakt met de werkruimte als map.

Antwoorden

Name	Type	Description
201 Created	GraphQLApi	Gemaakt
202 Accepted		Aanvraag geaccepteerd, GraphQLApi-inrichting wordt uitgevoerd. Kopteksten Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Veelvoorkomende foutcodes: InvalidItemType - Itemtype is ongeldig ItemDisplayNameAlreadyInUse - Weergavenaam van item wordt al gebruikt. CorruptedPayload: de opgegeven nettolading is beschadigd. WorkspaceItemsLimitExceeded - Limiet voor werkruimte-items is overschreden.

Name

Type

Description

201 Created

GraphQLApi

Gemaakt

202 Accepted

Aanvraag geaccepteerd, GraphQLApi-inrichting wordt uitgevoerd.

Kopteksten

Location: string
x-ms-operation-id: string
Retry-After: integer

Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

InvalidItemType - Itemtype is ongeldig
ItemDisplayNameAlreadyInUse - Weergavenaam van item wordt al gebruikt.
CorruptedPayload: de opgegeven nettolading is beschadigd.
WorkspaceItemsLimitExceeded - Limiet voor werkruimte-items is overschreden.

Voorbeelden

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Voorbeeldaanvraag

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."
}

Voorbeeldrespons

Statuscode:: 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"
}

Statuscode:: 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

Voorbeeldaanvraag

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"
      }
    ]
  }
}

Voorbeeldrespons

Statuscode:: 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"
}

Statuscode:: 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

Definities

Name	Description
CreateGraphQLApiRequest	Create API for GraphQL request payload.
ErrorRelatedResource	Het foutgerelateerde resourcedetailsobject.
ErrorResponse	Het foutbericht.
ErrorResponseDetails	De details van het foutbericht.
GraphQLApi	Een API voor GraphQL-item.
GraphQLApiPublicDefinition	API voor GraphQL public definition-object. Zie GraphQLApi-definitie om de definitie te maken.
GraphQLApiPublicDefinitionPart	API voor graphQL-definitieonderdeelobject.
ItemTag	Vertegenwoordigt een tag die is toegepast op een item.
ItemType	Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.
PayloadType	Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

CreateGraphQLApiRequest

Object

Create API for GraphQL request payload.

Name	Type	Description
definition	GraphQLApiPublicDefinition	De openbare definitie van de API voor GraphQL.
description	string	De API voor GraphQL-beschrijving. De maximale lengte is 256 tekens.
displayName	string	De weergavenaam van de API voor GraphQL. De weergavenaam moet de naamgevingsregels volgen op basis van het itemtype.
folderId	string (uuid)	De map-id. Als deze niet is opgegeven of null, wordt de API voor GraphQL gemaakt met de werkruimte als map.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name	Type	Description
resourceId	string	De resource-id die betrokken is bij de fout.
resourceType	string	Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
moreDetails	ErrorResponseDetails[]	Lijst met aanvullende foutdetails.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.
requestId	string	Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name	Type	Description
errorCode	string	Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message	string	Een leesbare weergave van de fout.
relatedResource	ErrorRelatedResource	De foutgerelateerde resourcedetails.

GraphQLApi

Object

Een API voor GraphQL-item.

Name	Type	Description
description	string	De beschrijving van het item.
displayName	string	De weergavenaam van het item.
folderId	string (uuid)	De map-id.
id	string (uuid)	De item-id.
tags	ItemTag[]	Lijst met toegepaste tags.
type	ItemType	Het itemtype.
workspaceId	string (uuid)	De werkruimte-id.

GraphQLApiPublicDefinition

Object

API voor GraphQL public definition-object. Zie GraphQLApi-definitie om de definitie te maken.

Name	Type	Description
format	string	De indeling van de itemdefinitie.
parts	GraphQLApiPublicDefinitionPart[]	Een lijst met definitieonderdelen.

GraphQLApiPublicDefinitionPart

Object

API voor graphQL-definitieonderdeelobject.

Name	Type	Description
path	string	Het pad naar het definitieonderdeel API voor GraphQL.
payload	string	De nettolading van het definitieonderdeel API voor GraphQL.
payloadType	PayloadType	Het nettoladingstype.

ItemTag

Object

Vertegenwoordigt een tag die is toegepast op een item.

Name	Type	Description
displayName	string	De naam van de tag.
id	string (uuid)	De tag-id.

ItemType

Opsomming

Het type item. Er kunnen in de loop van de tijd extra itemtypen worden toegevoegd.

Waarde	Description
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisch Power BI-model.
PaginatedReport	Gepagineerd Power BI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Een lakehouse.
Eventhouse	Een eventhouse.
Environment	Een omgeving.
KQLDatabase	Een KQL-database.
KQLQueryset	Een KQL-queryset.
KQLDashboard	Een KQL-dashboard.
DataPipeline	Een gegevenspijplijn.
Notebook	Een notitieblok.
SparkJobDefinition	Een Spark-taakdefinitie.
MLExperiment	Een machine learning-experiment.
MLModel	Een machine learning-model.
Warehouse	Een magazijn.
Eventstream	Een eventstream.
SQLEndpoint	Een SQL-eindpunt.
MirroredWarehouse	Een gespiegeld magazijn.
MirroredDatabase	Een gespiegelde database.
Reflex	Een reflex.
GraphQLApi	Een API voor GraphQL-item.
MountedDataFactory	Een MountedDataFactory.
SQLDatabase	Een SQLDatabase.
CopyJob	Een kopieertaak.
VariableLibrary	Een VariableLibrary.
Dataflow	Een gegevensstroom.
ApacheAirflowJob	Een ApacheAirflowJob.
WarehouseSnapshot	Een momentopname van een magazijn.
DigitalTwinBuilder	Een DigitalTwinBuilder.
DigitalTwinBuilderFlow	Een Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Een gespiegelde Azure Databricks-catalogus.
Map	Een kaart.
AnomalyDetector	Een Anomaly Detector.
UserDataFunction	Een gebruikersgegevensfunctie.
GraphModel	Een GraphModel.
GraphQuerySet	Een Graph QuerySet.
SnowflakeDatabase	Een Snowflake-database voor het opslaan van Iceberg-tabellen die zijn gemaakt op basis van het Snowflake-account.
OperationsAgent	Een OperationsAgent.
CosmosDBDatabase	Een Cosmos DB-database.

PayloadType

Opsomming

Het type nettolading van het definitieonderdeel. Er kunnen in de loop van de tijd extra typen nettoladingen worden toegevoegd.

Waarde	Description
InlineBase64	Inline base 64.

Delen via

Items - Create GraphQLApi

Machtigingen

Vereiste gedelegeerde bereiken

Beperkingen

Door Microsoft Entra ondersteunde identiteiten

gebruikersinterface

URI-parameters

Aanvraagbody

Antwoorden

Voorbeelden

Create a API for GraphQL example

Voorbeeldaanvraag

Voorbeeldrespons

Create a GraphQLApi with public definition example

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType