Items - Create GraphQLApi

Tjeneste:: GraphQLApi

API-versjon:: v1

Oppretter en API for GraphQL-element i det angitte arbeidsområdet.

Denne API-en støtter langvarige operasjoner (LRO).

Hvis du vil opprette GraphQLApi-element med en offentlig definisjon, kan du se GraphQLApi-definisjon.

Tillatelser

Innringeren må ha en rolle i arbeidsområdet for bidragsytere .

Nødvendige delegerte omfang

GraphQLApi.ReadWrite.All eller Item.ReadWrite.All

Begrensninger

Hvis du vil opprette en GraphQLApi, må arbeidsområdet være på en støttet Stoff-kapasitet. Hvis du vil ha mer informasjon, kan du se: Microsoft Fabric-lisenstyper.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet	Støtte
Bruker	Ja
tjenestekontohaver og administrerte identiteter	Ja

Grensesnitt

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

URI-parametere

Navn	I	Obligatorisk	Type	Beskrivelse
workspaceId	path	True	string (uuid)	Arbeidsområde-ID-en.

Brødtekst for forespørsel

Navn	Obligatorisk	Type	Beskrivelse
displayName	True	string	Visningsnavnet for API-en for GraphQL. Visningsnavnet må følge navnereglene i henhold til elementtype.
definition		GraphQLApiPublicDefinition	Den offentlige definisjonen for API-en for GraphQL.
description		string	API-en for GraphQL-beskrivelsen. Maksimal lengde er 256 tegn.
folderId		string (uuid)	Mappe-ID-en. Hvis det ikke er angitt eller null, opprettes API-en for GraphQL med arbeidsområdet som mappe.

Svar

Navn	Type	Beskrivelse
201 Created	GraphQLApi	Opprettet
202 Accepted		Forespørsel godtatt, GraphQLApi klargjøring pågår. Overskrifter Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Vanlige feilkoder: InvalidItemType – elementtypen er ugyldig ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt. CorruptedPayload – den angitte nyttelasten er skadet. WorkspaceItemsLimitExceeded – grensen for arbeidsområdeelement er overskredet.

Navn

Type

Beskrivelse

201 Created

GraphQLApi

Opprettet

202 Accepted

Forespørsel godtatt, GraphQLApi klargjøring pågår.

Overskrifter

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

Other Status Codes

ErrorResponse

Vanlige feilkoder:

InvalidItemType – elementtypen er ugyldig
ItemDisplayNameAlreadyInUse – visningsnavnet for elementet er allerede brukt.
CorruptedPayload – den angitte nyttelasten er skadet.
WorkspaceItemsLimitExceeded – grensen for arbeidsområdeelement er overskredet.

Eksempler

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Eksempelforespørsel

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

Eksempelsvar

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

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

Eksempelforespørsel

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

Eksempelsvar

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

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

Definisjoner

Navn	Beskrivelse
CreateGraphQLApiRequest	Opprett API for nyttelast for GraphQL-forespørsel.
ErrorRelatedResource	Objektet for feilrelaterte ressursdetaljer.
ErrorResponse	Feilsvaret.
ErrorResponseDetails	Feilsvardetaljene.
GraphQLApi	En API for GraphQL-element.
GraphQLApiPublicDefinition	API for offentlig GraphQL-definisjonsobjekt. Hvis du vil opprette definisjonen, kan du se GraphQLApi-definisjon.
GraphQLApiPublicDefinitionPart	API for graphQL-definisjonsdelobjekt.
ItemTag	Representerer en kode som brukes på et element.
ItemType	Typen element. Flere elementtyper kan legges til over tid.
PayloadType	Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

CreateGraphQLApiRequest

Objekt

Opprett API for nyttelast for GraphQL-forespørsel.

Navn	Type	Beskrivelse
definition	GraphQLApiPublicDefinition	Den offentlige definisjonen for API-en for GraphQL.
description	string	API-en for GraphQL-beskrivelsen. Maksimal lengde er 256 tegn.
displayName	string	Visningsnavnet for API-en for GraphQL. Visningsnavnet må følge navnereglene i henhold til elementtype.
folderId	string (uuid)	Mappe-ID-en. Hvis det ikke er angitt eller null, opprettes API-en for GraphQL med arbeidsområdet som mappe.

ErrorRelatedResource

Objekt

Objektet for feilrelaterte ressursdetaljer.

Navn	Type	Beskrivelse
resourceId	string	Ressurs-ID-en som er involvert i feilen.
resourceType	string	Typen ressurs som er involvert i feilen.

ErrorResponse

Objekt

