Items - Create GraphQLApi

Servizio:: GraphQLApi

Versione API:: v1

Crea un'API per l'elemento GraphQL nell'area di lavoro specificata.

Questa API supporta operazioni con esecuzione prolungata (LRO).

Per creare un elemento GraphQLApi con una definizione pubblica, fare riferimento alla definizione graphQLApi.

Autorizzazioni

Il chiamante deve avere un ruolo di area di lavoro collaboratore .

Ambiti delegati obbligatori

GraphQLApi.ReadWrite.All o Item.ReadWrite.All

Limitazioni

Per creare un oggetto GraphQLApi, l'area di lavoro deve essere in una capacità di Infrastruttura supportata. Per altre informazioni, vedere: tipi di licenza di Microsoft Fabric.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identità	Appoggiare
Utente	Sì
'entità servizio e identità gestite	Sì

Interfaccia

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
displayName	True	string	L'API per il nome visualizzato GraphQL. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
definition		GraphQLApiPublicDefinition	L'API per la definizione pubblica graphQL.
description		string	Descrizione dell'API per GraphQL. La lunghezza massima è di 256 caratteri.
folderId		string (uuid)	ID cartella. Se non specificato o null, l'API per GraphQL viene creata con l'area di lavoro come cartella.

Risposte

Nome	Tipo	Descrizione
201 Created	GraphQLApi	Creazione completata
202 Accepted		Richiesta accettata, provisioning GraphQLApi in corso. Intestazioni Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: InvalidItemType - Tipo di elemento non valido ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato. CorruptedPayload: il payload fornito è danneggiato. WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato.

Nome

Tipo

Descrizione

201 Created

GraphQLApi

Creazione completata

202 Accepted

Richiesta accettata, provisioning GraphQLApi in corso.

Intestazioni

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

Other Status Codes

ErrorResponse

Codici di errore comuni:

InvalidItemType - Tipo di elemento non valido
ItemDisplayNameAlreadyInUse: il nome visualizzato dell'elemento è già usato.
CorruptedPayload: il payload fornito è danneggiato.
WorkspaceItemsLimitExceeded - Limite di elementi dell'area di lavoro superato.

Esempio

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Codice di stato:: 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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:: 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"
}

Codice di stato:: 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

Definizioni

Nome	Descrizione
CreateGraphQLApiRequest	Creare l'API per il payload della richiesta GraphQL.
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GraphQLApi	API per l'elemento GraphQL.
GraphQLApiPublicDefinition	API per l'oggetto definizione pubblica GraphQL. Per creare la definizione, vedere Definizione GraphQLApi.
GraphQLApiPublicDefinitionPart	API per l'oggetto parte della definizione GraphQL.
ItemTag	Rappresenta un tag applicato a un elemento.
ItemType	Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.
PayloadType	Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

CreateGraphQLApiRequest

Oggetto

Creare l'API per il payload della richiesta GraphQL.

Nome	Tipo	Descrizione
definition	GraphQLApiPublicDefinition	L'API per la definizione pubblica graphQL.
description	string	Descrizione dell'API per GraphQL. La lunghezza massima è di 256 caratteri.
displayName	string	L'API per il nome visualizzato GraphQL. Il nome visualizzato deve seguire le regole di denominazione in base al tipo di elemento.
folderId	string (uuid)	ID cartella. Se non specificato o null, l'API per GraphQL viene creata con l'area di lavoro come cartella.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GraphQLApi

Oggetto

API per l'elemento GraphQL.

Nome	Tipo	Descrizione
description	string	Descrizione dell'elemento.
displayName	string	Nome visualizzato dell'elemento.
folderId	string (uuid)	ID cartella.
id	string (uuid)	ID elemento.
tags	ItemTag[]	Elenco di tag applicati.
type	ItemType	Tipo di elemento.
workspaceId	string (uuid)	ID dell'area di lavoro.

GraphQLApiPublicDefinition

Oggetto

API per l'oggetto definizione pubblica GraphQL. Per creare la definizione, vedere Definizione GraphQLApi.

Nome	Tipo	Descrizione
format	string	Formato della definizione dell'elemento.
parts	GraphQLApiPublicDefinitionPart[]	Elenco di parti di definizione.

GraphQLApiPublicDefinitionPart

Oggetto

API per l'oggetto parte della definizione GraphQL.

Nome	Tipo	Descrizione
path	string	Percorso della parte della parte di definizione graphQL dell'API.
payload	string	Payload della parte di definizione dell'API per GraphQL.
payloadType	PayloadType	Tipo di payload.

ItemTag

Oggetto

Rappresenta un tag applicato a un elemento.

Nome	Tipo	Descrizione
displayName	string	Nome del tag.
id	string (uuid)	ID tag.

ItemType

Enumerazione

Tipo dell'elemento. È possibile aggiungere altri tipi di elemento nel tempo.

Valore	Descrizione
Dashboard	Dashboard di Power BI.
Report	Report di Power BI.
SemanticModel	Modello semantico di PowerBI.
PaginatedReport	Report impaginato di Power BI.
Datamart	Datamart di PowerBI.
Lakehouse	Una lakehouse.
Eventhouse	Una casa eventi.
Environment	Un ambiente.
KQLDatabase	Un database KQL.
KQLQueryset	Set di query KQL.
KQLDashboard	Dashboard KQL.
DataPipeline	Una pipeline di dati.
Notebook	Un notebook.
SparkJobDefinition	Definizione di processo Spark.
MLExperiment	Esperimento di Machine Learning.
MLModel	Modello di Machine Learning.
Warehouse	Un magazzino.
Eventstream	Flusso di eventi.
SQLEndpoint	Endpoint SQL.
MirroredWarehouse	Magazzino con mirroring.
MirroredDatabase	Database con mirroring.
Reflex	Un riflesso.
GraphQLApi	API per l'elemento GraphQL.
MountedDataFactory	Oggetto MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Processo di copia.
VariableLibrary	VariabileLibrary.
Dataflow	Flusso di dati.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Uno snapshot del warehouse.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Flusso di Generatore di gemelli digitali.
MirroredAzureDatabricksCatalog	Catalogo di Azure databricks con mirroring.
Map	Una mappa.
AnomalyDetector	Rilevamento anomalie.
UserDataFunction	Funzione dati utente.
GraphModel	A GraphModel.
GraphQuerySet	Oggetto Graph QuerySet.
SnowflakeDatabase	Un database Snowflake per archiviare le tabelle Iceberg create dall'account Snowflake.
OperationsAgent	Oggetto OperationsAgent.
CosmosDBDatabase	Un database Cosmos DB.

PayloadType

Enumerazione

Tipo del payload della parte di definizione. È possibile aggiungere altri tipi di payload nel tempo.

Valore	Descrizione
InlineBase64	Inline Base 64.

Condividi tramite

Items - Create GraphQLApi

Autorizzazioni

Ambiti delegati obbligatori

Limitazioni

Identità supportate da Microsoft Entra

Interfaccia

Parametri dell'URI

Corpo della richiesta

Risposte

Esempio

Create a API for GraphQL example

Esempio di richiesta

Risposta di esempio

Create a GraphQLApi with public definition example

Esempio di richiesta

Risposta di esempio

Definizioni

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType