Udostępnij przez

Domains - Create Domain

Usługa:
Admin
Wersja interfejsu API:
v1

Tworzy nową domenę.

Note

Ten interfejs API jest wersją wersji zapoznawczej z powodu wycofania się 31 marca 2026 r. Podczas wywoływania tego interfejsu API obiekt wywołujący musi ustawić parametr preview zapytania na wartość false

Permissions

Obiekt wywołujący musi być administratorem sieci szkieletowej.

Wymagane zakresy delegowane

Tenant.ReadWrite.All.

Limitations

Maksymalna liczba żądań 25 na minutę na jednostkę.

Tożsamości obsługiwane przez firmę Microsoft

To API obsługuje tożsamości Microsoft wymienione w tej sekcji.

Identity Support
User Yes
Główne usługi i Tożsamości zarządzane Yes

Interface

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
preview
 query True

boolean

Ten parametr określa, która wersja interfejsu API ma być używana. Ustaw wartość na , aby false używać wersji wydania.

Treść żądania

Nazwa Wymagane Typ Opis
displayName True

string

Nazwa wyświetlana domeny. Nazwa wyświetlana nie może zawierać więcej niż 40 znaków.
description

string

Opis domeny. Opis nie może zawierać więcej niż 256 znaków.
parentDomainId

string (uuid)

Identyfikator obiektu nadrzędnego domeny.

Odpowiedzi

Nazwa Typ Opis
201 Created

Domain

Pomyślnie utworzono domenę.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • EntityNotFound — tworzenie domeny nie powiodło się, ponieważ nie znaleziono identyfikatora domeny nadrzędnej.

  • EntityConflict — tworzenie domeny nie powiodło się, ponieważ nazwa wyświetlana domeny już istnieje.

  • InvalidInput — nieprawidłowy identyfikator domeny nadrzędnej.

Przykłady

Create a domain example

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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"
}

Definicje

Nazwa Opis
CreateDomainRequest

Ładunek żądania do tworzenia domeny lub poddomeny.
Domain
ErrorRelatedResource

Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.

CreateDomainRequest

Objekt

Ładunek żądania do tworzenia domeny lub poddomeny.

Nazwa Typ Opis
description

string

Opis domeny. Opis nie może zawierać więcej niż 256 znaków.
displayName

string

Nazwa wyświetlana domeny. Nazwa wyświetlana nie może zawierać więcej niż 40 znaków.
parentDomainId

string (uuid)

Identyfikator obiektu nadrzędnego domeny.

Domain

Objekt
Nazwa Typ Opis
defaultLabelId

string (uuid)

Domyślna etykieta poufności domeny.
description

string

Opis domeny.
displayName

string

Nazwa domeny.
id

string (uuid)

Identyfikator obiektu domeny.
parentDomainId

string (uuid)

Identyfikator obiektu nadrzędnego domeny.

ErrorRelatedResource

Objekt

Obiekt szczegółów zasobu powiązanego z błędem.

Nazwa Typ Opis
resourceId

string

Identyfikator zasobu, który jest zaangażowany w błąd.
resourceType

string

Typ zasobu, który jest zaangażowany w błąd.

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
moreDetails

ErrorResponseDetails[]

Lista dodatkowych szczegółów błędu.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.
requestId

string

Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwa Typ Opis
errorCode

string

Określony identyfikator, który zawiera informacje o stanie błędu, co pozwala na ustandaryzowaną komunikację między naszą usługą a jej użytkownikami.
message

string

Czytelna reprezentacja błędu przez człowieka.
relatedResource

ErrorRelatedResource

Szczegóły zasobu powiązanego z błędem.