Feilsvaret.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
moreDetails	ErrorResponseDetails[]	Liste over flere feildetaljer.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.
requestId	string	ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Objekt

Feilsvardetaljene.

Navn	Type	Beskrivelse
errorCode	string	En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message	string	En menneskelig lesbar representasjon av feilen.
relatedResource	ErrorRelatedResource	Feilrelaterte ressursdetaljer.

GraphQLApi

Objekt

En API for GraphQL-element.

Navn	Type	Beskrivelse
description	string	Elementbeskrivelsen.
displayName	string	Visningsnavnet for elementet.
folderId	string (uuid)	Mappe-ID-en.
id	string (uuid)	Element-ID-en.
tags	ItemTag[]	Liste over brukte merker.
type	ItemType	Elementtypen.
workspaceId	string (uuid)	Arbeidsområde-ID-en.

GraphQLApiPublicDefinition

Objekt

API for offentlig GraphQL-definisjonsobjekt. Hvis du vil opprette definisjonen, kan du se GraphQLApi-definisjon.

Navn	Type	Beskrivelse
format	string	Formatet for elementdefinisjonen.
parts	GraphQLApiPublicDefinitionPart[]	En liste over definisjonsdeler.

GraphQLApiPublicDefinitionPart

Objekt

API for graphQL-definisjonsdelobjekt.

Navn	Type	Beskrivelse
path	string	Delbanen for API-en for GraphQL-definisjon.
payload	string	API for GraphQL definisjon del nyttelast.
payloadType	PayloadType	Nyttelasttypen.

ItemTag

Objekt

Representerer en kode som brukes på et element.

Navn	Type	Beskrivelse
displayName	string	Navnet på koden.
id	string (uuid)	Kode-ID-en.

ItemType

Opplisting

Typen element. Flere elementtyper kan legges til over tid.

Verdi	Beskrivelse
Dashboard	PowerBI-instrumentbord.
Report	PowerBI-rapport.
SemanticModel	Semantisk PowerBI-modell.
PaginatedReport	Paginert powerbi-rapport.
Datamart	PowerBI-datamart.
Lakehouse	Et innsjøhus.
Eventhouse	Et arrangementshus.
Environment	Et miljø.
KQLDatabase	En KQL-database.
KQLQueryset	Et KQL-spørringssett.
KQLDashboard	Et KQL-instrumentbord.
DataPipeline	Et datasamlebånd.
Notebook	En notatblokk.
SparkJobDefinition	En spark-jobbdefinisjon.
MLExperiment	Et maskinlæringseksperiment.
MLModel	En maskinlæringsmodell.
Warehouse	Et lager.
Eventstream	En hendelsesstrøm.
SQLEndpoint	Et SQL-endepunkt.
MirroredWarehouse	Et speilvendt lager.
MirroredDatabase	En speilvendt database.
Reflex	En refleks.
GraphQLApi	En API for GraphQL-element.
MountedDataFactory	En MountedDataFactory.
SQLDatabase	En SQLDatabase.
CopyJob	En kopieringsjobb.
VariableLibrary	En VariableLibrary.
Dataflow	En dataflyt.
ApacheAirflowJob	En ApacheAirflowJob.
WarehouseSnapshot	Et øyeblikksbilde av lageret.
DigitalTwinBuilder	En DigitalTwinBuilder.
DigitalTwinBuilderFlow	En digital Twin Builder-flyt.
MirroredAzureDatabricksCatalog	En speilet azure databricks-katalog.
Map	Et kart.
AnomalyDetector	En avviksdetektor.
UserDataFunction	En brukerdatafunksjon.
GraphModel	En GraphModel.
GraphQuerySet	Et graph QuerySet.
SnowflakeDatabase	En Snowflake Database for å lagre Iceberg-tabeller opprettet fra Snowflake-kontoen.
OperationsAgent	En OperationsAgent.
CosmosDBDatabase	En Cosmos DB-database.

PayloadType

Opplisting

Typen nyttelast for definisjonsdelen. Flere nyttelasttyper kan legges til over tid.

Verdi	Beskrivelse
InlineBase64	Innebygd grunntall 64.

Del via

Items - Create GraphQLApi

Tillatelser

Nødvendige delegerte omfang

Begrensninger

Microsoft Entra-støttede identiteter

Grensesnitt

URI-parametere

Brødtekst for forespørsel

Svar

Eksempler

Create a API for GraphQL example

Eksempelforespørsel

Eksempelsvar

Create a GraphQLApi with public definition example

Eksempelforespørsel

Eksempelsvar

Definisjoner

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType