แชร์ผ่าน

Domains - Update Domain

  • การอ้างอิง
บริการ:
Admin
เวอร์ชัน API:
v1

โน้ต

API นี้อยู่ในตัวอย่าง

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

สิทธิ์

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

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

Tenant.ReadWrite.All

ขีด จำกัด

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

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

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

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

อิน เทอร์ เฟซ

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

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

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

string

uuid

ID โดเมน

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

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

ContributorsScopeType

ขอบเขตผู้สนับสนุนโดเมน
description

string

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

string

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

การตอบสนอง

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

Domain

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

ErrorResponse

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

  • UnknownError - เกิดข้อผิดพลาด

  • EntityConflict - การอัปเดตโดเมนล้มเหลวเนื่องจากมีชื่อที่แสดงโดเมนอยู่แล้ว

ตัวอย่าง

Update a domain example

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

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

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

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

รหัสสถานะ:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

คำจำกัดความ

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

ขอบเขตผู้สนับสนุน ขอบเขตผู้สนับสนุนเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
Domain

แสดงโดเมนหรือโดเมนย่อย
ErrorRelatedResource

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

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

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

คําขอส่วนข้อมูลสําหรับการอัปเดตโดเมน

ContributorsScopeType

การแจงนับ

ขอบเขตผู้สนับสนุน ขอบเขตผู้สนับสนุนเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป

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

เฉพาะผู้ดูแลระบบผู้เช่าและโดเมนเท่านั้น
AllTenant

ผู้ใช้ของผู้เช่าทั้งหมด
SpecificUsersAndGroups

ผู้ใช้และกลุ่มที่เฉพาะเจาะจง

Domain

ออบเจ็กต์

แสดงโดเมนหรือโดเมนย่อย

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

ContributorsScopeType

ขอบเขตผู้สนับสนุนโดเมน
description

string

คําอธิบายของโดเมน
displayName

string

ชื่อของโดเมน
id

string

uuid

ID ออบเจ็กต์ของโดเมน
parentDomainId

string

uuid

ID ออบเจ็กต์หลักของโดเมน

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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

UpdateDomainRequest

ออบเจ็กต์

คําขอส่วนข้อมูลสําหรับการอัปเดตโดเมน

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

ContributorsScopeType

ขอบเขตผู้สนับสนุนโดเมน
description

string

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

string

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