Udostępnij przez

Domains - Update Domain

Usługa:
Admin
Wersja interfejsu API:
v1

Aktualizuje określone informacje o domenie.

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

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 wartość na , aby false używać wersji wydania.

Treść żądania

Nazwa Typ Opis
defaultLabelId

string (uuid)

Domyślna etykieta poufności domeny.

Aby usunąć wartość defaultLabelId z domeny, ustaw jej wartość na pusty identyfikator UUID w żądaniu: "000000000-0000-0000-0000-00000000000000000".
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:

  • DomainNotFound — nie znaleziono podanej domeny

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

  • UnknownError — wystąpił błąd.

Przykłady

Update a domain example

Przykładowe żądanie

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

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Przykładowa odpowiedź

Kod stanu:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "defaultLabelId": "d9a6c724-a08f-429d-9fa9-9659c5181b7f"
}

Definicje

Nazwa Opis
Domain
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

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.

UpdateDomainRequest

Objekt
Nazwa Typ Opis
defaultLabelId

string (uuid)

Domyślna etykieta poufności domeny.

Aby usunąć wartość defaultLabelId z domeny, ustaw jej wartość na pusty identyfikator UUID w żądaniu: "000000000-0000-0000-0000-00000000000000000".
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.