Delen via

Domains - Create Domain

  • Referentie
Service:
Admin
API-versie:
v1

Notitie

Deze API is in preview.

Hiermee maakt u een nieuw domein.

Machtigingen

De beller moet een Fabric-beheerder zijn.

Vereiste gedelegeerde bereiken

Tenant.ReadWrite.All.

Beperkingen

Maximaal 25 aanvragen per minuut per principal.

Door Microsoft Entra ondersteunde identiteiten

Deze API ondersteunt de Microsoft -identiteiten vermeld in deze sectie.

Identiteit Steunen
Gebruiker Ja
service-principal en beheerde identiteiten Ja

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains

Aanvraagbody

Name Vereist Type Description
displayName True

string

De weergavenaam van het domein. De weergavenaam mag niet meer dan 40 tekens bevatten.
description

string

De domeinbeschrijving. De beschrijving mag niet meer dan 256 tekens bevatten.
parentDomainId

string

uuid

De bovenliggende object-id van het domein.

Antwoorden

Name Type Description
201 Created

Domain

Het domein is gemaakt.
Other Status Codes

ErrorResponse

Veelvoorkomende foutcodes:

  • EntityNotFound : het maken van een domein is mislukt omdat de bovenliggende domein-id niet is gevonden.

  • EntityConflict : het maken van een domein is mislukt omdat de weergavenaam van het domein al bestaat.

  • InvalidInput : ongeldige bovenliggende domein-id.

Voorbeelden

Create a domain example

Voorbeeldaanvraag

POST https://api.fabric.microsoft.com/v1/admin/domains

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

Voorbeeldrespons

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",
  "contributorsScope": "AllTenant"
}

Definities

Name Description
ContributorsScopeType

Het bereik van de inzender. Er kunnen in de loop van de tijd extra inzenderbereiken worden toegevoegd.
CreateDomainRequest

De nettolading van de aanvraag voor het maken van een domein of subdomein.
Domain

Vertegenwoordigt een domein of subdomein.
ErrorRelatedResource

Het foutgerelateerde resourcedetailsobject.
ErrorResponse

Het foutbericht.
ErrorResponseDetails

De details van het foutbericht.

ContributorsScopeType

Inventarisatie

Het bereik van de inzender. Er kunnen in de loop van de tijd extra inzenderbereiken worden toegevoegd.

Waarde Description
AdminsOnly

Alleen tenant- en domeinbeheerders.
AllTenant

Alle gebruikers van de tenant.
SpecificUsersAndGroups

Specifieke gebruikers en groepen.

CreateDomainRequest

Object

De nettolading van de aanvraag voor het maken van een domein of subdomein.

Name Type Description
description

string

De domeinbeschrijving. De beschrijving mag niet meer dan 256 tekens bevatten.
displayName

string

De weergavenaam van het domein. De weergavenaam mag niet meer dan 40 tekens bevatten.
parentDomainId

string

uuid

De bovenliggende object-id van het domein.

Domain

Object

Vertegenwoordigt een domein of subdomein.

Name Type Description
contributorsScope

ContributorsScopeType

Het bereik van domeinbijdragers.
description

string

De beschrijving van het domein.
displayName

string

De naam van het domein.
id

string

uuid

De domeinobject-id.
parentDomainId

string

uuid

De bovenliggende object-id van het domein.

ErrorRelatedResource

Object

Het foutgerelateerde resourcedetailsobject.

Name Type Description
resourceId

string

De resource-id die betrokken is bij de fout.
resourceType

string

Het type resource dat betrokken is bij de fout.

ErrorResponse

Object

Het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
moreDetails

ErrorResponseDetails[]

Lijst met aanvullende foutdetails.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.
requestId

string

Id van de aanvraag die is gekoppeld aan de fout.

ErrorResponseDetails

Object

De details van het foutbericht.

Name Type Description
errorCode

string

Een specifieke id die informatie biedt over een foutvoorwaarde, waardoor gestandaardiseerde communicatie tussen onze service en de gebruikers mogelijk is.
message

string

Een leesbare weergave van de fout.
relatedResource

ErrorRelatedResource

De foutgerelateerde resourcedetails.