Domains - Create Domain (preview)
สร้างโดเมนใหม่ (ตัวอย่าง)
Note
API ตัวอย่างนี้จะถูกยกเลิกการสนับสนุนในวันที่ 31 มีนาคม 2026 และแทนที่ด้วยเวอร์ชันที่เสถียรซึ่งมีอยู่ที่นี่ เวอร์ชันใหม่จะทําให้เกิดการเปลี่ยนแปลงที่เสียหายและไม่สามารถเข้ากันได้แบบย้อนหลัง
เมื่อเรียกใช้ API นี้ ผู้เรียกต้องระบุ true เป็นค่าสําหรับพารามิเตอร์ previewคิวรี
ประกาศการเลิกใช้
มีการนําพารามิเตอร์ preview คิวรีใหม่เข้ามาเพื่ออํานวยความสะดวกในการเปลี่ยนนี้:
- ในขณะนี้
previewพารามิเตอร์คิวรีมีค่าเริ่มต้นเป็นtrue - ตั้งค่าของ
previewพารามิเตอร์คิวรีเพื่อใช้falseเวอร์ชันที่วางจําหน่ายของ API นี้ - เริ่มต้นวันที่ 31 มีนาคม 2026 ค่าเริ่มต้นสําหรับ
previewจะเปลี่ยนเป็นfalse
เราขอแนะนําให้โยกย้ายการรวมของคุณเพื่อใช้เวอร์ชันที่วางจําหน่ายโดยเร็วที่สุดโดยการระบุ false สําหรับ preview พารามิเตอร์คิวรี (ค่าเริ่มต้นสําหรับ preview พารามิเตอร์คิวรีจะถูกตั้งค่าเป็น false วันที่ไม่สนับสนุน API)
มีการเปลี่ยนแปลงที่เข้ากันไม่ได้ต่อไปนี้ถูกนํามาใช้ในรุ่นการเผยแพร่:
- คุณสมบัติ
contributorsScopeการตอบกลับถูกลบ
สิทธิ์
ผู้เรียกต้องเป็นผู้ดูแลระบบ Fabric
จําเป็นต้องมีขอบเขตที่ได้รับมอบสิทธิ์
Tenant.Read.All หรือ Tenant.ReadWrite.All
Limitations
สูงสุด 25 คําขอต่อหนึ่งนาทีต่อเงินต้น
ข้อมูลประจําตัวที่สนับสนุนของ Microsoft Entra
API นี้สนับสนุนข้อมูลประจําตัวของ Microsoft แสดงรายการในส่วนนี้
| Identity | สนับสนุน |
|---|---|
| ผู้ใช้ | ใช่ |
| บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ | ใช่ |
อิน เทอร์ เฟซ
POST https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}
พารามิเตอร์ URI
| ชื่อ | ใน | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|---|
|
preview
|
query | True |
boolean |
พารามิเตอร์นี้ระบุเวอร์ชันของ API ที่จะใช้ ตั้งค่าเพื่อใช้ |
เนื้อความของคำขอ
| ชื่อ | จำเป็น | พิมพ์ | คำอธิบาย |
|---|---|---|---|
| displayName | True |
string |
ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ |
| description |
string |
คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว |
|
| parentDomainId |
string (uuid) |
ID ออบเจ็กต์หลักของโดเมน |
การตอบสนอง
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| 201 Created |
สร้างโดเมนเรียบร้อยแล้ว |
|
| Other Status Codes |
รหัสข้อผิดพลาดทั่วไป:
|
ตัวอย่าง
Create a domain example
คำขอตัวอย่าง
POST https://api.fabric.microsoft.com/v1/admin/domains?preview=True
{
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}
คำตอบตัวอย่าง
{
"id": "9eba6944-daff-4441-b9b5-630ce34238fd",
"displayName": "Finance",
"description": "This domain is used for identifying financial data and reports.",
"parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df",
"contributorsScope": "AllTenant"
}
คำจำกัดความ
| ชื่อ | คำอธิบาย |
|---|---|
|
Contributors |
ขอบเขตผู้สนับสนุน ขอบเขตผู้สนับสนุนเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป |
|
Create |
คําขอส่วนข้อมูลสําหรับการสร้างโดเมนหรือโดเมนย่อย |
|
Domain |
|
|
Error |
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
Error |
การตอบสนองข้อผิดพลาด |
|
Error |
รายละเอียดการตอบสนองข้อผิดพลาด |
ContributorsScopeType
ขอบเขตผู้สนับสนุน ขอบเขตผู้สนับสนุนเพิ่มเติมอาจเพิ่มเมื่อเวลาผ่านไป
| ค่า | คำอธิบาย |
|---|---|
| AllTenant |
ผู้ใช้ของผู้เช่าทั้งหมด |
| SpecificUsersAndGroups |
ผู้ใช้และกลุ่มที่เฉพาะเจาะจง |
| AdminsOnly |
เฉพาะผู้ดูแลระบบผู้เช่าและโดเมนเท่านั้น |
CreateDomainRequest
คําขอส่วนข้อมูลสําหรับการสร้างโดเมนหรือโดเมนย่อย
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| description |
string |
คําอธิบายโดเมน คําอธิบายต้องมีอักขระไม่เกิน 256 ตัว |
| displayName |
string |
ชื่อโดเมนที่แสดง ชื่อที่แสดงต้องไม่เกิน 40 อักขระ |
| parentDomainId |
string (uuid) |
ID ออบเจ็กต์หลักของโดเมน |
DomainPreview
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| contributorsScope |
ขอบเขตผู้สนับสนุนโดเมน |
|
| description |
string |
คําอธิบายของโดเมน |
| displayName |
string |
ชื่อของโดเมน |
| id |
string (uuid) |
ID ออบเจ็กต์ของโดเมน |
| parentDomainId |
string (uuid) |
ID ออบเจ็กต์หลักของโดเมน |
ErrorRelatedResource
ออบเจ็กต์รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| resourceId |
string |
ID ทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
| resourceType |
string |
ชนิดของทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponse
การตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| moreDetails |
รายการรายละเอียดข้อผิดพลาดเพิ่มเติม |
|
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |
|
| requestId |
string |
รหัสของคําขอที่เกี่ยวข้องกับข้อผิดพลาด |
ErrorResponseDetails
รายละเอียดการตอบสนองข้อผิดพลาด
| ชื่อ | พิมพ์ | คำอธิบาย |
|---|---|---|
| errorCode |
string |
ตัวระบุเฉพาะที่ให้ข้อมูลเกี่ยวกับเงื่อนไขข้อผิดพลาด ทําให้สามารถสื่อสารได้มาตรฐานระหว่างบริการของเรากับผู้ใช้ |
| message |
string |
การแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ |
| relatedResource |
รายละเอียดทรัพยากรที่เกี่ยวข้องกับข้อผิดพลาด |