Workspaces - Assign To Domain

Usługa:: Core

Wersja interfejsu API:: v1

Przypisuje określony obszar roboczy do określonej domeny.

Permissions

Obiekt wywołujący musi mieć uprawnienia współautora lub być administratorem domeny.
Obiekt wywołujący musi mieć rolę administratora obszaru roboczego.

Wymagany zakres

Przestrzeń robocza.OdczytZapis.Wszystko

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/assignToDomain

Parametry identyfikatora URI

Nazwisko	W	Wymagane	Typ	Opis
workspaceId	path	True	string (uuid)	Identyfikator przestrzeni roboczej.

Treść żądania

Nazwisko	Wymagane	Typ	Opis
domainId	True	string (uuid)	Identyfikator domeny, do której powinien zostać przypisany obszar roboczy.

Odpowiedzi

Nazwisko Typ Opis

200 OK

Nazwisko	Typ	Opis
200 OK		Żądanie zostało ukończone pomyślnie.
429 Too Many Requests	ErrorResponse	Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący `Retry-After` w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań. Nagłówki Retry-After: integer
Other Status Codes	ErrorResponse	Typowe kody błędów: DomainNotFound — nie znaleziono podanej domeny WorkspaceNotFound — nie znaleziono podanego obszaru roboczego InsufficientPermissionsToDomain — obiekt wywołujący nie ma wystarczających uprawnień do domeny, aby wykonać operację InsufficientWorkspaceRole — obiekt wywołujący nie ma wystarczających uprawnień do obszaru roboczego, aby wykonać operację UnknownError — wystąpił błąd.

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

429 Too Many Requests

ErrorResponse

Przekroczono limit szybkości usługi. Serwer zwraca nagłówek wskazujący Retry-After w sekundach, jak długo klient musi czekać przed wysłaniem dodatkowych żądań.

Nagłówki

Retry-After: integer

Other Status Codes

ErrorResponse

Typowe kody błędów:

DomainNotFound — nie znaleziono podanej domeny
WorkspaceNotFound — nie znaleziono podanego obszaru roboczego
InsufficientPermissionsToDomain — obiekt wywołujący nie ma wystarczających uprawnień do domeny, aby wykonać operację
InsufficientWorkspaceRole — obiekt wywołujący nie ma wystarczających uprawnień do obszaru roboczego, aby wykonać operację
UnknownError — wystąpił błąd.

Przykłady

Assign a workspace to a domain example

Przykładowe żądanie

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/f97451ca-d6a0-482f-a46a-cc4b2c48ba56/assignToDomain

{
  "domainId": "9d04ca81-bb30-4009-bd1a-a9213a4c8d75"
}

Przykładowa odpowiedź

Kod stanu:: 200

Definicje

Nazwisko	Opis
AssignWorkspaceToDomainRequest	Żądanie przypisania domeny.
ErrorParameter	Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.
ErrorRelatedResource	Obiekt szczegółów zasobu powiązanego z błędem.
ErrorResponse	Odpowiedź na błąd.
ErrorResponseDetails	Szczegóły odpowiedzi na błąd.

AssignWorkspaceToDomainRequest

Objekt

Żądanie przypisania domeny.

Nazwisko	Typ	Opis
domainId	string (uuid)	Identyfikator domeny, do której powinien zostać przypisany obszar roboczy.

ErrorParameter

Objekt

Parametr ustrukturyzowany zapewniający dodatkowy kontekst czytelny dla maszyny o błędzie.

Nazwisko	Typ	Opis
message	string	Czytelny dla człowieka opis znaczenia parametru.
name	string	Identyfikator parametru.
value	string	Wartość parametru.

ErrorRelatedResource

Objekt

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

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

Nazwisko	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.
isRetriable	boolean	Jeśli to prawda, żądanie można ponowić. Użyj nagłówka `Retry-After` odpowiedzi, aby określić opóźnienie, jeśli jest dostępne.
message	string	Czytelna reprezentacja błędu przez człowieka.
moreDetails	ErrorResponseDetails[]	Lista dodatkowych szczegółów błędu.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.
requestId	string (uuid)	Identyfikator żądania skojarzonego z błędem.

ErrorResponseDetails

Objekt

Szczegóły odpowiedzi na błąd.

Nazwisko	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.
parameters	ErrorParameter[]	Parametry ustrukturyzowane zapewniające dodatkowy kontekst czytelny dla maszyny o błędzie.
relatedResource	ErrorRelatedResource	Szczegóły zasobu powiązanego z błędem.