Items - Create GraphQLApi

Dienst:: GraphQLApi

API-Version:: v1

Erstellt eine API für das GraphQL-Element im angegebenen Arbeitsbereich.

Diese API unterstützt LRO-.

Informationen zum Erstellen eines GraphQLApi-Elements mit einer öffentlichen Definition finden Sie in der GraphQLApi-Definition.

Erlaubnisse

Der Aufrufer muss über eine Rolle des Mitwirkenden-Arbeitsbereichs verfügen.

Erforderliche delegierte Bereiche

GraphQLApi.ReadWrite.All oder Item.ReadWrite.All

Begrenzungen

Zum Erstellen einer GraphQLApi muss sich der Arbeitsbereich auf einer unterstützten Fabric-Kapazität befindet. Weitere Informationen finden Sie unter: Microsoft Fabric-Lizenztypen.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identität	Unterstützen
Benutzer	Ja
Dienstprinzipal und verwaltete Identitäten	Ja

Schnittstelle

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
workspaceId	path	True	string (uuid)	Die Arbeitsbereichs-ID.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
displayName	True	string	Der ANZEIGEname der API für GraphQL. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
definition		GraphQLApiPublicDefinition	Die öffentliche Definition der API für GraphQL.
description		string	Die API für GraphQL-Beschreibung. Die maximale Länge beträgt 256 Zeichen.
folderId		string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die API für GraphQL mit dem Arbeitsbereich als Ordner erstellt.

Antworten

Name	Typ	Beschreibung
201 Created	GraphQLApi	Erfolgreich erstellt
202 Accepted		Anforderung akzeptiert, GraphQLApi-Bereitstellung wird ausgeführt. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Häufige Fehlercodes: InvalidItemType – Elementtyp ist ungültig. ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet. CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt. WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Name

Typ

Beschreibung

201 Created

GraphQLApi

Erfolgreich erstellt

202 Accepted

Anforderung akzeptiert, GraphQLApi-Bereitstellung wird ausgeführt.

Header

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

Other Status Codes

ErrorResponse

Häufige Fehlercodes:

InvalidItemType – Elementtyp ist ungültig.
ItemDisplayNameAlreadyInUse - Der Anzeigename des Elements wird bereits verwendet.
CorruptedPayload – Die bereitgestellte Nutzlast ist beschädigt.
WorkspaceItemsLimitExceededed – Grenzwert für Arbeitsbereichselemente wurde überschritten.

Beispiele

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Beispielanforderung

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

Beispiel für eine Antwort

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

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

Definitionen

Name	Beschreibung
CreateGraphQLApiRequest	Erstellen Sie DIE API für die GraphQL-Anforderungsnutzlast.
ErrorRelatedResource	Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse	Die Fehlerantwort.
ErrorResponseDetails	Die Fehlerantwortdetails.
GraphQLApi	Eine API für GraphQL-Element.
GraphQLApiPublicDefinition	API für öffentliches GraphQL-Definitionsobjekt. Informationen zum Erstellen der Definition finden Sie unter GraphQLApi-Definition.
GraphQLApiPublicDefinitionPart	API für GraphQL-Definitionsteilobjekt.
ItemTag	Stellt ein Tag dar, das auf ein Element angewendet wird.
ItemType	Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.
PayloadType	Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

CreateGraphQLApiRequest

Objekt

Erstellen Sie DIE API für die GraphQL-Anforderungsnutzlast.

Name	Typ	Beschreibung
definition	GraphQLApiPublicDefinition	Die öffentliche Definition der API für GraphQL.
description	string	Die API für GraphQL-Beschreibung. Die maximale Länge beträgt 256 Zeichen.
displayName	string	Der ANZEIGEname der API für GraphQL. Der Anzeigename muss den Benennungsregeln entsprechend dem Elementtyp entsprechen.
folderId	string (uuid)	Die Ordner-ID. Wenn sie nicht angegeben oder null ist, wird die API für GraphQL mit dem Arbeitsbereich als Ordner erstellt.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name	Typ	Beschreibung
resourceId	string	Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType	string	Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
moreDetails	ErrorResponseDetails[]	Liste der zusätzlichen Fehlerdetails.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.
requestId	string	ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name	Typ	Beschreibung
errorCode	string	Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message	string	Eine lesbare Darstellung des Fehlers.
relatedResource	ErrorRelatedResource	Die fehlerbezogenen Ressourcendetails.

GraphQLApi

Objekt

Eine API für GraphQL-Element.

