Udostępnij przez

Workspaces - Restore Workspace

Usługa:
Admin
Wersja interfejsu API:
v1

Przywraca usunięty obszar roboczy.

Note

Ten interfejs API jest częścią wersji zapoznawczej i jest dostarczany tylko do celów ewaluacyjnych i programistycznych. Może ona ulec zmianie na podstawie opinii i nie jest zalecana do użytku produkcyjnego.

Permissions

Obiekt wywołujący musi mieć uprawnienia administratora sieci szkieletowej.

Wymagane zakresy delegowane

Tenant.ReadWrite.All.

Limitations

Maksymalnie dziesięć żądań na minutę.

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

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
workspaceId
 path True

string (uuid)

Identyfikator obszaru roboczego.

Treść żądania

Nazwa Typ Opis
newWorkspaceAdminPrincipal

Principal

Administrator obszaru roboczego.
newWorkspaceName

string

Nazwa obszaru roboczego. Obowiązkowe, jeśli żądanie przywrócenia dotyczy obszaru Mój obszar roboczy.

Odpowiedzi

Nazwa Typ Opis
200 OK

Pomyślnie przywróć obszar roboczy.
Other Status Codes

ErrorResponse

Typowe kody błędów:

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

Przykłady

Restore workspace example

Przykładowe żądanie

POST https://api.fabric.microsoft.com/v1/admin/workspaces/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/restore

{
  "newWorkspaceName": "Contoso Workspace",
  "newWorkspaceAdminPrincipal": {
    "id": "17dd1e38-a4c6-41ed-bc4f-1e383f8ddd01",
    "type": "User"
  }
}

Przykładowa odpowiedź

Kod stanu:
200

Definicje

Nazwa Opis
ErrorRelatedResource

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

Odpowiedź na błąd.
ErrorResponseDetails

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

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.
Principal

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.
PrincipalType

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
RestoreWorkspaceRequest

Żądanie przywrócenia usuniętego obszaru roboczego.
ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

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.

GroupDetails

Objekt

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.

Nazwa Typ Opis
groupType

GroupType

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

GroupType

Wyliczanie

Typ grupy. Dodatkowe typy grup mogą być dodawane w czasie.

Wartość Opis
Unknown

Typ grupy podmiotu zabezpieczeń jest nieznany.
SecurityGroup

Podmiot zabezpieczeń jest grupą zabezpieczeń.
DistributionList

Podmiot zabezpieczeń jest listą dystrybucyjną.

Principal

Objekt

Reprezentuje tożsamość lub grupę firmy Microsoft Entra.

Nazwa Typ Opis
displayName

string

Nazwa wyświetlana podmiotu zabezpieczeń.
groupDetails

GroupDetails

Grupuj szczegółowe informacje. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość Group.
id

string (uuid)

Identyfikator podmiotu zabezpieczeń.
servicePrincipalDetails

ServicePrincipalDetails

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.
type

PrincipalType

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.
userDetails

UserDetails

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

PrincipalType

Wyliczanie

Typ podmiotu zabezpieczeń. Dodatkowe typy podmiotów zabezpieczeń mogą być dodawane w czasie.

Wartość Opis
User

Podmiot zabezpieczeń jest podmiotem zabezpieczeń użytkownika firmy Microsoft Entra.
ServicePrincipal

Jednostka jest jednostką usługi Microsoft Entra.
Group

Podmiot zabezpieczeń jest grupą zabezpieczeń.
ServicePrincipalProfile

Jednostka jest profilem jednostki usługi.
EntireTenant

Podmiot zabezpieczeń reprezentuje wszystkich użytkowników dzierżawy.

RestoreWorkspaceRequest

Objekt

Żądanie przywrócenia usuniętego obszaru roboczego.

Nazwa Typ Opis
newWorkspaceAdminPrincipal

Principal

Administrator obszaru roboczego.
newWorkspaceName

string

Nazwa obszaru roboczego. Obowiązkowe, jeśli żądanie przywrócenia dotyczy obszaru Mój obszar roboczy.

ServicePrincipalDetails

Objekt

Szczegóły dotyczące jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipal.

Nazwa Typ Opis
aadAppId

string (uuid)

Jednostka usługi Firmy Microsoft Entra AppId.

ServicePrincipalProfileDetails

Objekt

Szczegóły profilu jednostki usługi. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość ServicePrincipalProfile.

Nazwa Typ Opis
parentPrincipal

Principal

Jednostka nadrzędna profilu jednostki usługi.

UserDetails

Objekt

Szczegóły dotyczące podmiotu zabezpieczeń użytkownika. Dotyczy, gdy typ podmiotu zabezpieczeń ma wartość User.

Nazwa Typ Opis
userPrincipalName

string

Główna nazwa użytkownika.