Freigeben über

Domains - Get Domain (preview)

Dienst:
Admin
API-Version:
v1

Gibt die angegebenen Domäneninformationen (Vorschau) zurück.

Hinweis

Diese Vorschau-API wird am 31. März 2026 veraltet und durch eine stabile Version ersetzt, die hier verfügbar ist. Die neue Version führt zu wichtigen Änderungen und ist nicht abwärtskompatibel. Beim Aufrufen dieser API müssen Aufrufer als Wert für den Abfrageparameter trueangebenpreview.

Veraltete Hinweise

Es wurde ein neuer Abfrageparameter preview eingeführt, um diesen Übergang zu erleichtern:

  • Der preview Abfrageparameter ist derzeit standardmäßig auf true.
  • Legen Sie den Wert des preview Abfrageparameters fest, um die Releaseversion dieser API zu false verwenden.
  • Ab dem 31. März 2026 ändert sich der Standardwert preview in false.

Es wird empfohlen, Ihre Integration so schnell wie möglich zu migrieren, um die Releaseversion zu verwenden, indem Sie den false Abfrageparameter angeben preview (der Standardwert für den Abfrageparameter wird auf preview das Veraltetsdatum der false API festgelegt).

Die folgenden inkompatiblen Änderungen wurden in der Releaseversion eingeführt:

  • Die Antworteigenschaft contributorsScope wurde entfernt.

Erlaubnisse

Der Aufrufer muss ein Fabric-Administrator sein.

Erforderliche delegierte Bereiche

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

Einschränkungen

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.

Identität Support
Benutzer Yes
Service Principal und Verwaltete Identitäten Yes

Schnittstelle

GET https://api.fabric.microsoft.com/v1/admin/domains/{domainId}?preview={preview}

URI-Parameter

Name In Erforderlich Typ Beschreibung
domainId
 path True

string (uuid)

Die Domänen-ID.
preview
 query True

boolean

Dieser Parameter gibt an, welche Version der API verwendet werden soll. Legen Sie fest, dass true die auf dieser Seite beschriebene Vorschauversion verwendet werden soll, oder um false die hier beschriebene Version zu verwenden. Ab dem 31. März 2026 ändert sich der Standardwert preview in false.

Antworten

Name Typ Beschreibung
200 OK

DomainPreview

Die Anforderung wurde erfolgreich abgeschlossen.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • DomainNotFound – Die bereitgestellte Domäne wurde nicht gefunden.

  • UnknownError – Ein Fehler ist aufgetreten.

Beispiele

Get a domain example

Beispielanforderung

GET https://api.fabric.microsoft.com/v1/admin/domains/f2f6a374-789e-4d1d-9cc7-6e0b934fc529?preview=True

Beispiel für eine Antwort

Statuscode:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Definitionen

Name Beschreibung
ContributorsScopeType

Der Bereich "Mitwirkender". Zusätzliche Mitwirkendebereiche können im Laufe der Zeit hinzugefügt werden.
DomainPreview
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.

ContributorsScopeType

Enumeration

Der Bereich "Mitwirkender". Zusätzliche Mitwirkendebereiche können im Laufe der Zeit hinzugefügt werden.

Wert Beschreibung
AllTenant

Alle Benutzer des Mandanten.
SpecificUsersAndGroups

Bestimmte Benutzer und Gruppen.
AdminsOnly

Nur Mandanten- und Domänenadministratoren.

DomainPreview

Objekt
Name Typ Beschreibung
contributorsScope

ContributorsScopeType

Der Bereich der Domänenmitwirkenden.
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.

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.