Domains - Create Domain

Palvelu:: Admin

Ohjelmointirajapinnan versio:: v1

Luo uuden toimialueen.

Note

Tämä ohjelmointirajapinta on esikatseluversion julkaisuversio, jonka on määrä vanhentua 31.3.2026. Kun kutsut tätä ohjelmointirajapintaa - soittajien on määritettävä kyselyparametri preview -arvoksi false

Permissions

Soittajan on oltava Fabric-järjestelmänvalvoja.

Vaaditut delegoidut vaikutusalueet

Tenant.ReadWrite.All.

Limitations

Enintään 25 pyyntöä minuuttia kohti per päänimi.

Microsoft Entran tukemat käyttäjätiedot

Tämä ohjelmointirajapinta tukee tässä osiossa lueteltuja Microsoft -käyttäjätietoja.

Identity	Support
User	Yes
palvelun päänimen ja Hallittujen käyttäjätietojen	Yes

Interface

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

URI-parametrit

Nimi	Kohteessa	Pakollinen	Tyyppi	Description
preview	query	True	boolean	Tämä parametri määrittää, mitä ohjelmointirajapinnan versiota käytetään. Määritä käyttämään `false` julkaisuversiota.

Pyynnön leipäteksti

Nimi	Pakollinen	Tyyppi	Description
displayName	True	string	Toimialueen näyttönimi. Näyttönimi voi sisältää enintään 40 merkkiä.
description		string	Toimialueen kuvaus. Kuvauksessa voi olla enintään 256 merkkiä.
parentDomainId		string (uuid)	Toimialueen pääobjektitunnus.

Vastaukset

Nimi Tyyppi Description

201 Created

Nimi	Tyyppi	Description
201 Created	Domain	Toimialueen luominen onnistui.
429 Too Many Requests	ErrorResponse	Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka `Retry-After` ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään. Otsikot Retry-After: integer
Other Status Codes	ErrorResponse	Yleiset virhekoodit: EntityNotFound – Toimialueen luominen epäonnistui, koska päätoimialuetunnusta ei löytynyt. EntityConflict – Toimialueen luominen epäonnistui, koska toimialueen näyttönimi on jo olemassa. InvalidInput – Virheellinen päätoimialuetunnus.

Domain

Toimialueen luominen onnistui.

429 Too Many Requests

ErrorResponse

Palveluhinnan raja ylitettiin. Palvelin palauttaa otsikon, joka Retry-After ilmaisee sekunteina, kuinka kauan asiakkaan on odotettava, ennen kuin lisäpyynnöt lähetetään.

Otsikot

Retry-After: integer

Other Status Codes

ErrorResponse

Yleiset virhekoodit:

EntityNotFound – Toimialueen luominen epäonnistui, koska päätoimialuetunnusta ei löytynyt.
EntityConflict – Toimialueen luominen epäonnistui, koska toimialueen näyttönimi on jo olemassa.
InvalidInput – Virheellinen päätoimialuetunnus.

Esimerkit

Create a domain example

Mallipyyntö

HTTP

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

Mallivastaus

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

Määritelmät

Nimi	Description
CreateDomainRequest	Pyynnön tiedot toimialueen tai alitoimialueen luomista varten.
Domain
ErrorRelatedResource	Virheeseen liittyvä resurssitieto-objekti.
ErrorResponse	Virhevastaus.
ErrorResponseDetails	Virheen vastauksen tiedot.

CreateDomainRequest

Kohde

Pyynnön tiedot toimialueen tai alitoimialueen luomista varten.

Nimi	Tyyppi	Description
description	string	Toimialueen kuvaus. Kuvauksessa voi olla enintään 256 merkkiä.
displayName	string	Toimialueen näyttönimi. Näyttönimi voi sisältää enintään 40 merkkiä.
parentDomainId	string (uuid)	Toimialueen pääobjektitunnus.

Domain

Kohde

Nimi	Tyyppi	Description
defaultLabelId	string (uuid)	Toimialueen oletusarvoinen luottamuksellisuustunniste.
description	string	Toimialueen kuvaus.
displayName	string	Toimialueen nimi.
id	string (uuid)	Toimialueen objektitunnus.
parentDomainId	string (uuid)	Toimialueen pääobjektitunnus.

ErrorRelatedResource

Kohde

Virheeseen liittyvä resurssitieto-objekti.

Nimi	Tyyppi	Description
resourceId	string	Virheestä liittyvä resurssitunnus.
resourceType	string	Virheestä liittyvän resurssin tyyppi.

ErrorResponse

Kohde

Virhevastaus.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
isRetriable	boolean	Kun arvo on tosi, pyyntöä voidaan yrittää uudelleen. Määritä viive vastausotsikon `Retry-After` avulla, jos se on käytettävissä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
moreDetails	ErrorResponseDetails[]	Luettelo virheiden lisätiedoista.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.
requestId	string (uuid)	Virheeseen liittyvän pyynnön tunnus.

ErrorResponseDetails

Kohde

Virheen vastauksen tiedot.

Nimi	Tyyppi	Description
errorCode	string	Tietty tunniste, joka antaa tietoja virheehdosta ja mahdollistaa standardoidun tietoliikenteen palvelumme ja sen käyttäjien välillä.
message	string	Ihmisen luettavissa oleva esitys virheestä.
relatedResource	ErrorRelatedResource	Virheisiin liittyvät resurssitiedot.