Items - Create GraphQLApi

Tjeneste:: GraphQLApi

API-version:: v1

Opretter en API til GraphQL-element i det angivne arbejdsområde.

Denne API understøtter LRO-handlinger (Long Running Operations).

Hvis du vil oprette GraphQLApi-element med en offentlig definition, skal du se GraphQLApi-definition.

Tilladelser

Den, der ringer op, skal have en bidragyderarbejdsområderolle.

Påkrævede delegerede områder

GraphQLApi.ReadWrite.All eller Item.ReadWrite.All

Begrænsninger

Hvis du vil oprette en GraphQLApi, skal arbejdsområdet være på en understøttet Fabric-kapacitet. Du kan få flere oplysninger under: Microsoft Fabric-licenstyper.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Ja
tjenesteprincipal og administrerede identiteter	Ja

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbejdsområde-id'et.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
displayName	True	string	API'en for GraphQL-vist navn. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
definition		GraphQLApiPublicDefinition	API'en til den offentlige definition af GraphQL.
description		string	API'en til GraphQL-beskrivelsen. Maksimumlængden er 256 tegn.
folderId		string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes API'en til GraphQL med arbejdsområdet som mappe.

Svar

Name	Type	Beskrivelse
201 Created	GraphQLApi	Oprettet
202 Accepted		Anmodning accepteret, GraphQLApi-klargøring er i gang. Headere Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: InvalidItemType – Elementtypen er ugyldig ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede. CorruptedPayload – Den angivne nyttedata er beskadiget. WorkspaceItemsLimitExceeded – Grænsen for arbejdsområdeelement er overskredet.

Name

Type

Beskrivelse

201 Created

GraphQLApi

Oprettet

202 Accepted

Anmodning accepteret, GraphQLApi-klargøring er i gang.

Headere

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

Other Status Codes

ErrorResponse

Almindelige fejlkoder:

InvalidItemType – Elementtypen er ugyldig
ItemDisplayNameAlreadyInUse – Det viste navn på elementet bruges allerede.
CorruptedPayload – Den angivne nyttedata er beskadiget.
WorkspaceItemsLimitExceeded – Grænsen for arbejdsområdeelement er overskredet.

Eksempler

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Eksempelanmodning

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

Eksempelsvar

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

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

Eksempelanmodning

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

Eksempelsvar

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

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

Definitioner

Name	Beskrivelse
CreateGraphQLApiRequest	Opret API til nyttedata for GraphQL-anmodning.
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.
GraphQLApi	En API til GraphQL-element.
GraphQLApiPublicDefinition	API til det offentlige GraphQL-definitionsobjekt. Hvis du vil oprette definitionen, skal du se GraphQLApi-definition.
GraphQLApiPublicDefinitionPart	API til GraphQL-definitionsdelobjekt.
ItemTag	Repræsenterer et mærke, der er anvendt på et element.
ItemType	Elementets type. Der kan tilføjes flere elementtyper over tid.
PayloadType	Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

CreateGraphQLApiRequest

Objekt

Opret API til nyttedata for GraphQL-anmodning.

Name	Type	Beskrivelse
definition	GraphQLApiPublicDefinition	API'en til den offentlige definition af GraphQL.
description	string	API'en til GraphQL-beskrivelsen. Maksimumlængden er 256 tegn.
displayName	string	API'en for GraphQL-vist navn. Det viste navn skal følge navngivningsreglerne i henhold til elementtypen.
folderId	string (uuid)	Mappe-id'et. Hvis den ikke er angivet eller null, oprettes API'en til GraphQL med arbejdsområdet som mappe.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.

GraphQLApi

Objekt

En API til GraphQL-element.

Name	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Det viste elementnavn.
folderId	string (uuid)	Mappe-id'et.
id	string (uuid)	Element-id'et.
tags	ItemTag[]	Liste over anvendte mærker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbejdsområde-id'et.

GraphQLApiPublicDefinition

Objekt

API til det offentlige GraphQL-definitionsobjekt. Hvis du vil oprette definitionen, skal du se GraphQLApi-definition.

Name	Type	Beskrivelse
format	string	Formatet af elementdefinitionen.
parts	GraphQLApiPublicDefinitionPart[]	En liste over definitionsdele.

GraphQLApiPublicDefinitionPart

Objekt

API til GraphQL-definitionsdelobjekt.

Name	Type	Beskrivelse
path	string	Stien til API'en til GraphQL-definitionsdelen.
payload	string	API'en til GraphQL-definitionsdelens nyttedata.
payloadType	PayloadType	Nyttedatatypen.

ItemTag

Objekt

Repræsenterer et mærke, der er anvendt på et element.

Name	Type	Beskrivelse
displayName	string	Navnet på mærket.
id	string (uuid)	Tag-id'et.

ItemType

Optælling

Elementets type. Der kan tilføjes flere elementtyper over tid.

Værdi	Beskrivelse
Dashboard	PowerBI-dashboard.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-model.
PaginatedReport	Sideinddelt PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et søhus.
Eventhouse	Et eventhouse.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-forespørgselssæt.
KQLDashboard	Et KQL-dashboard.
DataPipeline	En datapipeline.
Notebook	En notesbog.
SparkJobDefinition	En spark jobdefinition.
MLExperiment	Et maskinel indlæringseksperiment.
MLModel	En model til maskinel indlæring.
Warehouse	Et lager.
Eventstream	En hændelsesstream.
SQLEndpoint	Et SQL-slutpunkt.
MirroredWarehouse	Et spejlvendt lager.
MirroredDatabase	En spejlet database.
Reflex	En refleks.
GraphQLApi	En API til GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Et kopijob.
VariableLibrary	En VariabelLibrary.
Dataflow	Et dataflow.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et lagersnapshot.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Et Digital Twin Builder-flow.
MirroredAzureDatabricksCatalog	Et spejlet Azure Databricks-katalog.
Map	Et kort.
AnomalyDetector	En uregelmæssighedsregistrering.
UserDataFunction	En brugerdatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	Et Graph QuerySet.
SnowflakeDatabase	En Snowflake-database til lagring af Iceberg-tabeller, der er oprettet fra Snowflake-konto.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.

PayloadType

Optælling

Typen af nyttedata for definitionsdelen. Der kan tilføjes flere nyttedatatyper over tid.

Værdi	Beskrivelse
InlineBase64	Indbygget grundlinje 64.

Del via

Items - Create GraphQLApi

Tilladelser

Påkrævede delegerede områder

Begrænsninger

Microsoft Entra-understøttede identiteter

Grænseflade

URI-parametre

Brødtekst for anmodning

Svar

Eksempler

Create a API for GraphQL example

Eksempelanmodning

Eksempelsvar

Create a GraphQLApi with public definition example

Eksempelanmodning

Eksempelsvar

Definitioner

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType