Domains - Update Domain

บริการ:: Admin

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

อัปเดตข้อมูลโดเมนที่ระบุ

Note

API นี้เป็นเวอร์ชันที่วางจําหน่ายของเวอร์ชันตัวอย่างเนื่องจากไม่ได้รับการสนับสนุนในวันที่ 31 มีนาคม 2026 เมื่อเรียกใช้ API นี้ - ผู้เรียกต้องตั้งค่าพารามิเตอร์ preview คิวรีเป็นค่า false

Permissions

ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric

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

Tenant.ReadWrite.All.

Limitations

สูงสุด 25 คําขอต่อหนึ่งนาทีต่อเงินต้น

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

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

Identity	Support
User	Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ	Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}?preview={preview}

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

ชื่อ	ใน	จำเป็น	พิมพ์	คำอธิบาย
domainId	path	True	string (uuid)	ID โดเมน
preview	query	True	boolean	พารามิเตอร์นี้ระบุเวอร์ชันของ API ที่จะใช้ ตั้งค่าเพื่อใช้ `false` เวอร์ชันที่วางจําหน่าย

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

ชื่อ	พิมพ์	คำอธิบาย
defaultLabelId	string (uuid)	ป้ายชื่อระดับความลับเริ่มต้นของโดเมน เมื่อต้องการลบ defaultLabelId ออกจากโดเมน ให้ตั้งค่าเป็น UUID ที่ว่างเปล่าในคําขอของคุณ: "00000000-00000-0000-0000-000000000"
description	string	คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว
displayName	string	ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ

ชื่อ

พิมพ์

คำอธิบาย

defaultLabelId

string (uuid)

ป้ายชื่อระดับความลับเริ่มต้นของโดเมน

เมื่อต้องการลบ defaultLabelId ออกจากโดเมน ให้ตั้งค่าเป็น UUID ที่ว่างเปล่าในคําขอของคุณ: "00000000-00000-0000-0000-000000000"

description

string

คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว

displayName

string

ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ

การตอบสนอง

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

200 OK

ชื่อ	พิมพ์	คำอธิบาย
200 OK	Domain	คําขอเสร็จสมบูรณ์
429 Too Many Requests	ErrorResponse	เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ `Retry-After` ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม ส่วนหัว Retry-After: integer
Other Status Codes	ErrorResponse	รหัสข้อผิดพลาดทั่วไป: DomainNotFound - ไม่พบโดเมนที่ให้มา EntityConflict - การอัปเดตโดเมนล้มเหลวเนื่องจากมีชื่อที่แสดงโดเมนอยู่แล้ว UnknownError - เกิดข้อผิดพลาด

Domain

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

429 Too Many Requests

ErrorResponse

เกินขีดจํากัดอัตราการบริการ เซิร์ฟเวอร์จะส่งกลับ Retry-After ส่วนหัวที่ระบุ ภายในไม่กี่วินาที ระยะเวลาที่ไคลเอ็นต์ต้องรอก่อนที่จะส่งคําขอเพิ่มเติม

ส่วนหัว

Retry-After: integer

Other Status Codes

ErrorResponse

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

DomainNotFound - ไม่พบโดเมนที่ให้มา
EntityConflict - การอัปเดตโดเมนล้มเหลวเนื่องจากมีชื่อที่แสดงโดเมนอยู่แล้ว
UnknownError - เกิดข้อผิดพลาด

ตัวอย่าง

Update a domain example

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

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f?preview=false

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

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

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

{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

คำจำกัดความ

ชื่อ	คำอธิบาย
Domain
ErrorParameter	พารามิเตอร์ที่มีโครงสร้างให้บริบทที่สามารถอ่านได้ด้วยเครื่องเพิ่มเติมเกี่ยวกับข้อผิดพลาด
ErrorRelatedResource	ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
ErrorResponse	การตอบสนองข้อผิดพลาด
ErrorResponseDetails	รายละเอียดการตอบสนองข้อผิดพลาด
UpdateDomainRequest

Domain

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
defaultLabelId	string (uuid)	ป้ายชื่อระดับความลับเริ่มต้นของโดเมน
description	string	คําอธิบายของโดเมน
displayName	string	ชื่อของโดเมน
id	string (uuid)	ID ออบเจ็กต์ของโดเมน
parentDomainId	string (uuid)	ID ออบเจ็กต์หลักของโดเมน

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	รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด

UpdateDomainRequest

วัตถุ

ชื่อ	พิมพ์	คำอธิบาย
defaultLabelId	string (uuid)	ป้ายชื่อระดับความลับเริ่มต้นของโดเมน เมื่อต้องการลบ defaultLabelId ออกจากโดเมน ให้ตั้งค่าเป็น UUID ที่ว่างเปล่าในคําขอของคุณ: "00000000-00000-0000-0000-000000000"
description	string	คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว
displayName	string	ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ

ชื่อ

พิมพ์

คำอธิบาย

defaultLabelId

string (uuid)

ป้ายชื่อระดับความลับเริ่มต้นของโดเมน

description

string

คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว

displayName

string

ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