Name	Typ	Beschreibung
description	string	Die Elementbeschreibung.
displayName	string	Der Anzeigename des Elements.
folderId	string (uuid)	Die Ordner-ID.
id	string (uuid)	Die Element-ID.
tags	ItemTag[]	Liste der angewendeten Tags.
type	ItemType	Der Elementtyp.
workspaceId	string (uuid)	Die Arbeitsbereichs-ID.

GraphQLApiPublicDefinition

Objekt

API für öffentliches GraphQL-Definitionsobjekt. Informationen zum Erstellen der Definition finden Sie unter GraphQLApi-Definition.

Name	Typ	Beschreibung
format	string	Das Format der Elementdefinition.
parts	GraphQLApiPublicDefinitionPart[]	Eine Liste der Definitionsteile.

GraphQLApiPublicDefinitionPart

Objekt

API für GraphQL-Definitionsteilobjekt.

Name	Typ	Beschreibung
path	string	Der API für den GraphQL-Definitionsteilpfad.
payload	string	Die API für Die Nutzlast des GraphQL-Definitionsteils.
payloadType	PayloadType	Der Nutzlasttyp.

ItemTag

Objekt

Stellt ein Tag dar, das auf ein Element angewendet wird.

Name	Typ	Beschreibung
displayName	string	Der Name des Tags.
id	string (uuid)	Die Tag-ID.

ItemType

Enumeration

Der Typ des Elements. Zusätzliche Elementtypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
Dashboard	PowerBI-Dashboard.
Report	PowerBI-Bericht.
SemanticModel	PowerBI-Semantikmodell.
PaginatedReport	PowerBI-Paginated-Bericht.
Datamart	PowerBI datamart.
Lakehouse	Ein Seehaus.
Eventhouse	Ein Eventhouse.
Environment	Eine Umgebung.
KQLDatabase	Eine KQL-Datenbank.
KQLQueryset	Ein KQL-Abfrageset.
KQLDashboard	Ein KQL-Dashboard.
DataPipeline	Eine Datenpipeline.
Notebook	Ein Notizbuch.
SparkJobDefinition	Eine Sparkauftragsdefinition.
MLExperiment	Ein Machine Learning-Experiment.
MLModel	Ein Machine Learning-Modell.
Warehouse	Ein Lagerhaus.
Eventstream	Ein Ereignisstream.
SQLEndpoint	Ein SQL-Endpunkt.
MirroredWarehouse	Ein gespiegeltes Lager.
MirroredDatabase	Eine gespiegelte Datenbank.
Reflex	Ein Reflex.
GraphQLApi	Eine API für GraphQL-Element.
MountedDataFactory	Eine MountedDataFactory.
SQLDatabase	Eine SQLDatabase.
CopyJob	Ein Kopierauftrag.
VariableLibrary	Eine VariableLibrary.
Dataflow	Ein Datenfluss.
ApacheAirflowJob	Ein ApacheAirflowJob.
WarehouseSnapshot	Eine Warehouse-Momentaufnahme.
DigitalTwinBuilder	Ein DigitalTwinBuilder.
DigitalTwinBuilderFlow	Ein Digital Twin Builder Flow.
MirroredAzureDatabricksCatalog	Ein gespiegelter Azure Databricks-Katalog.
Map	Eine Karte.
AnomalyDetector	Anomaliedetektor.
UserDataFunction	Eine Benutzerdatenfunktion.
GraphModel	Ein GraphModel.
GraphQuerySet	Ein Graph QuerySet.
SnowflakeDatabase	Eine Snowflake-Datenbank zum Speichern von Iceberg-Tabellen, die aus dem Snowflake-Konto erstellt wurden.
OperationsAgent	Ein OperationsAgent.
CosmosDBDatabase	Eine Cosmos DB-Datenbank.

PayloadType

Enumeration

Der Typ der Definitionsteilnutzlast. Zusätzliche Nutzlasttypen können im Laufe der Zeit hinzugefügt werden.

Wert	Beschreibung
InlineBase64	Inlinebasis 64.

Freigeben über

Items - Create GraphQLApi

Erlaubnisse

Erforderliche delegierte Bereiche

Begrenzungen

Von Microsoft Entra unterstützte Identitäten

Schnittstelle

URI-Parameter

Anforderungstext

Antworten

Beispiele

Create a API for GraphQL example

Beispielanforderung

Beispiel für eine Antwort

Create a GraphQLApi with public definition example

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType