Udostępnij przez

Domains - List Domains

Usługa:
Admin
Wersja interfejsu API:
v1

Zwraca informacje dla wszystkich domen.

Note

Ten interfejs API jest wersją wersji zapoznawczej z powodu wycofania się 31 marca 2026 r. Podczas wywoływania tego interfejsu API obiekt wywołujący musi ustawić parametr preview zapytania na wartość false

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej.

Wymagane zakresy delegowane

Tenant.Read.All lub Tenant.ReadWrite.All.

Limitations

Maksymalna liczba żądań 25 na minutę na jednostkę.

Tożsamości obsługiwane przez Microsoft Entra

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}
Z parametrami opcjonalnymi: 
GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}&preview={preview}

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
preview
 query True

boolean

Ten parametr określa, która wersja interfejsu API ma być używana. Ustaw wartość na , aby false używać wersji wydania.
nonEmptyOnly
 query

boolean

W przypadku wartości true zwracane są tylko domeny, które mają co najmniej jeden obszar roboczy zawierający element. Wartość domyślna: false.

Odpowiedzi

Nazwa Typ Opis
200 OK

DomainsResponse

Żądanie zostało ukończone pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • UnknownError — wystąpił błąd.

Przykłady

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

Get all non-empty domains example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
200 
{
  "domains": [
    {
      "id": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff",
      "displayName": "Finance",
      "description": "This domain is used for identifying financial data and reports.",
      "parentDomainId": null,
      "defaultLabelId": "95c04e91-79d3-4287-b282-dbd62e11f566"
    },
    {
      "id": "b0bca781-003c-4041-b1c4-f94d34ba76d4",
      "displayName": "Human resources",
      "description": "",
      "parentDomainId": null
    },
    {
      "id": "6af5a1b6-bc4c-4c0a-b60d-30c68e6e3034",
      "displayName": "HR Sales",
      "description": "",
      "parentDomainId": "bc23d4c6-cc92-4eb6-bcb5-0ff98429bbff"
    },
    {
      "id": "6c00e8eb-51d4-46f7-8b90-7e98520ea7a0",
      "displayName": "Marketing",
      "parentDomainId": null
    }
  ]
}

Get info for all domains example

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
Domain
DomainsResponse

Jest to otoka odpowiedzi dla listy wszystkich domen.
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

Domain

Objekt
Nazwa Typ Opis
defaultLabelId

string (uuid)

Domyślna etykieta poufności domeny.
description

string

Opis domeny.
displayName

string

Nazwa domeny.
id

string (uuid)

Identyfikator obiektu domeny.
parentDomainId

string (uuid)

Identyfikator obiektu nadrzędnego domeny.

DomainsResponse

Objekt

Jest to otoka odpowiedzi dla listy wszystkich domen.

Nazwa Typ Opis
domains

Domain[]

Lista domen.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.