Domains - Update Domain

Usługa:

Admin

Wersja interfejsu API:

v1

Nuta

Ten interfejs API jest w wersji zapoznawczej.

Aktualizuje określone informacje o domenie.

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

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
domainId	path	True	string uuid	Identyfikator domeny.

Treść żądania

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

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Domain	Żądanie zostało ukończone pomyślnie.
Other Status Codes	ErrorResponse	Typowe kody błędów: UnknownError — wystąpił błąd. EntityConflict — aktualizacja domeny nie powiodła się, ponieważ nazwa wyświetlana domeny już istnieje.

Przykłady

Update a domain example

Przykładowe żądanie

HTTP

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

Definicje

Nazwa	Opis
ContributorsScopeType	Zakres współautora. Dodatkowe zakresy współautora mogą być dodawane w czasie.
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.
UpdateDomainRequest	Ładunek żądania do aktualizowania domeny.

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.

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.

UpdateDomainRequest

Objekt

Ładunek żądania do aktualizowania domeny.

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