共用方式為

Items - Create GraphQLApi

服務:
GraphQLApi
API 版本:
v1

在指定的工作區中建立 GraphQL 專案的 API。

此 API 支援 長時間執行的作業 （LRO）。

若要使用公用定義建立 GraphQLApi 專案，請參閱 GraphQLApi 定義。

權限

呼叫端必須具有 參與者 工作區角色。

必要的委派範圍

GraphQLApi.ReadWrite.All 或 Item.ReadWrite.All

局限性

  • 若要建立 GraphQLApi，工作區必須位於支援的網狀架構容量上。 如需詳細資訊，請參閱：Microsoft Fabric 授權類型。

Microsoft Entra 支援的身分識別

此 API 支援本節中列出的Microsoft 身分識別。

身份 支援
使用者 是的
服務主體 和 受控識別 是的

介面

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

URI 參數

名稱 位於 必要 類型 Description
workspaceId
 path True

string (uuid)

工作區標識碼。

要求本文

名稱 必要 類型 Description
displayName True

string

GraphQL 顯示名稱的 API。 顯示名稱必須依照項目類型遵循命名規則。
definition

GraphQLApiPublicDefinition

GraphQL 公用定義的 API。
description

string

GraphQL 描述的 API。 長度上限為 256 個字元。
folderId

string (uuid)

資料夾識別碼。 如果未指定或 Null，則會使用工作區作為其資料夾來建立 GraphQL 的 API。

回應

名稱 類型 Description
201 Created

GraphQLApi

已成功建立
202 Accepted

要求已接受，GraphQLApi 布建正在進行中。

標題

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常見的錯誤碼：

  • InvalidItemType - 項目類型無效

  • ItemDisplayNameAlreadyInUse - 已使用項目顯示名稱。

  • CorruptedPayload - 提供的承載已損毀。

  • WorkspaceItemsLimitExceeded - 超過工作區專案限制。

範例

Create a API for GraphQL example
Create a GraphQLApi with public definition example

Create a API for GraphQL example

範例要求

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/GraphQLApis

{
  "displayName": "GraphQL 1",
  "description": "An API for GraphQL item description."
}

範例回覆

狀態碼:
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"
}
狀態碼:
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

範例要求

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

範例回覆

狀態碼:
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"
}
狀態碼:
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

定義

名稱 Description
CreateGraphQLApiRequest

建立 GraphQL 要求承載的 API。
ErrorRelatedResource

錯誤相關的資源詳細資料物件。
ErrorResponse

錯誤回應。
ErrorResponseDetails

錯誤回應詳細數據。
GraphQLApi

GraphQL 專案的 API。
GraphQLApiPublicDefinition

GraphQL 公用定義物件的 API。 若要建立定義，請參閱 GraphQLApi 定義。
GraphQLApiPublicDefinitionPart

GraphQL 定義部分物件的 API。
ItemTag

表示在專案上套用的標記。
ItemType

專案的型別。 可能會隨著時間新增其他項目類型。
PayloadType

定義元件承載的類型。 可能會隨著時間新增其他承載類型。

CreateGraphQLApiRequest

Object

建立 GraphQL 要求承載的 API。

名稱 類型 Description
definition

GraphQLApiPublicDefinition

GraphQL 公用定義的 API。
description

string

GraphQL 描述的 API。 長度上限為 256 個字元。
displayName

string

GraphQL 顯示名稱的 API。 顯示名稱必須依照項目類型遵循命名規則。
folderId

string (uuid)

資料夾識別碼。 如果未指定或 Null，則會使用工作區作為其資料夾來建立 GraphQL 的 API。

ErrorRelatedResource

Object

錯誤相關的資源詳細資料物件。

名稱 類型 Description
resourceId

string

發生錯誤的資源識別碼。
resourceType

string

發生錯誤的資源類型。

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
moreDetails

ErrorResponseDetails[]

其他錯誤詳細數據的清單。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。
requestId

string

與錯誤相關聯的要求標識碼。

ErrorResponseDetails

Object

錯誤回應詳細數據。

名稱 類型 Description
errorCode

string

提供錯誤狀況相關信息的特定標識碼，允許服務與其使用者之間的標準化通訊。
message

string

錯誤的人類可讀取表示法。
relatedResource

ErrorRelatedResource

錯誤相關的資源詳細數據。

GraphQLApi

Object

GraphQL 專案的 API。

名稱 類型 Description
description

string

專案描述。
displayName

string

項目顯示名稱。
folderId

string (uuid)

資料夾識別碼。
id

string (uuid)

項目標識碼。
tags

ItemTag[]

已套用標籤的清單。
type

ItemType

項目類型。
workspaceId

string (uuid)

工作區標識碼。

GraphQLApiPublicDefinition

Object

GraphQL 公用定義物件的 API。 若要建立定義，請參閱 GraphQLApi 定義。

名稱 類型 Description
format

string

項目定義的格式。
parts

GraphQLApiPublicDefinitionPart[]

定義元件的清單。

GraphQLApiPublicDefinitionPart

Object

GraphQL 定義部分物件的 API。

名稱 類型 Description
path

string

GraphQL 定義部分路徑的 API。
payload

string

GraphQL 定義部分承載的 API。
payloadType

PayloadType

承載類型。

ItemTag

Object

表示在專案上套用的標記。

名稱 類型 Description
displayName

string

標籤的名稱。
id

string (uuid)

標記標識碼。

ItemType

列舉型別

專案的型別。 可能會隨著時間新增其他項目類型。

值 Description
Dashboard

PowerBI 儀錶板。
Report

PowerBI 報表。
SemanticModel

PowerBI 語意模型。
PaginatedReport

PowerBI 編頁報表。
Datamart

PowerBI datamart。
Lakehouse

湖屋
Eventhouse

事件屋。
Environment

環境。
KQLDatabase

KQL 資料庫。
KQLQueryset

KQL 查詢集。
KQLDashboard

KQL 儀錶板。
DataPipeline

數據管線。
Notebook

筆記本。
SparkJobDefinition

Spark 作業定義。
MLExperiment

機器學習實驗。
MLModel

機器學習模型。
Warehouse

倉儲。
Eventstream

eventstream。
SQLEndpoint

SQL 端點。
MirroredWarehouse

鏡像倉儲。
MirroredDatabase

鏡像資料庫。
Reflex

反射。
GraphQLApi

GraphQL 專案的 API。
MountedDataFactory

MountedDataFactory。
SQLDatabase

SQLDatabase。
CopyJob

複製作業。
VariableLibrary

VariableLibrary。
Dataflow

數據流。
ApacheAirflowJob

ApacheAirflowJob。
WarehouseSnapshot

倉儲快照集。
DigitalTwinBuilder

DigitalTwinBuilder。
DigitalTwinBuilderFlow

數字對應項產生器流程。
MirroredAzureDatabricksCatalog

鏡像的 Azure databricks 目錄。
Map

一張地圖。
AnomalyDetector

異常偵測器。
UserDataFunction

使用者資料函數。
GraphModel

GraphModel 的 GraphModel。
GraphQuerySet

圖形 QuerySet。
SnowflakeDatabase

一個 Snowflake 資料庫，用來儲存由 Snowflake 帳號建立的 Iceberg 表格。
OperationsAgent

一個行動特工。
CosmosDBDatabase

一個 Cosmos 資料庫。

PayloadType

列舉型別

定義元件承載的類型。 可能會隨著時間新增其他承載類型。

值 Description
InlineBase64

內嵌基底 64。