Items - Create GraphQLApi

Layanan:: GraphQLApi

Versi API:: v1

Membuat API untuk item GraphQL di ruang kerja yang ditentukan.

API ini mendukung operasi jangka panjang (LRO).

Untuk membuat item GraphQLApi dengan definisi publik, lihat definisi GraphQLApi.

Izin

Pemanggil harus memiliki peran ruang kerja kontributor .

Cakupan yang Didelegasikan yang Diperlukan

GraphQLApi.ReadWrite.All atau Item.ReadWrite.All

Keterbatasan

Untuk membuat GraphQLApi, ruang kerja harus berada pada kapasitas Fabric yang didukung. Untuk informasi selengkapnya, lihat: jenis lisensi Microsoft Fabric.

Identitas yang didukung Microsoft Entra

API ini mendukung identitas Microsoft yang tercantum di bagian ini.

Identitas	Dukung
Pengguna	Ya
perwakilan Layanan dan identitas terkelola	Ya

Antarmuka

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
workspaceId	path	True	string (uuid)	ID ruang kerja.

Isi Permintaan

Nama	Diperlukan	Jenis	Deskripsi
displayName	True	string	API untuk nama tampilan GraphQL. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.
definition		GraphQLApiPublicDefinition	API untuk definisi publik GraphQL.
description		string	API untuk deskripsi GraphQL. Panjang maksimum adalah 256 karakter.
folderId		string (uuid)	ID folder. Jika tidak ditentukan atau null, API untuk GraphQL dibuat dengan ruang kerja sebagai foldernya.

Respons

Nama	Jenis	Deskripsi
201 Created	GraphQLApi	Berhasil dibuat
202 Accepted		Permintaan diterima, provisi GraphQLApi sedang berlangsung. Header Location: string x-ms-operation-id: string Retry-After: integer
Other Status Codes	ErrorResponse	Kode kesalahan umum: InvalidItemType - Tipe item tidak valid ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan. CorruptedPayload - Payload yang disediakan rusak. WorkspaceItemsLimitExceeded - Batas item ruang kerja terlampaui.

Nama

Jenis

Deskripsi

201 Created

GraphQLApi

Berhasil dibuat

202 Accepted

Permintaan diterima, provisi GraphQLApi sedang berlangsung.

Header

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

Other Status Codes

ErrorResponse

Kode kesalahan umum:

InvalidItemType - Tipe item tidak valid
ItemDisplayNameAlreadyInUse - Nama tampilan item sudah digunakan.
CorruptedPayload - Payload yang disediakan rusak.
WorkspaceItemsLimitExceeded - Batas item ruang kerja terlampaui.

Contoh

Create a API for GraphQL example

Create a GraphQLApi with public definition example

Create a API for GraphQL example

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Kode status:: 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

Permintaan sampel

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

Respon sampel

Kode status:: 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"
}

Kode status:: 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

Definisi

Nama	Deskripsi
CreateGraphQLApiRequest	Buat API untuk payload permintaan GraphQL.
ErrorRelatedResource	Objek detail sumber daya terkait kesalahan.
ErrorResponse	Respons kesalahan.
ErrorResponseDetails	Detail respons kesalahan.
GraphQLApi	API untuk item GraphQL.
GraphQLApiPublicDefinition	API untuk objek definisi publik GraphQL. Untuk membuat definisi, lihat Definisi GraphQLApi.
GraphQLApiPublicDefinitionPart	API untuk objek bagian definisi GraphQL.
ItemTag	Mewakili tag yang diterapkan pada item.
ItemType	Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.
PayloadType	Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

CreateGraphQLApiRequest

Objek

Buat API untuk payload permintaan GraphQL.

Nama	Jenis	Deskripsi
definition	GraphQLApiPublicDefinition	API untuk definisi publik GraphQL.
description	string	API untuk deskripsi GraphQL. Panjang maksimum adalah 256 karakter.
displayName	string	API untuk nama tampilan GraphQL. Nama tampilan harus mengikuti aturan penamaan sesuai dengan jenis item.
folderId	string (uuid)	ID folder. Jika tidak ditentukan atau null, API untuk GraphQL dibuat dengan ruang kerja sebagai foldernya.

ErrorRelatedResource

Objek

Objek detail sumber daya terkait kesalahan.

Nama	Jenis	Deskripsi
resourceId	string	ID sumber daya yang terlibat dalam kesalahan.
resourceType	string	Jenis sumber daya yang terlibat dalam kesalahan.

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
moreDetails	ErrorResponseDetails[]	Daftar detail kesalahan tambahan.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.
requestId	string	ID permintaan yang terkait dengan kesalahan.

