Items - Create GraphQLApi

Služba:: GraphQLApi

Verzia rozhrania API:: v1

Vytvorí rozhranie API pre položku GraphQL v zadanom pracovnom priestore.

Toto rozhranie API podporuje dlhotrvajúce operácie (LRO).

Ak chcete vytvoriť položku GraphQLApi s verejnou definíciou, pozrite si definíciu GraphQLApi.

Povolenia

Volajúci musí mať rolu pracovného priestoru prispievateľa .

Povinné delegované rozsahy

GraphQLApi.ReadWrite.All alebo Item.ReadWrite.All

Obmedzenia

Ak chcete vytvoriť rozhranie GraphQLApi, pracovný priestor sa musí nachádzať v podporovanej kapacite služby Fabric. Ďalšie informácie nájdete v téme Typy licencií na Microsoft Fabric.

Podporované identity v aplikácii Microsoft Entra

Toto rozhranie API podporuje identity Microsoft uvedené v tejto časti.

Identita	Podpora
Používateľ	Áno
Objekt služby a spravované identity	Áno

Rozhranie

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

Parametre URI

Name	V	Povinné	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovného priestoru.

Text požiadavky

Name	Povinné	Typ	Description
displayName	True	string	Rozhranie API pre zobrazovaný názov GraphQL. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.
definition		GraphQLApiPublicDefinition	Rozhranie API pre verejnú definíciu GraphQL.
description		string	Rozhranie API pre popis GraphQL. Maximálna dĺžka je 256 znakov.
folderId		string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa rozhranie API pre GraphQL s pracovným priestorom ako priečinkom.

Odpovede

Name	Typ	Description
201 Created	GraphQLApi	Úspešne vytvorené
202 Accepted		Prebieha poskytovanie GraphQLApi Žiadosť prijatá. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Bežné kódy chýb: InvalidItemType – typ položky je neplatný ItemDisplayNameAlreadyInUse – zobrazovaný názov položky sa už používa. CorruptedPayload – poskytnutá údajová časť je poškodená. Limit položiek pracovného priestoruItemsLimitExceeded – limit položiek pracovného priestoru bol prekročený.

Name

Typ

Description

201 Created

GraphQLApi

Úspešne vytvorené

202 Accepted

Prebieha poskytovanie GraphQLApi Žiadosť prijatá.

Hlavičky

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

Other Status Codes

ErrorResponse

Bežné kódy chýb:

InvalidItemType – typ položky je neplatný
ItemDisplayNameAlreadyInUse – zobrazovaný názov položky sa už používa.
CorruptedPayload – poskytnutá údajová časť je poškodená.
Limit položiek pracovného priestoruItemsLimitExceeded – limit položiek pracovného priestoru bol prekročený.

Príklady

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Vzorová požiadavka

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

Vzorová odpoveď

Kód stavu:: 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"
}

Kód stavu:: 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

Vzorová požiadavka

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

Vzorová odpoveď

Kód stavu:: 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"
}

Kód stavu:: 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ície

Name	Description
CreateGraphQLApiRequest	Vytvorte rozhranie API pre údajovú časť požiadavky GraphQL.
ErrorRelatedResource	Objekt s podrobnosťami o zdroji súvisiacej s chybou.
ErrorResponse	Odpoveď na chybu.
ErrorResponseDetails	Podrobnosti o chybovej odpovedi.
GraphQLApi	Rozhranie API pre položku GraphQL.
GraphQLApiPublicDefinition	Rozhranie API pre objekt verejnej definície jazyka GraphQL. Ak chcete vytvoriť definíciu, pozrite si tému Definícia jazyka GraphQLApi.
GraphQLApiPublicDefinitionPart	Rozhranie API pre časť objektu definície GraphQL.
ItemTag	Predstavuje značku použitú na položke.
ItemType	Typ položky. V priebehu času je možné pridať ďalšie typy položiek.
PayloadType	Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

CreateGraphQLApiRequest

Object

Vytvorte rozhranie API pre údajovú časť požiadavky GraphQL.

Name	Typ	Description
definition	GraphQLApiPublicDefinition	Rozhranie API pre verejnú definíciu GraphQL.
description	string	Rozhranie API pre popis GraphQL. Maximálna dĺžka je 256 znakov.
displayName	string	Rozhranie API pre zobrazovaný názov GraphQL. Zobrazovaný názov musí postupovať podľa pravidiel pomenovania podľa typu položky.
folderId	string (uuid)	ID priečinka. Ak parameter nie je zadaný alebo má hodnotu null, vytvorí sa rozhranie API pre GraphQL s pracovným priestorom ako priečinkom.

ErrorRelatedResource

Object

Objekt s podrobnosťami o zdroji súvisiacej s chybou.

Name	Typ	Description
resourceId	string	ID prostriedku, ktoré je súčasťou chyby.
resourceType	string	Typ prostriedku, ktorý je zapojený do chyby.

ErrorResponse

Object

Odpoveď na chybu.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
moreDetails	ErrorResponseDetails[]	Zoznam ďalších podrobností o chybe.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.
requestId	string	ID požiadavky súvisiacej s chybou.

ErrorResponseDetails

Object

Podrobnosti o chybovej odpovedi.

Name	Typ	Description
errorCode	string	Konkrétny identifikátor, ktorý poskytuje informácie o chybovej podmienke a umožňuje štandardizovanú komunikáciu medzi našou službou a používateľmi.
message	string	Zobrazenie chyby čitateľné ľuďmi.
relatedResource	ErrorRelatedResource	Podrobnosti o zdrojoch súvisiacich s chybou.

GraphQLApi

Object

Rozhranie API pre položku GraphQL.

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný názov položky.
folderId	string (uuid)	ID priečinka.
id	string (uuid)	ID položky.
tags	ItemTag[]	Zoznam použitých značiek.
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovného priestoru.

GraphQLApiPublicDefinition

Object

Rozhranie API pre objekt verejnej definície jazyka GraphQL. Ak chcete vytvoriť definíciu, pozrite si tému Definícia jazyka GraphQLApi.

Name	Typ	Description
format	string	Formát definície položky.
parts	GraphQLApiPublicDefinitionPart[]	Zoznam častí definície.

GraphQLApiPublicDefinitionPart

Object

Rozhranie API pre časť objektu definície GraphQL.

Name	Typ	Description
path	string	Cesta k definícii rozhrania API pre GraphQL.
payload	string	Časť údajovej časti rozhrania API pre definíciu jazyka GraphQL.
payloadType	PayloadType	Typ údajovej časti.

ItemTag

Object

Predstavuje značku použitú na položke.

Name	Typ	Description
displayName	string	Názov značky.
id	string (uuid)	ID značky.

ItemType

Enumerácia

Typ položky. V priebehu času je možné pridať ďalšie typy položiek.

Hodnota	Description
Dashboard	Tabuľa služby PowerBI.
Report	Zostava PowerBI.
SemanticModel	Sémantický model PowerBI.
PaginatedReport	Stránkovaná zostava služby PowerBI.
Datamart	Údajový diagram služby PowerBI.
Lakehouse	Jazero.
Eventhouse	Eventhouse.
Environment	Prostredie.
KQLDatabase	Databáza KQL.
KQLQueryset	Množina dotazov KQL.
KQLDashboard	Tabuľa KQL.
DataPipeline	Kanál údajov.
Notebook	Poznámkový blok.
SparkJobDefinition	Definícia úlohy iskry.
MLExperiment	Experiment strojového učenia.
MLModel	Model strojového učenia.
Warehouse	Sklad.
Eventstream	Udalosť eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrkadlový sklad.
MirroredDatabase	Zrkadlová databáza.
Reflex	A Reflex.
GraphQLApi	Rozhranie API pre položku GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáza SQLDatabase.
CopyJob	Kopírovať úlohu.
VariableLibrary	A VariableLibrary.
Dataflow	Tok údajov.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímka skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digitálny postup Twin Buildera.
MirroredAzureDatabricksCatalog	Zrkadlový katalóg Azure databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkcia user data function.
GraphModel	A GraphModel.
GraphQuerySet	Množina dotazov Graphu.
SnowflakeDatabase	Databáza Snowflake na ukladanie tabuliek ľadovec vytvorených z konta Snowflake.
OperationsAgent	OperationsAgent (Operácia).
CosmosDBDatabase	Databáza Cosmos DB.

PayloadType

Enumerácia

Typ údajovej časti definície. V priebehu času je možné pridať ďalšie typy údajovej časti.

Hodnota	Description
InlineBase64	Inline Base 64.

Zdieľať cez

Items - Create GraphQLApi

Povolenia

Povinné delegované rozsahy

Obmedzenia

Podporované identity v aplikácii Microsoft Entra

Rozhranie

Parametre URI

Text požiadavky

Odpovede

Príklady

Create a API for GraphQL example

Vzorová požiadavka

Vzorová odpoveď

Create a GraphQLApi with public definition example

Vzorová požiadavka

Vzorová odpoveď

Definície

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType