Items - Update Warehouse Definition

บริการ:: Warehouse

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

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

การอัปเดตข้อกําหนดของคลังสินค้าไม่ส่งผลกระทบต่อป้ายชื่อระดับความลับ

Permissions

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

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

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

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

API นี้สนับสนุน Microsoft identitiesที่ระบุในส่วนนี้

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

อินเทอร์เฟซ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/updateDefinition

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/warehouses/{warehouseId}/updateDefinition?updateMetadata={updateMetadata}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
warehouseId	path	True	string (uuid)	รหัสคลังสินค้า
workspaceId	path	True	string (uuid)	ID พื้นที่ทํางาน
updateMetadata	query		boolean	เมื่อตั้งค่า `true` เป็น และ `.platform` ไฟล์ให้เป็นส่วนหนึ่งของข้อกําหนด เมตาดาต้าของรายการจะได้รับการอัปเดตโดยใช้เมตาดาต้าใน `.platform` ไฟล์

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

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

การตอบสนอง

ชื่อ	พิมพ์	คำอธิบาย
200 OK		คําขอเสร็จสมบูรณ์
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 - การดําเนินการไม่ได้รับการสนับสนุนสําหรับรายการที่ร้องขอ CorruptedPayload - ส่วนข้อมูลที่ให้มาเสียหาย

ตัวอย่าง

Update a warehouse public definition in DACPAC format example

Update a warehouse public definition in SQL project format example

Update a warehouse public definition in DACPAC format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "dacpac",
    "parts": [
      {
        "path": "definition.dacpac",
        "payload": "UEsDBBQAAAAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAGRlZmluaXRpb24uZGFjcGFj",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

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

Update a warehouse public definition in SQL project format example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff229/warehouses/5b218778-e7a5-4d73-8187-f10824047715/updateDefinition?updateMetadata=True

{
  "definition": {
    "format": "sqlproj",
    "parts": [
      {
        "path": "sqldw.sqlproj",
        "payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjxQcm9qZWN0IERlZmF1bHRUYXJnZXRzPSJCdWlsZCI+DQogIDxTZGs+TWljcm9zb2Z0LkJ1aWxkLlNxbC9TZGsNCiAgPC9TZGs+DQo8L1Byb2plY3Q+",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dbo/Tables/Table1.sql",
        "payload": "Q1JFQVRFIFRBQkxFIFtkYm9dLltUYWJsZTFdIChbSWRdIElOVCBOT1QgTlVMTCwgW05hbWVdIE5WQVJDSEFSKDEwMCkp",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".sharedqueries/query.sql",
        "payload": "U0VMRUNUIFtJZF0sIFtOYW1lXSBGUk9NIFtkYm9dLltUYWJsZTFd",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ewogICIkc2NoZW1hIjogImh0dHBzOi8vZGV2ZWxvcGVyLm1pY3Jvc29mdC5jb20vanNvbi1zY2hlbWFzL2ZhYnJpYy9naXRJbnRlZ3JhdGlvbi9wbGF0Zm9ybVByb3BlcnRpZXMvMi4wLjAvc2NoZW1hLmpzb24iLAogICJtZXRhZGF0YSI6IHsKICAgICJ0eXBlIjogIldhcmVob3VzZSIsCiAgICAiZGlzcGxheU5hbWUiOiAiV2FyZWhvdXNlXzEiCiAgfSwKICAiY29uZmlnIjogewogICAgInZlcnNpb24iOiAiMi4wIiwKICAgICJsb2dpY2FsSWQiOiAiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAwIgogIH0KfQ==",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

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

รหัสสถานะ:: 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	ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
UpdateWarehouseDefinitionRequest	อัปเดตส่วนข้อมูลการร้องขอข้อกําหนดสาธารณะของคลังสินค้า
WarehouseDefinition	ออบเจ็กต์ข้อกําหนดสาธารณะของคลังสินค้า โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับโครงสร้างของข้อกําหนดของคลังสินค้า
WarehouseDefinitionPart	ออบเจ็กต์ส่วนของคํานิยามคลังสินค้า

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

UpdateWarehouseDefinitionRequest

วัตถุ

อัปเดตส่วนข้อมูลการร้องขอข้อกําหนดสาธารณะของคลังสินค้า

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

WarehouseDefinition

วัตถุ

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

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

WarehouseDefinitionPart

วัตถุ

ออบเจ็กต์ส่วนของคํานิยามคลังสินค้า

ชื่อ	พิมพ์	คำอธิบาย
path	string	พาธส่วนของข้อกําหนดสาธารณะของคลังสินค้า
payload	string	ส่วนข้อกําหนดสาธารณะของคลังสินค้า
payloadType	PayloadType	ชนิดของส่วนข้อมูล