Domains - Create Domain

Usługa:

Admin

Wersja interfejsu API:

v1

Nuta

Ten interfejs API jest w wersji zapoznawczej.

Tworzy nową domenę.

Uprawnienia

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

Wymagane zakresy delegowane

Tenant.ReadWrite.All.

Ograniczenia

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

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

Ten interfejs API obsługuje tożsamości firmy Microsoft wymienione w tej sekcji.

Tożsamość	Wsparcie
Użytkownik	Tak
jednostki usługi i tożsamości zarządzanych	Tak

Interfejs

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

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

HTTP

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

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

Definicje

Nazwa	Opis
ContributorsScopeType	Zakres współautora. Dodatkowe zakresy współautora mogą być dodawane w czasie.
CreateDomainRequest	Ładunek żądania do tworzenia domeny lub poddomeny.
Domain	Reprezentuje domenę lub poddomenę.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.

ContributorsScopeType

Wyliczanie

Zakres współautora. Dodatkowe zakresy współautora mogą być dodawane w czasie.

Wartość	Opis
AdminsOnly	Tylko administratorzy dzierżawy i domeny.
AllTenant	Wszyscy użytkownicy dzierżawy.
SpecificUsersAndGroups	Konkretni użytkownicy i grupy.

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

Reprezentuje domenę lub poddomenę.

Nazwa	Typ	Opis
contributorsScope	ContributorsScopeType	Zakres współautorów 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.