ErrorResponseDetails

Objek

Detail respons kesalahan.

Nama	Jenis	Deskripsi
errorCode	string	Pengidentifikasi tertentu yang menyediakan informasi tentang kondisi kesalahan, memungkinkan komunikasi standar antara layanan kami dan penggunanya.
message	string	Representasi kesalahan yang dapat dibaca manusia.
relatedResource	ErrorRelatedResource	Detail sumber daya terkait kesalahan.

GraphQLApi

Objek

API untuk item GraphQL.

Nama	Jenis	Deskripsi
description	string	Deskripsi item.
displayName	string	Nama tampilan item.
folderId	string (uuid)	ID folder.
id	string (uuid)	ID item.
tags	ItemTag[]	Daftar tag yang diterapkan.
type	ItemType	Jenis item.
workspaceId	string (uuid)	ID ruang kerja.

GraphQLApiPublicDefinition

Objek

API untuk objek definisi publik GraphQL. Untuk membuat definisi, lihat Definisi GraphQLApi.

Nama	Jenis	Deskripsi
format	string	Format definisi item.
parts	GraphQLApiPublicDefinitionPart[]	Daftar bagian definisi.

GraphQLApiPublicDefinitionPart

Objek

API untuk objek bagian definisi GraphQL.

Nama	Jenis	Deskripsi
path	string	Jalur bagian definisi API untuk GraphQL.
payload	string	API untuk payload bagian definisi GraphQL.
payloadType	PayloadType	Jenis payload.

ItemTag

Objek

Mewakili tag yang diterapkan pada item.

Nama	Jenis	Deskripsi
displayName	string	Nama dari tag.
id	string (uuid)	ID tag.

ItemType

Enumerasi

Jenis item. Jenis item tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
Dashboard	Dasbor PowerBI.
Report	Laporan PowerBI.
SemanticModel	Model semantik PowerBI.
PaginatedReport	Laporan paginasi PowerBI.
Datamart	Datamart PowerBI.
Lakehouse	Sebuah lakehouse.
Eventhouse	Sebuah rumah acara.
Environment	Lingkungan.
KQLDatabase	Database KQL.
KQLQueryset	Set kueri KQL.
KQLDashboard	Dasbor KQL.
DataPipeline	Alur data.
Notebook	Buku catatan.
SparkJobDefinition	Definisi pekerjaan spark.
MLExperiment	Eksperimen pembelajaran mesin.
MLModel	Model pembelajaran mesin.
Warehouse	Sebuah gudang.
Eventstream	Eventstream.
SQLEndpoint	Titik akhir SQL.
MirroredWarehouse	Sebuah gudang cermin.
MirroredDatabase	Database cermin.
Reflex	Sebuah Refleks.
GraphQLApi	API untuk item GraphQL.
MountedDataFactory	A MountedDataFactory.
SQLDatabase	Sebuah SQLDatabase.
CopyJob	Pekerjaan Penyalinan.
VariableLibrary	VariabelLibrary.
Dataflow	Aliran Data.
ApacheAirflowJob	An ApacheAirflowJob.
WarehouseSnapshot	Rekam jepret gudang.
DigitalTwinBuilder	Sebuah DigitalTwinBuilder.
DigitalTwinBuilderFlow	Alur Pembangun Kembar Digital.
MirroredAzureDatabricksCatalog	Katalog azure databricks cermin.
Map	Peta.
AnomalyDetector	Detektor Anomali.
UserDataFunction	Fungsi data pengguna.
GraphModel	Sebuah GraphModel.
GraphQuerySet	A Graph QuerySet.
SnowflakeDatabase	Snowflake Database untuk menyimpan tabel Iceberg yang dibuat dari akun Snowflake.
OperationsAgent	A OperationsAgent.
CosmosDBDatabase	Database Cosmos DB.

PayloadType

Enumerasi

Jenis payload bagian definisi. Jenis payload tambahan dapat ditambahkan dari waktu ke waktu.

Nilai	Deskripsi
InlineBase64	Dasar Sebaris 64.

Bagikan melalui

Items - Create GraphQLApi

Izin

Cakupan yang Didelegasikan yang Diperlukan

Keterbatasan

Identitas yang didukung Microsoft Entra

Antarmuka

Parameter URI

Isi Permintaan

Respons

Contoh

Create a API for GraphQL example

Permintaan sampel

Respon sampel

Create a GraphQLApi with public definition example

Permintaan sampel

Respon sampel

Definisi

CreateGraphQLApiRequest

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GraphQLApi

GraphQLApiPublicDefinition

GraphQLApiPublicDefinitionPart

ItemTag

ItemType

PayloadType