Items - Create GraphQLApi

Szolgáltatás:: GraphQLApi

API-verzió:: v1

Létrehoz egy API-t a GraphQL-elemhez a megadott munkaterületen.

Ez az API támogatja hosszú ideig futó műveleteket (LRO).

A GraphQLApi-elem nyilvános definícióval való létrehozásához tekintse meg a GraphQLApi definícióját.

Engedélyek

A hívónak közreműködői munkaterületi szerepkörrel kell rendelkeznie.

Kötelező delegált hatókörök

GraphQLApi.ReadWrite.All vagy Item.ReadWrite.All

Korlátozások

GraphQLApi létrehozásához a munkaterületnek támogatott hálókapacitáson kell lennie. További információ: Microsoft Fabric-licenctípusok.

Microsoft Entra által támogatott identitások

Ez az API támogatja az ebben a szakaszban felsorolt Microsoft identitásokat.

Azonosság	Támogat
Felhasználó	Igen
szolgáltatásnév és felügyelt identitások	Igen

Interfész

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
workspaceId	path	True	string (uuid)	A munkaterület azonosítója.

Kérelem törzse

Name	Kötelező	Típus	Description
displayName	True	string	A GraphQL API megjelenítendő neve. A megjelenítendő névnek az elemtípusnak megfelelő elnevezési szabályokat kell követnie.
definition		GraphQLApiPublicDefinition	A GraphQL nyilvános definíciójának API-ja.
description		string	A GraphQL API leírása. A maximális hossz 256 karakter.
folderId		string (uuid)	A mappa azonosítója. Ha nincs megadva vagy null, a GraphQL API a munkaterülettel jön létre mappaként.

Válaszok

Name	Típus	Description
201 Created	GraphQLApi	Sikeresen létrehozva
202 Accepted		A kérelem elfogadva, a GraphQLApi kiépítése folyamatban van. Fejlécek Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Gyakori hibakódok: InvalidItemType – Az elem típusa érvénytelen ItemDisplayNameAlreadyInUse – Az elem megjelenítendő neve már használatban van. CorruptedPayload – A megadott hasznos adatok sérültek. WorkspaceItemsLimitExceeded – A munkaterület elemkorlátja túllépve.

Name

Típus

Description

201 Created

GraphQLApi

Sikeresen létrehozva

202 Accepted

A kérelem elfogadva, a GraphQLApi kiépítése folyamatban van.

Fejlécek

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

Other Status Codes

ErrorResponse

Gyakori hibakódok:

InvalidItemType – Az elem típusa érvénytelen
ItemDisplayNameAlreadyInUse – Az elem megjelenítendő neve már használatban van.
CorruptedPayload – A megadott hasznos adatok sérültek.
WorkspaceItemsLimitExceeded – A munkaterület elemkorlátja túllépve.

Példák

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Állapotkód:: 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

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
}

Állapotkód:: 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

Definíciók

Name	Description
CreateGraphQLApiRequest	Api létrehozása a GraphQL-kérelmek hasznos adataihoz.
ErrorRelatedResource	A hibával kapcsolatos erőforrás-részletek objektum.
ErrorResponse	A hibaválasz.
ErrorResponseDetails	A hibaválasz részletei.
GraphQLApi	Api a GraphQL-elemhez.
GraphQLApiPublicDefinition	API a GraphQL nyilvános definíciós objektumához. A definíció létrehozásához lásd a GraphQLApi definícióját.
GraphQLApiPublicDefinitionPart	API a GraphQL-definíció részobjektumához.
ItemTag	Egy elemre alkalmazott címkét jelöl.
ItemType	Az elem típusa. Idővel további elemtípusok is hozzáadhatók.
PayloadType	A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.

CreateGraphQLApiRequest

Tárgy

Api létrehozása a GraphQL-kérelmek hasznos adataihoz.

Name	Típus	Description
definition	GraphQLApiPublicDefinition	A GraphQL nyilvános definíciójának API-ja.
description	string	A GraphQL API leírása. A maximális hossz 256 karakter.
displayName	string	A GraphQL API megjelenítendő neve. A megjelenítendő névnek az elemtípusnak megfelelő elnevezési szabályokat kell követnie.
folderId	string (uuid)	A mappa azonosítója. Ha nincs megadva vagy null, a GraphQL API a munkaterülettel jön létre mappaként.

ErrorRelatedResource

Tárgy

A hibával kapcsolatos erőforrás-részletek objektum.

Name	Típus	Description
resourceId	string	A hibában érintett erőforrás-azonosító.
resourceType	string	A hibában érintett erőforrás típusa.

ErrorResponse

Tárgy

A hibaválasz.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
moreDetails	ErrorResponseDetails[]	További hibaadatok listája.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.
requestId	string	A hibához társított kérés azonosítója.

ErrorResponseDetails

Tárgy

A hibaválasz részletei.

Name	Típus	Description
errorCode	string	Egy adott azonosító, amely információt nyújt egy hibafeltételről, amely lehetővé teszi a szolgáltatás és a felhasználók közötti szabványosított kommunikációt.
message	string	A hiba emberi olvasható ábrázolása.
relatedResource	ErrorRelatedResource	A hibával kapcsolatos erőforrásadatok.

GraphQLApi

Tárgy

Api a GraphQL-elemhez.

Name	Típus	Description
description	string	Az elem leírása.
displayName	string	Az elem megjelenítendő neve.
folderId	string (uuid)	A mappa azonosítója.
id	string (uuid)	Az elem azonosítója.
tags	ItemTag[]	Az alkalmazott címkék listája.
type	ItemType	Az elem típusa.
workspaceId	string (uuid)	A munkaterület azonosítója.

GraphQLApiPublicDefinition

Tárgy

API a GraphQL nyilvános definíciós objektumához. A definíció létrehozásához lásd a GraphQLApi definícióját.

Name	Típus	Description
format	string	Az elemdefiníció formátuma.
parts	GraphQLApiPublicDefinitionPart[]	Definíciórészek listája.

GraphQLApiPublicDefinitionPart

Tárgy

API a GraphQL-definíció részobjektumához.

Name	Típus	Description
path	string	Az API for GraphQL definíciós rész elérési útja.
payload	string	A GraphQL-definícióhoz készült API hasznos adat.
payloadType	PayloadType	A hasznos adat típusa.

ItemTag

Tárgy

Egy elemre alkalmazott címkét jelöl.

Name	Típus	Description
displayName	string	A címke neve.
id	string (uuid)	A címke azonosítója.

ItemType

Felsorolás

Az elem típusa. Idővel további elemtípusok is hozzáadhatók.

Érték	Description
Dashboard	PowerBI-irányítópult.
Report	PowerBI-jelentés.
SemanticModel	PowerBI szemantikai modell.
PaginatedReport	Többoldalas PowerBI-jelentés.
Datamart	PowerBI datamart.
Lakehouse	Egy tóház.
Eventhouse	Egy rendezvényház.
Environment	Egy környezet.
KQLDatabase	KQL-adatbázis.
KQLQueryset	KQL-lekérdezéskészlet.
KQLDashboard	KQL-irányítópult.
DataPipeline	Egy adatfolyam.
Notebook	Egy jegyzetfüzet.
SparkJobDefinition	Spark-feladat definíciója.
MLExperiment	Gépi tanulási kísérlet.
MLModel	Gépi tanulási modell.
Warehouse	Egy raktár.
Eventstream	Eseménystream.
SQLEndpoint	EGY SQL-végpont.
MirroredWarehouse	Egy tükrözött raktár.
MirroredDatabase	Tükrözött adatbázis.
Reflex	Egy reflex.
GraphQLApi	Api a GraphQL-elemhez.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Másolási feladat.
VariableLibrary	Egy VariableLibrary.
Dataflow	Adatfolyam.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Raktári pillanatkép.
DigitalTwinBuilder	Egy DigitalTwinBuilder.
DigitalTwinBuilderFlow	A Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Tükrözött Azure Databricks-katalógus.
Map	Térkép.
AnomalyDetector	Anomáliadetektor.
UserDataFunction	Felhasználói adatfüggvény.
GraphModel	Egy GraphModel.
GraphQuerySet	Egy Graph Queryset.
SnowflakeDatabase	Snowflake-adatbázis a Snowflake-fiókból létrehozott Iceberg-táblák tárolására.
OperationsAgent	Egy OperationsAgent.
CosmosDBDatabase	Cosmos DB-adatbázis.

PayloadType

Felsorolás

A definíciórész hasznos adattípusa. Idővel további hasznos adattípusok is hozzáadhatók.

Érték	Description
InlineBase64	Beágyazott 64-es alap.

Megosztás a következőn keresztül:

Items - Create GraphQLApi

Engedélyek

Kötelező delegált hatókörök

Korlátozások

Microsoft Entra által támogatott identitások

Interfész

URI-paraméterek

Kérelem törzse

Válaszok

Példák

Create a API for GraphQL example

Mintakérelem

Mintaválasz

Create a GraphQLApi with public definition example

Mintakérelem

Mintaválasz

Definíciók

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType