Del via

Domains - Create Domain

  • Referanse
Tjeneste:
Admin
API-versjon:
v1

Notat

Denne API-en er i forhåndsvisning.

Oppretter et nytt domene.

Tillatelser

Innringeren må være en fabric-administrator.

Nødvendige delegerte omfang

Tenant.ReadWrite.All.

Begrensninger

Maksimalt 25 forespørsler per minutt per hovedstol.

Microsoft Entra-støttede identiteter

Denne API-en støtter Microsoft -identiteter oppført i denne delen.

Identitet Støtte
Bruker Ja
tjenestekontohaver og administrerte identiteter Ja

Grensesnitt

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

Brødtekst for forespørsel

Navn Obligatorisk Type Beskrivelse
displayName True

string

Visningsnavnet for domenet. Visningsnavnet kan ikke inneholde mer enn 40 tegn.
description

string

Domenebeskrivelsen. Beskrivelsen kan ikke inneholde mer enn 256 tegn.
parentDomainId

string

uuid

Domenets overordnede objekt-ID.

Svar

Navn Type Beskrivelse
201 Created

Domain

Domenet ble opprettet.
Other Status Codes

ErrorResponse

Vanlige feilkoder:

  • EntityNotFound – Opprett domene mislyktes fordi overordnet domene-ID ikke ble funnet.

  • EntityConflict – Opprett domene mislyktes fordi visningsnavnet for domenet allerede finnes.

  • InvalidInput – ugyldig overordnet domene-ID.

Eksempler

Create a domain example

Eksempelforespørsel

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

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

Definisjoner

Navn Beskrivelse
ContributorsScopeType

Bidragsyteromfanget. Flere bidragsyteromfang kan legges til over tid.
CreateDomainRequest

Forespørselsnyttelasten for å opprette et domene eller underdomene.
Domain

Representerer et domene eller underdomene.
ErrorRelatedResource

Objektet for feilrelaterte ressursdetaljer.
ErrorResponse

Feilsvaret.
ErrorResponseDetails

Feilsvardetaljene.

ContributorsScopeType

Opplisting

Bidragsyteromfanget. Flere bidragsyteromfang kan legges til over tid.

Verdi Beskrivelse
AdminsOnly

Bare leier- og domeneadministratorer.
AllTenant

Alle tenantens brukere.
SpecificUsersAndGroups

Bestemte brukere og grupper.

CreateDomainRequest

Object

Forespørselsnyttelasten for å opprette et domene eller underdomene.

Navn Type Beskrivelse
description

string

Domenebeskrivelsen. Beskrivelsen kan ikke inneholde mer enn 256 tegn.
displayName

string

Visningsnavnet for domenet. Visningsnavnet kan ikke inneholde mer enn 40 tegn.
parentDomainId

string

uuid

Domenets overordnede objekt-ID.

Domain

Object

Representerer et domene eller underdomene.

Navn Type Beskrivelse
contributorsScope

ContributorsScopeType

Området for domenebidragsytere.
description

string

Beskrivelsen av domenet.
displayName

string

Navnet på domenet.
id

string

uuid

Objekt-ID-en for domenet.
parentDomainId

string

uuid

Domenets overordnede objekt-ID.

ErrorRelatedResource

Object

Objektet for feilrelaterte ressursdetaljer.

Navn Type Beskrivelse
resourceId

string

Ressurs-ID-en som er involvert i feilen.
resourceType

string

Typen ressurs som er involvert i feilen.

ErrorResponse

Object

Feilsvaret.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
moreDetails

ErrorResponseDetails[]

Liste over flere feildetaljer.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.
requestId

string

ID for forespørselen som er knyttet til feilen.

ErrorResponseDetails

Object

Feilsvardetaljene.

Navn Type Beskrivelse
errorCode

string

En bestemt identifikator som gir informasjon om en feilbetingelse, noe som gir standardisert kommunikasjon mellom tjenesten og brukerne.
message

string

En menneskelig lesbar representasjon av feilen.
relatedResource

ErrorRelatedResource

Feilrelaterte ressursdetaljer.