Items - Update Environment Definition

บริการ:

Environment

เวอร์ชัน API:

v1

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

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

สิทธิ์

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

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

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

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

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

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

ส่วนติดต่อ

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/updateDefinition

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

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

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

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

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

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

การตอบสนอง

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

ตัวอย่าง

Update a environment definition example

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

HTTP

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

{
  "definition": {
    "parts": [
      {
        "path": "Libraries/CustomLibraries/samplelibrary.jar",
        "payload": "eyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplepython.py",
        "payload": "FyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/samplewheel-0.18.0-py2.py3-none-any.whl",
        "payload": "LyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/CustomLibraries/sampleR.tar.gz",
        "payload": "ZyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Libraries/PublicLibraries/environment.yml",
        "payload": "IyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": "Setting/Sparkcompute.yml",
        "payload": "GyJuYmZvcm1hdCI6N..",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

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

รหัสสถานะ:

200

รหัสสถานะ:

202

Location: https://api.fabric.microsoft.com/v1/operations/427f6c34-b64e-4ee4-8ea5-b533c0e203ef
x-ms-operation-id: 427f6c34-b64e-4ee4-8ea5-b533c0e203ef
Retry-After: 30

คำจำกัดความ

ชื่อ	คำอธิบาย
EnvironmentDefinition	วัตถุข้อกําหนดสาธารณะของสภาพแวดล้อม โปรดดู บทความนี้ สําหรับรายละเอียดเพิ่มเติมเกี่ยวกับวิธีการสร้างคําจํากัดความสาธารณะของสภาพแวดล้อม
EnvironmentDefinitionPart	ออบเจ็กต์ส่วนของข้อกําหนดสภาพแวดล้อม
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
PayloadType	ชนิดของส่วนข้อกําหนดส่วนข้อมูล อาจมีการเพิ่มชนิดของส่วนข้อมูลเพิ่มเติมเมื่อเวลาผ่านไป
UpdateEnvironmentDefinitionRequest	อัปเดตส่วนข้อมูลการร้องขอข้อกําหนดสาธารณะของสภาพแวดล้อม

EnvironmentDefinition

ออบเจ็กต์

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

ชื่อ	พิมพ์	คำอธิบาย
format	string	รูปแบบของข้อกําหนดสภาพแวดล้อม
parts	EnvironmentDefinitionPart[]	รายการของส่วนข้อกําหนด

EnvironmentDefinitionPart

ออบเจ็กต์

ออบเจ็กต์ส่วนของข้อกําหนดสภาพแวดล้อม

ชื่อ	พิมพ์	คำอธิบาย
path	string	เส้นทางของส่วนสภาพแวดล้อม
payload	string	ส่วนข้อมูลของสภาพแวดล้อม
payloadType	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	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

PayloadType

การแจงนับ

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

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

UpdateEnvironmentDefinitionRequest

ออบเจ็กต์

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

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