Freigeben über

Domains - List Domains

Dienst:
Admin
API-Version:
v1

Gibt Informationen für alle Domänen zurück.

Note

Diese API ist eine Version einer Vorschauversion, die am 31. März 2026 veraltet ist. Beim Aufrufen dieser API müssen Aufrufer den Abfrageparameter preview auf den Wert festlegen. false

Permissions

Der Aufrufer muss ein Fabric-Administrator sein.

Erforderliche delegierte Bereiche

Tenant.Read.All oder Tenant.ReadWrite.All.

Limitations

Maximal 25 Anforderungen pro Minute pro Prinzipal.

Von Microsoft Entra unterstützte Identitäten

Diese API unterstützt die in diesem Abschnitt aufgeführten Microsoft Identitäten.

Identity Support
User Yes
Service Principal und Verwaltete Identitäten Yes

Interface

GET https://api.fabric.microsoft.com/v1/admin/domains?preview={preview}
Mit optionalen Parametern: 
GET https://api.fabric.microsoft.com/v1/admin/domains?nonEmptyOnly={nonEmptyOnly}&preview={preview}

URI-Parameter

Name In Erforderlich Typ Beschreibung
preview
 query True

boolean

Dieser Parameter gibt an, welche Version der API verwendet werden soll. Legen Sie diese Einstellung fest, false um die Version zu verwenden.
nonEmptyOnly
 query

boolean

Gibt nur Domänen zurück, die mindestens einen Arbeitsbereich enthalten, der ein Element enthält. Standardwert: false.

Antworten

Name Typ Beschreibung
200 OK

DomainsResponse

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

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

Get all non-empty domains example

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
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
    }
  ]
}

Definitionen

Name Beschreibung
Domain
DomainsResponse

Dies ist ein Antwortwrapper für eine Liste aller Domänen.
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.

Domain

Objekt
Name Typ Beschreibung
defaultLabelId

string (uuid)

Die Standardmäßige Vertraulichkeitsbezeichnung der Domäne.
description

string

Die Beschreibung der Domäne.
displayName

string

Der Name der Domäne.
id

string (uuid)

Die Domänenobjekt-ID.
parentDomainId

string (uuid)

Die id des übergeordneten Domänenobjekts.

DomainsResponse

Objekt

Dies ist ein Antwortwrapper für eine Liste aller Domänen.

Name Typ Beschreibung
domains

Domain[]

Die Liste der Domänen.

ErrorRelatedResource

Objekt

Das Fehlerbezogene Ressourcendetails-Objekt.

Name Typ Beschreibung
resourceId

string

Die Ressourcen-ID, die an dem Fehler beteiligt ist.
resourceType

string

Der Typ der Ressource, die an dem Fehler beteiligt ist.

ErrorResponse

Objekt

Die Fehlerantwort.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
moreDetails

ErrorResponseDetails[]

Liste der zusätzlichen Fehlerdetails.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.
requestId

string

ID der Anforderung, die dem Fehler zugeordnet ist.

ErrorResponseDetails

Objekt

Die Fehlerantwortdetails.

Name Typ Beschreibung
errorCode

string

Ein bestimmter Bezeichner, der Informationen über eine Fehlerbedingung bereitstellt und eine standardisierte Kommunikation zwischen unserem Dienst und seinen Benutzern ermöglicht.
message

string

Eine lesbare Darstellung des Fehlers.
relatedResource

ErrorRelatedResource

Die fehlerbezogenen Ressourcendetails.