Items - Get SQL Database Definition

บริการ:: SQLDatabase

เวอร์ชัน API:: v1

แสดงข้อกําหนดสาธารณะของฐานข้อมูล SQL ที่ระบุ
API นี้สนับสนุน การดําเนินการที่ใช้เวลานาน (LRO)

เมื่อคุณได้รับคําจํากัดความสาธารณะของฐานข้อมูล SQL ป้ายชื่อระดับความลับไม่ได้เป็นส่วนหนึ่งของข้อกําหนด

สิทธิ์

ผู้เรียกต้องมีสิทธิ์ ในการอ่านและเขียน สําหรับฐานข้อมูล SQL

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

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

การจำกัด

ในการเรียกใช้ข้อกําหนดของรายการฐานข้อมูล SQL ที่ได้รับการป้องกันโดยป้ายชื่อระดับความลับที่เข้ารหัส ผู้โทรต้องมีสิทธิ์การใช้งานเพียงพอที่จะลบป้ายชื่อตามที่กําหนดค่าไว้ใน Microsoft Purview

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

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

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

อินเตอร์เฟซ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition

ด้วยพารามิเตอร์ที่เลือกได้:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/sqlDatabases/{sqlDatabaseId}/getDefinition?format={format}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
sqlDatabaseId	path	True	string (uuid)	ID ฐานข้อมูล SQL
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
format	query		string	รูปแบบของข้อกําหนดสาธารณะของฐานข้อมูล SQL รูปแบบที่ได้รับการสนับสนุน: `dacpac` และ`sqlproj` ถ้าไม่ได้ระบุ `dacpac` รูปแบบ ไว้ จะถูกใช้

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK	SQLDatabaseDefinitionResponse	คําขอเสร็จสมบูรณ์
202 Accepted		คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด ส่วนหัว Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: OperationNotSupportedForItem - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ

ตัวอย่าง

Get a Digital Twin Builder Flow public definition example

คำขอตัวอย่าง

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/sqlDatabases/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/getDefinition

คำตอบตัวอย่าง

รหัสสถานะ:: 200

{
  "definition": {
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "ew0KICAibGFrZWhvdXNlSWQiOiAiYjliNWQzNmYtNDQ0NS00MDNiLWFjODctMDE2YjFjZDIwMjExIg0KfQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

รหัสสถานะ:: 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

คำจำกัดความ

ชื่อ	คำอธิบาย
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
PayloadType	ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
SQLDatabaseDefinition	วัตถุข้อกําหนดสาธารณะของฐานข้อมูล SQL โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของฐานข้อมูล SQL
SQLDatabaseDefinitionResponse	การตอบสนองข้อกําหนดสาธารณะของฐานข้อมูล SQL
SQLDatabasePublicDefinitionPart	ออบเจ็กต์ส่วนของข้อกําหนดฐานข้อมูล SQL

ErrorParameter

วัตถุ

พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด

ชื่อ	พิมพ์	คำอธิบาย
message	string	คําอธิบายที่มนุษย์สามารถอ่านได้ของความหมายของพารามิเตอร์
name	string	ตัวระบุพารามิเตอร์
value	string	ค่าพารามิเตอร์

ErrorRelatedResource

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
resourceId	string	ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
resourceType	string	ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponse

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
isRetriable	boolean	เมื่อเป็นจริง สามารถลองคําขอใหม่ได้ ใช้ส่วนหัวการตอบสนอง `Retry-After` เพื่อกําหนดความล่าช้า ถ้ามี
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
moreDetails	ErrorResponseDetails[]	รายการรายละเอียดข้อผิดพลาดเพิ่มเติม
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
requestId	string (uuid)	รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด

ErrorResponseDetails

วัตถุ

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

ชื่อ	พิมพ์	คำอธิบาย
errorCode	string	ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้
message	string	การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้
parameters	ErrorParameter[]	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
relatedResource	ErrorRelatedResource	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

PayloadType

การแจงนับ

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

ค่า	คำอธิบาย
InlineBase64	ฐานแบบอินไลน์ 64

SQLDatabaseDefinition

วัตถุ

วัตถุข้อกําหนดสาธารณะของฐานข้อมูล SQL โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของฐานข้อมูล SQL

ชื่อ	พิมพ์	คำอธิบาย
format	string	รูปแบบของข้อกําหนดของฐานข้อมูล SQL รูปแบบที่ได้รับการสนับสนุน: `dacpac` และ`sqlproj` ถ้าไม่ได้ระบุ `dacpac` รูปแบบ ไว้ จะถูกใช้
parts	SQLDatabasePublicDefinitionPart[]	รายการของส่วนข้อกําหนด

SQLDatabaseDefinitionResponse

วัตถุ

การตอบสนองข้อกําหนดสาธารณะของฐานข้อมูล SQL

ชื่อ	พิมพ์	คำอธิบาย
definition	SQLDatabaseDefinition	วัตถุข้อกําหนดสาธารณะของฐานข้อมูล SQL โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของฐานข้อมูล SQL

SQLDatabasePublicDefinitionPart

วัตถุ

ออบเจ็กต์ส่วนของข้อกําหนดฐานข้อมูล SQL

ชื่อ	พิมพ์	คำอธิบาย
path	string	เส้นทางส่วนคําจํากัดความสาธารณะของฐานข้อมูล SQL ส่วนขยายเนื้อหาฐานข้อมูล SQL ที่สนับสนุน: `.dacpac` สําหรับ`dacpac`รูปแบบ `.sqlproj.sql` สําหรับ`sqlproj`รูปแบบ
payload	string	ส่วนข้อกําหนดสาธารณะของฐานข้อมูล SQL
payloadType	PayloadType	ชนิดของส่วนข้อมูล