通过

Items - Create GraphQLApi

服务:
GraphQLApi
API 版本:
v1

在指定的工作区中创建 GraphQL 项的 API。

此 API 支持 长时间运行的作（LRO）。

若要使用公共定义创建 GraphQLApi 项，请参阅 GraphQLApi 定义。

权限

调用方必须具有 参与者 工作区角色。

所需的委派范围

GraphQLApi.ReadWrite.All 或 Item.ReadWrite.All

局限性

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份 支持
用户 是的
服务主体 和 托管标识 是的

接口

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

URI 参数

名称 在 必需 类型 说明
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 必需 类型 说明
displayName True

string

GraphQL 显示名称的 API。 显示名称必须遵循项类型的命名规则。
definition

GraphQLApiPublicDefinition

GraphQL 公共定义的 API。
description

string

GraphQL 的 API 说明。 最大长度为 256 个字符。
folderId

string (uuid)

文件夹 ID。 如果未指定或为 null，则会使用工作区作为其文件夹创建 GraphQL 的 API。

响应

名称 类型 说明
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

定义

名称 说明
CreateGraphQLApiRequest

为 GraphQL 请求有效负载创建 API。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
GraphQLApi

GraphQL 项的 API。
GraphQLApiPublicDefinition

用于 GraphQL 公共定义对象的 API。 若要创建定义，请参阅 GraphQLApi 定义。
GraphQLApiPublicDefinitionPart

用于 GraphQL 定义部件对象的 API。
ItemTag

表示应用于项的标记。
ItemType

项的类型。 可能会随着时间的推移添加其他项类型。
PayloadType

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

CreateGraphQLApiRequest

Object

为 GraphQL 请求有效负载创建 API。

名称 类型 说明
definition

GraphQLApiPublicDefinition

GraphQL 公共定义的 API。
description

string

GraphQL 的 API 说明。 最大长度为 256 个字符。
displayName

string

GraphQL 显示名称的 API。 显示名称必须遵循项类型的命名规则。
folderId

string (uuid)

文件夹 ID。 如果未指定或为 null，则会使用工作区作为其文件夹创建 GraphQL 的 API。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

GraphQLApi

Object

GraphQL 项的 API。

名称 类型 说明
description

string

项说明。
displayName

string

项显示名称。
folderId

string (uuid)

文件夹 ID。
id

string (uuid)

项 ID。
tags

ItemTag[]

已应用的标记列表。
type

ItemType

项类型。
workspaceId

string (uuid)

工作区 ID。

GraphQLApiPublicDefinition

Object

用于 GraphQL 公共定义对象的 API。 若要创建定义，请参阅 GraphQLApi 定义。

名称 类型 说明
format

string

项定义的格式。
parts

GraphQLApiPublicDefinitionPart[]

定义部件的列表。

GraphQLApiPublicDefinitionPart

Object

用于 GraphQL 定义部件对象的 API。

名称 类型 说明
path

string

GraphQL 定义部件路径的 API。
payload

string

GraphQL 定义部件有效负载的 API。
payloadType

PayloadType

有效负载类型。

ItemTag

Object

表示应用于项的标记。

名称 类型 说明
displayName

string

标签的名称。
id

string (uuid)

标记 ID。

ItemType

枚举

项的类型。 可能会随着时间的推移添加其他项类型。

值 说明
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

事件流。
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

用户数据函数。

PayloadType

枚举

定义部件有效负载的类型。 可能会随着时间的推移添加其他有效负载类型。

值 说明
InlineBase64

内联基线 64。