Items - Create GraphQLApi

Služba:: GraphQLApi

Verze rozhraní API:: v1

Vytvoří rozhraní API pro položku GraphQL v zadaném pracovním prostoru.

Toto rozhraní API podporuje dlouhotrvajících operací (LRO).

Pokud chcete vytvořit položku GraphQLApi s veřejnou definicí, projděte si definici GraphQLApi.

Dovolení

Volající musí mít roli pracovního prostoru přispěvatele .

Požadované delegovaná rozsahy

GraphQLApi.ReadWrite.All nebo Item.ReadWrite.All

Omezení

Pokud chcete vytvořit GraphQLApi, musí být pracovní prostor v podporované kapacitě Fabric. Další informace naleznete v tématu: typy licencí Microsoft Fabric.

Podporované identity Microsoft Entra

Toto rozhraní API podporuje identity Microsoft uvedené v této části.

Identita	Podpora
Uživatel	Ano
instančního objektu a spravované identity	Ano

Rozhraní

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string (uuid)	ID pracovního prostoru.

Text požadavku

Name	Vyžadováno	Typ	Description
displayName	True	string	Zobrazovaný název rozhraní API pro GraphQL Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
definition		GraphQLApiPublicDefinition	Veřejná definice rozhraní API pro GraphQL
description		string	Popis rozhraní API pro GraphQL Maximální délka je 256 znaků.
folderId		string (uuid)	ID složky. Pokud není zadána hodnota null, vytvoří se rozhraní API pro GraphQL s pracovním prostorem jako její složkou.

Odpovědi

Name	Typ	Description
201 Created	GraphQLApi	Úspěšně vytvořeno
202 Accepted		Žádost byla přijata a probíhá zřizování GraphQLApi. Hlavičky Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Běžné kódy chyb: InvalidItemType – Typ položky je neplatný. ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit. Poškozená částPayload – zadanou datovou část je poškozena. WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Name

Typ

Description

201 Created

GraphQLApi

Úspěšně vytvořeno

202 Accepted

Žádost byla přijata a probíhá zřizování GraphQLApi.

Hlavičky

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

Other Status Codes

ErrorResponse

Běžné kódy chyb:

InvalidItemType – Typ položky je neplatný.
ItemDisplayNameAlreadyInUse – Zobrazovaný název položky je již použit.
Poškozená částPayload – zadanou datovou část je poškozena.
WorkspaceItemsLimitExceededed – Došlo k překročení limitu položek pracovního prostoru.

Příklady

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
}

Stavový kó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

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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"
}

Stavový kó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

Definice

Name	Description
CreateGraphQLApiRequest	Vytvořte rozhraní API pro datovou část požadavku GraphQL.
ErrorRelatedResource	Chyba související s objektem podrobností o prostředku.
ErrorResponse	Odpověď na chybu.
ErrorResponseDetails	Podrobnosti o odpovědi na chybu.
GraphQLApi	Rozhraní API pro položku GraphQL
GraphQLApiPublicDefinition	Rozhraní API pro objekt veřejné definice GraphQL Pokud chcete definici vytvořit, podívejte se na definici GraphQLApi.
GraphQLApiPublicDefinitionPart	Rozhraní API pro objekt části definice GraphQL
ItemTag	Představuje značku použitou u položky.
ItemType	Typ položky. V průběhu času je možné přidat další typy položek.
PayloadType	Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

CreateGraphQLApiRequest

Objekt

Vytvořte rozhraní API pro datovou část požadavku GraphQL.

Name	Typ	Description
definition	GraphQLApiPublicDefinition	Veřejná definice rozhraní API pro GraphQL
description	string	Popis rozhraní API pro GraphQL Maximální délka je 256 znaků.
displayName	string	Zobrazovaný název rozhraní API pro GraphQL Zobrazovaný název musí odpovídat pravidlům pojmenování podle typu položky.
folderId	string (uuid)	ID složky. Pokud není zadána hodnota null, vytvoří se rozhraní API pro GraphQL s pracovním prostorem jako její složkou.

ErrorRelatedResource

Objekt

Chyba související s objektem podrobností o prostředku.

Name	Typ	Description
resourceId	string	ID prostředku, které je součástí chyby.
resourceType	string	Typ prostředku, který je součástí chyby.

ErrorResponse

Objekt

Odpověď na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
moreDetails	ErrorResponseDetails[]	Seznam dalších podrobností o chybě
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou
requestId	string	ID požadavku přidruženého k chybě.

ErrorResponseDetails

Objekt

Podrobnosti o odpovědi na chybu.

Name	Typ	Description
errorCode	string	Konkrétní identifikátor, který poskytuje informace o chybovém stavu, což umožňuje standardizovanou komunikaci mezi naší službou a jejími uživateli.
message	string	Lidské čitelné vyjádření chyby.
relatedResource	ErrorRelatedResource	Podrobnosti o prostředku souvisejícím s chybou

GraphQLApi

Objekt

Rozhraní API pro položku GraphQL

Name	Typ	Description
description	string	Popis položky.
displayName	string	Zobrazovaný název položky.
folderId	string (uuid)	ID složky.
id	string (uuid)	ID položky.
tags	ItemTag[]	Seznam použitých značek
type	ItemType	Typ položky.
workspaceId	string (uuid)	ID pracovního prostoru.

GraphQLApiPublicDefinition

Objekt

Rozhraní API pro objekt veřejné definice GraphQL Pokud chcete definici vytvořit, podívejte se na definici GraphQLApi.

Name	Typ	Description
format	string	Formát definice položky.
parts	GraphQLApiPublicDefinitionPart[]	Seznam částí definice.

GraphQLApiPublicDefinitionPart

Objekt

Rozhraní API pro objekt části definice GraphQL

Name	Typ	Description
path	string	Cesta části definice ROZHRANÍ API pro GraphQL.
payload	string	Datová část definice rozhraní API pro GraphQL.
payloadType	PayloadType	Typ datové části.

ItemTag

Objekt

Představuje značku použitou u položky.

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

ItemType

Výčet

Typ položky. V průběhu času je možné přidat další typy položek.

Hodnota	Description
Dashboard	Řídicí panel PowerBI
Report	Sestava PowerBI
SemanticModel	Sémantický model PowerBI
PaginatedReport	Stránkovaná sestava PowerBI
Datamart	Datový diagram PowerBI
Lakehouse	Jezero.
Eventhouse	Eventhouse.
Environment	Prostředí.
KQLDatabase	Databáze KQL.
KQLQueryset	Sada dotazů KQL.
KQLDashboard	Řídicí panel KQL.
DataPipeline	Datový kanál.
Notebook	Poznámkový blok.
SparkJobDefinition	Definice úlohy Sparku.
MLExperiment	Experiment strojového učení.
MLModel	Model strojového učení.
Warehouse	Sklad.
Eventstream	Eventstream.
SQLEndpoint	Koncový bod SQL.
MirroredWarehouse	Zrcadlený sklad.
MirroredDatabase	Zrcadlené databáze.
Reflex	A Reflex.
GraphQLApi	Rozhraní API pro položku GraphQL
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Databáze SQLDatabase.
CopyJob	Úloha kopírování.
VariableLibrary	ProměnnáLibrary.
Dataflow	Tok dat.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Snímek skladu.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Tok digitálního dvojčete.
MirroredAzureDatabricksCatalog	Zrcadlený katalog Azure Databricks.
Map	Mapa.
AnomalyDetector	Detektor anomálií.
UserDataFunction	Funkce uživatelských dat.
GraphModel	A GraphModel.
GraphQuerySet	Sada dotazů grafu.
SnowflakeDatabase	Snowflake Database pro ukládání tabulek Iceberg vytvořených z účtu Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Databáze Cosmos DB.

PayloadType

Výčet

Typ datové části definice. V průběhu času je možné přidat další typy datových částí.

Hodnota	Description
InlineBase64	Vložená základna 64.

Sdílet prostřednictvím

Items - Create GraphQLApi

Dovolení

Požadované delegovaná rozsahy

Omezení

Podporované identity Microsoft Entra

Rozhraní

Parametry identifikátoru URI

Text požadavku

Odpovědi

Příklady

Create a API for GraphQL example

Ukázkový požadavek

Ukázková odpověď

Create a GraphQLApi with public definition example

Ukázkový požadavek

Ukázková odpověď

Definice

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType