แชร์ผ่าน

Items - Get Notebook Definition

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

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

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

สิทธิ์การได้รับอนุญาต

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

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

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

ข้อจำกัด

API นี้ถูกบล็อกสําหรับสมุดบันทึกที่มีป้ายชื่อระดับความลับที่เข้ารหัสลับไว้

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

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

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

ส่วนติดต่อ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition
ด้วยพารามิเตอร์ที่เลือกได้: 
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/notebooks/{notebookId}/getDefinition?format={format}

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

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

string (uuid)

ID สมุดบันทึก
workspaceId
 path True

string (uuid)

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

string

รูปแบบของข้อกําหนดสาธารณะของสมุดบันทึก รูปแบบที่ได้รับการสนับสนุน: ipynb และfabricGitSource ถ้าไม่ได้ระบุ fabricGitSource รูปแบบ ไว้ จะถูกใช้

การตอบสนอง

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

NotebookDefinitionResponse

คําขอเสร็จสมบูรณ์
202 Accepted

คําขอได้รับการยอมรับ กําลังดําเนินการเรียกข้อกําหนด

ส่วนหัว

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

ErrorResponse

รหัสข้อผิดพลาดทั่วไป:

  • OperationNotSupportedForItem - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ

ตัวอย่าง

Get a notebook definition in fabricGitSource format example
Get a notebook definition in ipynb format example

Get a notebook definition in fabricGitSource format example

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

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

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

รหัสสถานะ:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.py",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
รหัสสถานะ:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Get a notebook definition in ipynb format example

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

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/notebooks/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition?format=ipynb

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

รหัสสถานะ:
200 
{
  "definition": {
    "parts": [
      {
        "path": "notebook-content.ipynb",
        "payload": "IyBGYWJyaWMgbm90ZWJv..5ndWUiOiJweXRob24ifX19",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}
รหัสสถานะ:
202 
Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

คำจำกัดความ

ชื่อ คำอธิบาย
ErrorRelatedResource

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

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

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

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

วัตถุข้อกําหนดของสมุดบันทึก
NotebookDefinitionResponse

การตอบสนองข้อกําหนดสาธารณะของสมุดบันทึก
PayloadType

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

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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

NotebookDefinition

ออบเจ็กต์

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

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

string

รูปแบบของข้อกําหนดของสมุดบันทึก รูปแบบที่ได้รับการสนับสนุน: ipynb และfabricGitSource ถ้าไม่ได้ระบุ fabricGitSource รูปแบบ ไว้ จะถูกใช้
parts

NotebookDefinitionPart[]

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

NotebookDefinitionPart

ออบเจ็กต์

วัตถุข้อกําหนดของสมุดบันทึก

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

string

เส้นทางของสมุดบันทึก ส่วนขยายเนื้อหาของสมุดบันทึกที่ได้รับการสนับสนุน: สําหรับรูปแบบ, , .ipynbipynb, .py สําหรับ.scalaรูปแบบ .r.sqlfabricGitSource
payload

string

ส่วนข้อมูลของสมุดบันทึก
payloadType

PayloadType

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

NotebookDefinitionResponse

ออบเจ็กต์

การตอบสนองข้อกําหนดสาธารณะของสมุดบันทึก

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

NotebookDefinition

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

PayloadType

การแจงนับ

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

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

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