Udostępnij przez

Domains - Update Domain (preview)

Usługa:
Admin
Wersja interfejsu API:
v1

Aktualizuje określone informacje o domenie (wersja zapoznawcza).

Uwaga / Notatka

Ten interfejs API w wersji zapoznawczej zostanie wycofany 31 marca 2026 r. i zastąpiony stabilną wersją dostępną tutaj. Nowa wersja wprowadza zmiany powodujące niezgodność i nie jest zgodna z poprzednimi wersjami. Podczas wywoływania tego interfejsu API wywołujące muszą określić true jako wartość parametru previewzapytania .

Powiadomienie o wycofaniu

Wprowadzono nowy parametr preview zapytania w celu ułatwienia tego przejścia:

  • Parametr preview zapytania jest obecnie domyślnie ustawiony na true.
  • Ustaw wartość parametru preview zapytania, aby false użyć wersji wydania tego interfejsu API.
  • Od 31 marca 2026 r. wartość preview domyślna dla elementu zmieni się na false.

Zaleca się przeprowadzenie migracji integracji do korzystania z wersji wydania tak szybko, jak to możliwe, określając falsepreview parametr zapytania (wartość preview domyślna parametru zapytania zostanie ustawiona na false datę wycofania interfejsu API).

W wersji wydania wprowadzono następujące niezgodne zmiany:

  • Właściwość contributorsScope żądania została usunięta.
  • Właściwość contributorsScope odpowiedzi została usunięta.

Permissions

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 Microsoft Entra

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

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

Interfejs

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
domainId
 path True

string (uuid)

Identyfikator domeny.
preview
 query True

boolean

Ten parametr określa, która wersja interfejsu API ma być używana. Ustaw opcję na true użycie wersji zapoznawczej opisanej na tej stronie lub do false korzystania z wersji zapoznawczej opisanej tutaj. Od 31 marca 2026 r. wartość preview domyślna dla elementu zmieni się na false.

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

DomainPreview

Żądanie zostało ukończone pomyślnie.
Other Status Codes

ErrorResponse

Typowe kody błędów:

  • DomainNotFound — nie znaleziono podanej domeny

  • 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

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

{
  "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.
DomainPreview
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

Szczegóły odpowiedzi na błąd.
UpdateDomainRequestPreview

ContributorsScopeType

Wyliczenie

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

Wartość Opis
AllTenant

Wszyscy użytkownicy dzierżawy.
SpecificUsersAndGroups

Konkretni użytkownicy i grupy.
AdminsOnly

Tylko administratorzy dzierżawy i domeny.

DomainPreview

Objekt
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.

UpdateDomainRequestPreview

Objekt
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.