แชร์ผ่าน

Domains - List Domains (preview)

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

ส่งกลับข้อมูลสําหรับโดเมนทั้งหมด (ตัวอย่าง)

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 การสนับสนุน
ผู้ใช้ Yes
บริการหลักและข้อมูลประจําตัว ที่มีการจัดการ Yes

อิน เทอร์ เฟซ

GET https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}
ด้วยพารามิเตอร์ที่เลือกได้: 
GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}&preview={preview}

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

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

boolean

พารามิเตอร์นี้ระบุเวอร์ชันของ API ที่จะใช้ ตั้งค่าเพื่อใช้trueเวอร์ชันตัวอย่างที่อธิบายไว้ในหน้านี้ หรือเพื่อใช้falseเวอร์ชันเผยแพร่โดยละเอียดที่นี่ เริ่มต้นวันที่ 31 มีนาคม 2026 ค่าเริ่มต้นสําหรับ preview จะเปลี่ยนเป็นfalse
nonEmptyOnly
 query

boolean

เมื่อเป็นจริง จะส่งกลับโดเมนที่มีพื้นที่ทํางานอย่างน้อยหนึ่งรายการเท่านั้น ค่าเริ่มต้น: เท็จ

การตอบสนอง

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

DomainsResponsePreview

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

ErrorResponse

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

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

ตัวอย่าง

Get all non-empty domains example
Get info for all domains example

Get all non-empty domains example

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

GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly=True&preview=True

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

รหัสสถานะ:
200 
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    }
  ]
}

Get info for all domains example

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

GET https://api.fabric.microsoft.com/v1/admin/domains?preview=True

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

รหัสสถานะ:
200 
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AdminsOnly"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null,
      "contributorsScope": "SpecificUsersAndGroups"
    },
    {
      "id": "17df435d-9efd-48c1-a937-7d6fd70ab26a",
      "displayName": "AdminsOnly",
      "description": "Admins only",
      "parentDomainId": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
      "contributorsScope": "AllTenant"
    },
    {
      "id": "fb765fe3-d404-4f24-9d67-5916449c4c50",
      "displayName": "Root",
      "description": "",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    },
    {
      "id": "bda31be4-7efe-4272-8b85-e1b2ff0f0592",
      "displayName": "Legal",
      "description": "This domain is used for identifying legal data and reports.",
      "parentDomainId": null,
      "contributorsScope": "AllTenant"
    }
  ]
}

คำจำกัดความ

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

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

นี่คือตัวตัดการตอบสนองสําหรับรายการของโดเมนทั้งหมด
ErrorRelatedResource

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

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

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

ContributorsScopeType

การแจงนับ

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

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

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

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

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

DomainPreview

ออบเจ็กต์
ชื่อ พิมพ์ คำอธิบาย
contributorsScope

ContributorsScopeType

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

string

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

string

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

string (uuid)

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

string (uuid)

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

DomainsResponsePreview

ออบเจ็กต์

นี่คือตัวตัดการตอบสนองสําหรับรายการของโดเมนทั้งหมด

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

DomainPreview[]

รายการโดเมน

ErrorRelatedResource

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponse

ออบเจ็กต์

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

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

string

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

string

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

ErrorResponseDetails[]

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

ErrorRelatedResource

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

string

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

ErrorResponseDetails

ออบเจ็กต์

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

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

string

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

string

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

ErrorRelatedResource

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