Freigeben über

Domains - Create Domain

Dienst:
Admin
API-Version:
v1

Erstellt eine neue Domäne.

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.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

POST https://api.fabric.microsoft.com/v1/admin/domains?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.

Anforderungstext

Name Erforderlich Typ Beschreibung
displayName True

string

Der Anzeigename der Domäne. Der Anzeigename darf nicht mehr als 40 Zeichen enthalten.
description

string

Die Domänenbeschreibung. Die Beschreibung darf nicht mehr als 256 Zeichen enthalten.
parentDomainId

string (uuid)

Die id des übergeordneten Domänenobjekts.

Antworten

Name Typ Beschreibung
201 Created

Domain

Die Domäne wurde erfolgreich erstellt.
Other Status Codes

ErrorResponse

Häufige Fehlercodes:

  • EntityNotFound – Fehler beim Erstellen einer Domäne, da die übergeordnete Domänen-ID nicht gefunden wurde.

  • EntityConflict – Fehler beim Erstellen einer Domäne, da der Anzeigename der Domäne bereits vorhanden ist.

  • InvalidInput - Ungültige übergeordnete Domänen-ID.

Beispiele

Create a domain example

Beispielanforderung

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

{
  "displayName": "Finance",
  "description": "This domain is used for identifying financial data and reports.",
  "parentDomainId": "5f6552c3-816c-43e7-8289-842f8b35f9df"
}

Beispiel für eine Antwort

Statuscode:
201 
{
  "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"
}

Definitionen

Name Beschreibung
CreateDomainRequest

Die Anforderungsnutzlast zum Erstellen einer Domäne oder Unterdomäne.
Domain
ErrorRelatedResource

Das Fehlerbezogene Ressourcendetails-Objekt.
ErrorResponse

Die Fehlerantwort.
ErrorResponseDetails

Die Fehlerantwortdetails.

CreateDomainRequest

Objekt

Die Anforderungsnutzlast zum Erstellen einer Domäne oder Unterdomäne.

Name Typ Beschreibung
description

string

Die Domänenbeschreibung. Die Beschreibung darf nicht mehr als 256 Zeichen enthalten.
displayName

string

Der Anzeigename der Domäne. Der Anzeigename darf nicht mehr als 40 Zeichen enthalten.
parentDomainId

string (uuid)

Die id des übergeordneten Domänenobjekts.

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.

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.