Items - Create GraphQLApi

Tjänst:: GraphQLApi

API-version:: v1

Skapar ett API för GraphQL-objekt på den angivna arbetsytan.

Det här API:et stöder tidskrävande åtgärder (LRO).

Information om hur du skapar GraphQLApi-objekt med en offentlig definition finns i GraphQLApi-definitionen.

Behörigheter

Anroparen måste ha rollen deltagare i arbetsytan.

Obligatoriska delegerade omfång

GraphQLApi.ReadWrite.All eller Item.ReadWrite.All

Begränsningar

Om du vill skapa en GraphQLApi måste arbetsytan finnas på en infrastrukturkapacitet som stöds. Mer information finns i: Microsoft Fabric-licenstyper.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identitet	Stöd
Användare	Ja
Tjänstens huvudnamn och hanterade identiteter	Ja

Gränssnitt

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
workspaceId	path	True	string (uuid)	Arbetsytans ID.

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string	API:et för GraphQL-visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
definition		GraphQLApiPublicDefinition	API:et för den offentliga definitionen för GraphQL.
description		string	Beskrivning av API:et för GraphQL. Maximal längd är 256 tecken.
folderId		string (uuid)	Mapp-ID:t. Om det inte anges eller är null skapas API:et för GraphQL med arbetsytan som mapp.

Svar

Name	Typ	Description
201 Created	GraphQLApi	Har skapats
202 Accepted		Begäran accepterad, GraphQLApi-etablering pågår. Sidhuvuden Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanliga felkoder: InvalidItemType – Objekttypen är ogiltig ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan. CorruptedPayload – den angivna nyttolasten är skadad. WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Name

Typ

Description

201 Created

GraphQLApi

Har skapats

202 Accepted

Begäran accepterad, GraphQLApi-etablering pågår.

Sidhuvuden

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

Other Status Codes

ErrorResponse

Vanliga felkoder:

InvalidItemType – Objekttypen är ogiltig
ItemDisplayNameAlreadyInUse – Objektets visningsnamn används redan.
CorruptedPayload – den angivna nyttolasten är skadad.
WorkspaceItemsLimitExceeded – Gränsen för arbetsyteobjekt har överskridits.

Exempel

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Exempelbegäran

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

Exempelsvar

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

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

Exempelbegäran

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

Exempelsvar

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

Statuskod:: 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	Description
CreateGraphQLApiRequest	Skapa NYTTOlast för API för GraphQL-begäran.
ErrorRelatedResource	Det felrelaterade resursinformationsobjektet.
ErrorResponse	Felsvaret.
ErrorResponseDetails	Information om felsvar.
GraphQLApi	Ett API för GraphQL-objekt.
GraphQLApiPublicDefinition	API för det offentliga definitionsobjektet GraphQL. Information om hur du skapar definitionen finns i GraphQLApi-definition.
GraphQLApiPublicDefinitionPart	API för GraphQL-definitionsdelsobjekt.
ItemTag	Representerar en tagg som tillämpas på ett objekt.
ItemType	Typ av objekt. Ytterligare objekttyper kan läggas till över tid.
PayloadType	Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

CreateGraphQLApiRequest

Objekt

Skapa NYTTOlast för API för GraphQL-begäran.

Name	Typ	Description
definition	GraphQLApiPublicDefinition	API:et för den offentliga definitionen för GraphQL.
description	string	Beskrivning av API:et för GraphQL. Maximal längd är 256 tecken.
displayName	string	API:et för GraphQL-visningsnamn. Visningsnamnet måste följa namngivningsreglerna efter objekttyp.
folderId	string (uuid)	Mapp-ID:t. Om det inte anges eller är null skapas API:et för GraphQL med arbetsytan som mapp.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name	Typ	Description
resourceId	string	Det resurs-ID som ingår i felet.
resourceType	string	Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
moreDetails	ErrorResponseDetails[]	Lista över ytterligare felinformation.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.
requestId	string	ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name	Typ	Description
errorCode	string	En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message	string	En mänsklig läsbar representation av felet.
relatedResource	ErrorRelatedResource	Felrelaterad resursinformation.

GraphQLApi

Objekt

Ett API för GraphQL-objekt.

Name	Typ	Description
description	string	Objektbeskrivningen.
displayName	string	Objektets visningsnamn.
folderId	string (uuid)	Mapp-ID:t.
id	string (uuid)	Objekt-ID:t.
tags	ItemTag[]	Lista över tillämpade taggar.
type	ItemType	Objekttypen.
workspaceId	string (uuid)	Arbetsytans ID.

GraphQLApiPublicDefinition

Objekt

API för det offentliga definitionsobjektet GraphQL. Information om hur du skapar definitionen finns i GraphQLApi-definition.

Name	Typ	Description
format	string	Formatet för objektdefinitionen.
parts	GraphQLApiPublicDefinitionPart[]	En lista över definitionsdelar.

GraphQLApiPublicDefinitionPart

Objekt

API för GraphQL-definitionsdelsobjekt.

Name	Typ	Description
path	string	API:et för GraphQL-definitionsdelens sökväg.
payload	string	Nyttolasten api för GraphQL-definition.
payloadType	PayloadType	Nyttolasttypen.

ItemTag

Objekt

Representerar en tagg som tillämpas på ett objekt.

Name	Typ	Description
displayName	string	Namnet på taggen.
id	string (uuid)	Tagg-ID:t.

ItemType

Uppräkning

Typ av objekt. Ytterligare objekttyper kan läggas till över tid.

Värde	Description
Dashboard	PowerBI-instrumentpanel.
Report	PowerBI-rapport.
SemanticModel	PowerBI-semantisk modell.
PaginatedReport	Sidnumrerad PowerBI-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Ett sjöhus.
Eventhouse	Ett eventhouse.
Environment	En miljö.
KQLDatabase	En KQL-databas.
KQLQueryset	En KQL-frågeuppsättning.
KQLDashboard	En KQL-instrumentpanel.
DataPipeline	En datapipeline.
Notebook	En notebook-fil.
SparkJobDefinition	En definition för Spark-jobb.
MLExperiment	Ett maskininlärningsexperiment.
MLModel	En maskininlärningsmodell.
Warehouse	Ett lager.
Eventstream	En händelseström.
SQLEndpoint	En SQL-slutpunkt.
MirroredWarehouse	Ett speglat lager.
MirroredDatabase	En speglad databas.
Reflex	En reflex.
GraphQLApi	Ett API för GraphQL-objekt.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	Ett kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	Ett dataflöde.
ApacheAirflowJob	Ett ApacheAirflowJob.
WarehouseSnapshot	En ögonblicksbild av lagret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ett Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	En speglad azure databricks-katalog.
Map	En karta.
AnomalyDetector	En avvikelseidentifiering.
UserDataFunction	En användardatafunktion.
GraphModel	En GraphModel.
GraphQuerySet	En Graph QuerySet.
SnowflakeDatabase	En Snowflake-databas för att lagra isbergstabeller som skapats från Snowflake-kontot.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-databas.

PayloadType

Uppräkning

Typ av definitionsdelens nyttolast. Ytterligare nyttolasttyper kan läggas till över tid.

Värde	Description
InlineBase64	Infogad bas 64.

Dela via

Items - Create GraphQLApi

Behörigheter

Obligatoriska delegerade omfång

Begränsningar

Identiteter som stöds av Microsoft Entra

Gränssnitt

URI-parametrar

Begärandetext

Svar

Exempel

Create a API for GraphQL example

Exempelbegäran

Exempelsvar

Create a GraphQLApi with public definition example

Exempelbegäran

Exempelsvar

Definitioner

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType