Domains - Create Domain (preview)

Tjeneste:

Admin

API-version:

v1

Opretter et nyt domæne (prøveversion).

Notat

Denne prøveversions-API frarådes den 31. marts 2026 og erstattes af en stabil version, der er tilgængelig her. Den nye version introducerer banebrydende ændringer og er ikke bagudkompatibel. Når du kalder denne API, skal kaldere angive true som værdien for forespørgselsparameteren preview.

Meddelelse om udfasning

Der er introduceret en ny forespørgselsparameter preview for at lette denne overgang:

• Forespørgselsparameteren preview er truei øjeblikket som standard .
• Angiv værdien af forespørgselsparameteren preview til at false bruge versionen af denne API.
• Fra og med den 31. marts 2026 ændres standardværdien for preview til false.

Det anbefales, at du overfører din integration for at bruge versionen Version så hurtigt som muligt ved at angive false for forespørgselsparameteren preview (standardværdien for forespørgselsparameteren preview angives til false på API'ens udfasningsdato).

Følgende inkompatible ændringer blev introduceret i versionen:

• Egenskaben contributorsScope Response blev fjernet.

Tilladelser

Den, der ringer op, skal være Fabric-administrator.

Påkrævede delegerede områder

Tenant.Read.All eller Tenant.ReadWrite.All.

Begrænsninger

Maksimalt 25 anmodninger pr. minut pr. hovedkonto.

Microsoft Entra-understøttede identiteter

Denne API understøtter de Microsoft -identiteter, der angivet i dette afsnit.

Identitet	Støtte
Bruger	Yes
tjenesteprincipal og administrerede identiteter	Yes

Grænseflade

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

URI-parametre

Name	I	Påkrævet	Type	Beskrivelse
preview	query	True	boolean	Denne parameter angiver, hvilken version af API'en der skal bruges. Angiv til at true bruge den prøveversion, der er beskrevet på denne side, eller til at false bruge den version, der er beskrevet her. Fra og med den 31. marts 2026 ændres standardværdien for preview til false.

Brødtekst for anmodning

Name	Påkrævet	Type	Beskrivelse
displayName	True	string	Det viste domænenavn. Det viste navn må ikke indeholde mere end 40 tegn.
description		string	Domænebeskrivelsen. Beskrivelsen må ikke indeholde mere end 256 tegn.
parentDomainId		string (uuid)	Det overordnede objekt-id for domænet.

Svar

Name	Type	Beskrivelse
201 Created	DomainPreview	Domænet blev oprettet.
429 Too Many Requests	ErrorResponse	Grænsen for tjenestetakst blev overskredet. Serveren returnerer en Retry-After header, der angiver, i sekunder, hvor længe klienten skal vente, før der sendes yderligere anmodninger. Headere Retry-After: integer
Other Status Codes	ErrorResponse	Almindelige fejlkoder: EntityNotFound – Oprettelse af domæne mislykkedes, fordi det overordnede domæne-id ikke blev fundet. EntityConflict – Oprettelse af domæne mislykkedes, fordi det viste navn for domænet allerede findes. InvalidInput – Ugyldigt overordnet domæne-id.

Eksempler

Create a domain example

Eksempelanmodning

HTTP

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

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

Eksempelsvar

Statuskode:

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"
}

Definitioner

Name	Beskrivelse
ContributorsScopeType	Bidragyderområdet. Yderligere bidragyderområder kan tilføjes over tid.
CreateDomainRequest	Nyttedata for anmodning om oprettelse af et domæne eller underdomæne.
DomainPreview
ErrorRelatedResource	Objektet med fejlrelaterede ressourceoplysninger.
ErrorResponse	Fejlsvaret.
ErrorResponseDetails	Oplysninger om fejlsvar.

ContributorsScopeType

Optælling

Bidragyderområdet. Yderligere bidragyderområder kan tilføjes over tid.

Værdi	Beskrivelse
AllTenant	Alle lejerens brugere.
SpecificUsersAndGroups	Specifikke brugere og grupper.
AdminsOnly	Kun lejer- og domæneadministratorer.

CreateDomainRequest

Objekt

Nyttedata for anmodning om oprettelse af et domæne eller underdomæne.

Name	Type	Beskrivelse
description	string	Domænebeskrivelsen. Beskrivelsen må ikke indeholde mere end 256 tegn.
displayName	string	Det viste domænenavn. Det viste navn må ikke indeholde mere end 40 tegn.
parentDomainId	string (uuid)	Det overordnede objekt-id for domænet.

DomainPreview

Objekt

Name	Type	Beskrivelse
contributorsScope	ContributorsScopeType	Området for domænebidragydere.
description	string	Beskrivelsen af domænet.
displayName	string	Navnet på domænet.
id	string (uuid)	Domæneobjekt-id'et.
parentDomainId	string (uuid)	Det overordnede objekt-id for domænet.

ErrorRelatedResource

Objekt

Objektet med fejlrelaterede ressourceoplysninger.

Name	Type	Beskrivelse
resourceId	string	Det ressource-id, der er involveret i fejlen.
resourceType	string	Typen af ressource, der er involveret i fejlen.

ErrorResponse

Objekt

Fejlsvaret.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
moreDetails	ErrorResponseDetails[]	Liste over yderligere oplysninger om fejl.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.
requestId	string (uuid)	Id'et for den anmodning, der er knyttet til fejlen.

ErrorResponseDetails

Objekt

Oplysninger om fejlsvar.

Name	Type	Beskrivelse
errorCode	string	Et bestemt id, der indeholder oplysninger om en fejltilstand, der muliggør standardiseret kommunikation mellem vores tjeneste og dens brugere.
message	string	En menneskelig læsbar gengivelse af fejlen.
relatedResource	ErrorRelatedResource	De fejlrelaterede ressourceoplysninger.