แชร์ผ่าน

Items - Create GraphQLApi

บริการ:
GraphQLApi
เวอร์ชัน API:
v1

สร้าง API สําหรับรายการ GraphQL ในพื้นที่ทํางานที่ระบุ

API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

หากต้องการสร้างรายการ GraphQLApi ที่มีคําจํากัดความสาธารณะ โปรดดูที่คําจํากัดความ GraphQLApi

สิทธิ์

ผู้เรียกต้องมีบทบาทพื้นที่ทํางานผู้สนับสนุน

จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์

GraphQLApi.ReadWrite.All หรือ Item.ReadWrite.All

ขีด จำกัด

  • หากต้องการสร้าง GraphQLApi พื้นที่ทํางานจะต้องอยู่บนความจุ Fabric ที่ได้รับการสนับสนุน สําหรับข้อมูลเพิ่มเติม ดูที่: สิทธิ์การใช้งาน Microsoft Fabric

ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra

API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้

เอกลักษณ์ สนับสนุน
ผู้ใช้ ใช่
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ ใช่

อิน เทอร์ เฟซ

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

พารามิเตอร์ URI

ชื่อ ใน จำเป็น พิมพ์ คำอธิบาย
workspaceId
 path True

string (uuid)

ID พื้นที่ทํางาน

เนื้อความของคำขอ

ชื่อ จำเป็น พิมพ์ คำอธิบาย
displayName True

string

API สําหรับชื่อที่แสดงของ GraphQL ชื่อที่แสดงต้องเป็นไปตามกฎการตั้งชื่อตามชนิดหน่วยข้อมูล
definition

GraphQLApiPublicDefinition

API สําหรับข้อกําหนดสาธารณะของ GraphQL
description

string

API สําหรับคําอธิบาย GraphQL ความยาวสูงสุดคือ 256 อักขระ
folderId

string (uuid)

ID โฟลเดอร์ ถ้าไม่ได้ระบุหรือ null API สําหรับ GraphQL จะถูกสร้างขึ้นด้วยพื้นที่ทํางานเป็นโฟลเดอร์

การตอบสนอง

ชื่อ พิมพ์ คำอธิบาย
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

สร้าง API สําหรับส่วนข้อมูลคําขอ GraphQL
ErrorRelatedResource

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse

การตอบสนองข้อผิดพลาด
ErrorResponseDetails

รายละเอียดการตอบสนองข้อผิดพลาด
GraphQLApi

API สําหรับรายการ GraphQL
GraphQLApiPublicDefinition

API สําหรับออบเจ็กต์ข้อกําหนดสาธารณะของ GraphQL หากต้องการสร้างข้อกําหนด โปรดดูคํานิยาม GraphQLApi
GraphQLApiPublicDefinitionPart

API สําหรับออบเจ็กต์ส่วนของข้อกําหนด GraphQL
ItemTag

แสดงแท็กที่ใช้กับรายการ
ItemType

ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
PayloadType

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

CreateGraphQLApiRequest

วัตถุ

สร้าง API สําหรับส่วนข้อมูลคําขอ GraphQL

ชื่อ พิมพ์ คำอธิบาย
definition

GraphQLApiPublicDefinition

API สําหรับข้อกําหนดสาธารณะของ GraphQL
description

string

API สําหรับคําอธิบาย GraphQL ความยาวสูงสุดคือ 256 อักขระ
displayName

string

API สําหรับชื่อที่แสดงของ GraphQL ชื่อที่แสดงต้องเป็นไปตามกฎการตั้งชื่อตามชนิดหน่วยข้อมูล
folderId

string (uuid)

ID โฟลเดอร์ ถ้าไม่ได้ระบุหรือ null API สําหรับ GraphQL จะถูกสร้างขึ้นด้วยพื้นที่ทํางานเป็นโฟลเดอร์

ErrorRelatedResource

วัตถุ

ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
resourceId

string

ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType

string

ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

การตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails

ErrorResponseDetails[]

รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId

string

รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

รายละเอียดการตอบสนองข้อผิดพลาด

ชื่อ พิมพ์ คำอธิบาย
errorCode

string

ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message

string

การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
relatedResource

ErrorRelatedResource

รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

GraphQLApi

วัตถุ

API สําหรับรายการ GraphQL

ชื่อ พิมพ์ คำอธิบาย
description

string

คําอธิบายสินค้า
displayName

string

ชื่อที่แสดงของรายการ
folderId

string (uuid)

ID โฟลเดอร์
id

string (uuid)

รหัสสินค้า
tags

ItemTag[]

รายการของแท็กที่ใช้
type

ItemType

ชนิดหน่วยข้อมูล
workspaceId

string (uuid)

ID พื้นที่ทํางาน

GraphQLApiPublicDefinition

วัตถุ

API สําหรับออบเจ็กต์ข้อกําหนดสาธารณะของ GraphQL หากต้องการสร้างข้อกําหนด โปรดดูคํานิยาม GraphQLApi

ชื่อ พิมพ์ คำอธิบาย
format

string

รูปแบบของข้อกําหนดหน่วยข้อมูล
parts

GraphQLApiPublicDefinitionPart[]

รายการของส่วนข้อกําหนด

GraphQLApiPublicDefinitionPart

วัตถุ

API สําหรับออบเจ็กต์ส่วนของข้อกําหนด GraphQL

ชื่อ พิมพ์ คำอธิบาย
path

string

API สําหรับเส้นทางส่วนของข้อกําหนด GraphQL
payload

string

API สําหรับส่วนข้อกําหนด GraphQL
payloadType

PayloadType

ชนิดของส่วนข้อมูล

ItemTag

วัตถุ

แสดงแท็กที่ใช้กับรายการ

ชื่อ พิมพ์ คำอธิบาย
displayName

string

ชื่อของแท็ก
id

string (uuid)

ID แท็ก

ItemType

การแจงนับ

ชนิดของสินค้า คุณสามารถเพิ่มชนิดหน่วยข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
Dashboard

แดชบอร์ด PowerBI
Report

รายงาน PowerBI
SemanticModel

แบบจําลองความหมายของ PowerBI
PaginatedReport

รายงานที่มีการแบ่งหน้าของ PowerBI
Datamart

Datamart ของ PowerBI
Lakehouse

เลคเฮ้าส์
Eventhouse

อาคารจัดงาน
Environment

สภาพแวดล้อม
KQLDatabase

ฐานข้อมูล KQL
KQLQueryset

ชุดคิวรี KQL
KQLDashboard

แดชบอร์ด KQL
DataPipeline

ไปป์ไลน์ข้อมูล
Notebook

โน๊ตบุ๊ค
SparkJobDefinition

ข้อกําหนดงานแบบประกายไฟ
MLExperiment

การทดลองการเรียนรู้ของเครื่อง
MLModel

แบบจําลองการเรียนรู้ของเครื่อง
Warehouse

คลังสินค้า
Eventstream

เหตุการณ์กระแสข้อมูล
SQLEndpoint

จุดสิ้นสุด SQL
MirroredWarehouse

คลังสินค้าที่มิเรอร์
MirroredDatabase

ฐานข้อมูลที่มิเรอร์
Reflex

รีเฟล็กซ์
GraphQLApi

API สําหรับรายการ GraphQL
MountedDataFactory

เมาท์ DataFactory
SQLDatabase

SQLDatabase
CopyJob

งานคัดลอก
VariableLibrary

VariableLibrary
Dataflow

กระแสข้อมูล
ApacheAirflowJob

ApacheAirflowJob
WarehouseSnapshot

สแนปช็อตของคลังสินค้า
DigitalTwinBuilder

DigitalTwinBuilder
DigitalTwinBuilderFlow

โฟลว์ Digital Twin Builder
MirroredAzureDatabricksCatalog

แค็ตตาล็อก azure databricks ที่มิเรอร์
Map

แผนที่.
AnomalyDetector

การตรวจหาความผิดปกติ
UserDataFunction

ฟังก์ชันข้อมูลผู้ใช้
GraphModel

GraphModel
GraphQuerySet

ชุดคิวรีกราฟ
SnowflakeDatabase

ฐานข้อมูล Snowflake เพื่อจัดเก็บตาราง Iceberg ที่สร้างขึ้นจากบัญชี Snowflake
OperationsAgent

OperationsAgent
CosmosDBDatabase

ฐานข้อมูล Cosmos DB

PayloadType

การแจงนับ

ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป

ค่า คำอธิบาย
InlineBase64

ฐานแบบอินไลน์ 64