Items - Create GraphQLApi

Palvelu:: GraphQLApi

Ohjelmointirajapinnan versio:: v1

Luo ohjelmointirajapinnan GraphQL-kohteelle määritetyssä työtilassa.

Tämä ohjelmointirajapinta tukee pitkäkestoisia toimintoja.

Jos haluat luoda GraphQLApi-kohteen julkisella määritelmällä, katso GraphQLApi-määritelmä.

Käyttöoikeudet

Kutsujalla on oltava osallistujan työtilan rooli.

Vaaditut delegoidut vaikutusalueet

GraphQLApi.ReadWrite.All tai Item.ReadWrite.All

Rajoitukset

Jotta voit luoda GraphQLAPI-ohjelmointirajapinnan, työtilan on oltava tuetussa Fabric-kapasiteetissa. Lisätietoja on ohjeaiheessa Microsoft Fabric -käyttöoikeustyypit.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identiteetti	Tuki
Käyttäjä	Kyllä
palvelun päänimen ja Hallittujen käyttäjätietojen	Kyllä

Rajapinta

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
workspaceId	path	True	string (uuid)	Työtilan tunnus.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string	GraphQL-näyttönimen ohjelmointirajapinta. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
definition		GraphQLApiPublicDefinition	GraphQL:n julkisen määrityksen ohjelmointirajapinta.
description		string	GraphQL-kuvauksen ohjelmointirajapinta. Enimmäispituus on 256 merkkiä.
folderId		string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvo, GraphQL:n ohjelmointirajapinta luodaan siten, että työtila on sen kansio.

Vastaukset

Nimi	Tyyppi	Description
201 Created	GraphQLApi	Luonti onnistui
202 Accepted		Pyyntö hyväksytty, GraphQLApi-valmistelu on meneillään. Otsikot Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: InvalidItemType – Kohdetyyppi on virheellinen ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä. VioittunutPayload – Annetut tiedot ovat vioittuneet. WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Nimi

Tyyppi

Description

201 Created

GraphQLApi

Luonti onnistui

202 Accepted

Pyyntö hyväksytty, GraphQLApi-valmistelu on meneillään.

Otsikot

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

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

InvalidItemType – Kohdetyyppi on virheellinen
ItemDisplayNameAlreadyInUse – Kohteen näyttönimi on jo käytössä.
VioittunutPayload – Annetut tiedot ovat vioittuneet.
WorkspaceItemsLimitExceeded – Työtilan kohteen raja ylitetty.

Esimerkit

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Mallipyyntö

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

Mallivastaus

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

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

Mallipyyntö

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

Mallivastaus

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

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

Määritelmät

Nimi	Description
CreateGraphQLApiRequest	Luo ohjelmointirajapinta GraphQL-pyyntöjen kuormituksille.
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
GraphQLApiPublicDefinition	GraphQL:n julkisen määritelmän objektin ohjelmointirajapinta. Jos haluat luoda määrityksen, katso GraphQLApi-määritelmä.
GraphQLApiPublicDefinitionPart	GraphQL-määritelmäosaobjektin ohjelmointirajapinta.
ItemTag	Edustaa kohteelle käytettyä tunnistetta.
ItemType	Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.
PayloadType	Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

CreateGraphQLApiRequest

Kohde

Luo ohjelmointirajapinta GraphQL-pyyntöjen kuormituksille.

Nimi	Tyyppi	Description
definition	GraphQLApiPublicDefinition	GraphQL:n julkisen määrityksen ohjelmointirajapinta.
description	string	GraphQL-kuvauksen ohjelmointirajapinta. Enimmäispituus on 256 merkkiä.
displayName	string	GraphQL-näyttönimen ohjelmointirajapinta. Näyttönimen on noudatettava nimeämissääntöjä kohdetyypin mukaan.
folderId	string (uuid)	Kansion tunnus. Jos sitä ei määritetä tai se on tyhjäarvo, GraphQL:n ohjelmointirajapinta luodaan siten, että työtila on sen kansio.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.

GraphQLApi

Kohde

Ohjelmointirajapinta GraphQL-kohteelle.

Nimi	Tyyppi	Description
description	string	Kohteen kuvaus.
displayName	string	Kohteen näyttönimi.
folderId	string (uuid)	Kansion tunnus.
id	string (uuid)	Kohdetunnus.
tags	ItemTag[]	Luettelo käytössä olevista tunnisteista.
type	ItemType	Kohdetyyppi.
workspaceId	string (uuid)	Työtilan tunnus.

GraphQLApiPublicDefinition

Kohde

GraphQL:n julkisen määritelmän objektin ohjelmointirajapinta. Jos haluat luoda määrityksen, katso GraphQLApi-määritelmä.

Nimi	Tyyppi	Description
format	string	Kohteen määrityksen muoto.
parts	GraphQLApiPublicDefinitionPart[]	Luettelo määritysosista.

GraphQLApiPublicDefinitionPart

Kohde

GraphQL-määritelmäosaobjektin ohjelmointirajapinta.

Nimi	Tyyppi	Description
path	string	GraphQL-määritysosan polun ohjelmointirajapinta.
payload	string	Ohjelmointirajapinta GraphQL-määritelmäosan kuormitukselle.
payloadType	PayloadType	Hyötykuorman tyyppi.

ItemTag

Kohde

Edustaa kohteelle käytettyä tunnistetta.

Nimi	Tyyppi	Description
displayName	string	Tunnisteen nimi.
id	string (uuid)	Tunnisteen tunnus.

ItemType

Luettelointi

Kohteen tyyppi. Muita kohdetyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
Dashboard	Power BI -koontinäyttö.
Report	PowerBI -raportti.
SemanticModel	PowerBI:n semanttinen malli.
PaginatedReport	PowerBI:n sivutettu raportti.
Datamart	PowerBI -tietomarssi.
Lakehouse	Tämä on lakehouse.
Eventhouse	Tapahtumatalo.
Environment	Ympäristö.
KQLDatabase	KQL-tietokanta.
KQLQueryset	KQL-kyselyjoukko.
KQLDashboard	KQL-koontinäyttö.
DataPipeline	Tietoputki.
Notebook	Muistikirja.
SparkJobDefinition	Spark-työn määritelmä.
MLExperiment	Koneoppimisen kokeilu.
MLModel	Koneoppimismalli.
Warehouse	Varasto.
Eventstream	Tapahtumavirta.
SQLEndpoint	SQL-päätepiste.
MirroredWarehouse	Peilattu varasto.
MirroredDatabase	Peilattu tietokanta.
Reflex	Refleksi.
GraphQLApi	Ohjelmointirajapinta GraphQL-kohteelle.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	A SQLDatabase.
CopyJob	Kopiotyö.
VariableLibrary	MuuttujaLibrary.
Dataflow	Tietovuo.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Varastotilannevedos.
DigitalTwinBuilder	A DigitalTwinBuilder.
DigitalTwinBuilderFlow	Digital Twin Builder -työnkulku.
MirroredAzureDatabricksCatalog	Peilattu Azure Databricks -luettelo.
Map	Kartta.
AnomalyDetector	Poikkeamien tunnistaminen.
UserDataFunction	Käyttäjätietofunktio.
GraphModel	A GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake-tietokannalla tallennetaan Snowflake-tililtä luodut Iceberg-taulukot.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Cosmos DB -tietokanta.

PayloadType

Luettelointi

Määritelmäosan hyötykuorman tyyppi. Lisää hyötykuormitustyyppejä voidaan lisätä ajan kuluessa.

Arvo	Description
InlineBase64	Inline Base 64.

Jaa kautta

Items - Create GraphQLApi

Käyttöoikeudet

Vaaditut delegoidut vaikutusalueet

Rajoitukset

Microsoft Entran tukemat käyttäjätiedot

Rajapinta

URI-parametrit

Pyynnön leipäteksti

Vastaukset

Esimerkit

Create a API for GraphQL example

Mallipyyntö

Mallivastaus

Create a GraphQLApi with public definition example

Mallipyyntö

Mallivastaus

Määritelmät

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType