Workspaces - Restore Workspace

Servizio:

Admin

Versione API:

v1

Ripristina un'area di lavoro eliminata.

Note

Questa API fa parte di una versione di anteprima e viene fornita solo a scopo di valutazione e sviluppo. Può cambiare in base al feedback e non è consigliato per l'uso in produzione.

Permissions

Il chiamante deve disporre dei diritti di amministratore di Fabric.

Ambiti delegati obbligatori

Tenant.ReadWrite.All.

Limitations

Numero massimo di dieci richieste al minuto.

Identità supportate da Microsoft Entra

Questa API supporta le identità di Microsoft elencate in questa sezione.

Identity	Support
User	Yes
Principale del servizio e Identità gestite	Yes

Interface

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
workspaceId	path	True	string (uuid)	ID dell'area di lavoro.

Corpo della richiesta

Nome	Tipo	Descrizione
newWorkspaceAdminPrincipal	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	Amministratore dell'area di lavoro.
newWorkspaceName	string	Nome dell'area di lavoro. Obbligatorio se la richiesta di ripristino è relativa all'area di lavoro personale.

Risposte

Nome	Tipo	Descrizione
200 OK		Ripristinare correttamente l'area di lavoro.
429 Too Many Requests	ErrorResponse	È stato superato il limite di velocità del servizio. Il server restituisce un'intestazione Retry-After che indica, in secondi, per quanto tempo il client deve attendere prima di inviare richieste aggiuntive. Intestazioni Retry-After: integer
Other Status Codes	ErrorResponse	Codici di errore comuni: UnknownError: si è verificato un errore.

Esempio

Restore workspace example

Esempio di richiesta

HTTP

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"
  }
}

Risposta di esempio

Codice di stato:

200

Definizioni

Nome	Descrizione
EntireTenantPrincipal	Rappresenta un'entità tenant
ErrorRelatedResource	Oggetto dettagli risorsa correlato all'errore.
ErrorResponse	Risposta di errore.
ErrorResponseDetails	Dettagli della risposta di errore.
GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.
GroupPrincipal	Rappresenta un gruppo di sicurezza.
GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.
PrincipalType	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
RestoreWorkspaceRequest	Richiesta di ripristino di un'area di lavoro eliminata.
ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.
ServicePrincipalPrincipal	Rappresenta un'entità servizio Microsoft Entra.
ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.
ServicePrincipalProfilePrincipal	Rappresenta un profilo dell'entità servizio.
UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.
UserPrincipal	Rappresenta un'entità utente di Microsoft Entra.

EntireTenantPrincipal

Oggetto

Rappresenta un'entità tenant

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: EntireTenant	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ErrorRelatedResource

Oggetto

Oggetto dettagli risorsa correlato all'errore.

Nome	Tipo	Descrizione
resourceId	string	ID risorsa coinvolto nell'errore.
resourceType	string	Tipo della risorsa coinvolta nell'errore.

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
moreDetails	ErrorResponseDetails[]	Elenco di dettagli aggiuntivi sull'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.
requestId	string (uuid)	ID della richiesta associata all'errore.

ErrorResponseDetails

Oggetto

Dettagli della risposta di errore.

Nome	Tipo	Descrizione
errorCode	string	Identificatore specifico che fornisce informazioni su una condizione di errore, consentendo la comunicazione standardizzata tra il servizio e i relativi utenti.
message	string	Rappresentazione leggibile dell'errore.
relatedResource	ErrorRelatedResource	Dettagli della risorsa correlati all'errore.

GroupDetails

Oggetto

Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.

Nome	Tipo	Descrizione
groupType	GroupType	Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

GroupPrincipal

Oggetto

Rappresenta un gruppo di sicurezza.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
groupDetails	GroupDetails	Dettagli specifici del gruppo. Applicabile quando il tipo principale è Group.
id	string (uuid)	ID dell'entità.
type	string: Group	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

GroupType

Enumerazione

Tipo del gruppo. È possibile aggiungere altri tipi di gruppo nel tempo.

Valore	Descrizione
Unknown	Il tipo di gruppo principale è sconosciuto.
SecurityGroup	Principal è un gruppo di sicurezza.
DistributionList	Principal è una lista di distribuzione.

PrincipalType

Enumerazione

Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

Valore	Descrizione
User	Principal è un'entità utente di Microsoft Entra.
ServicePrincipal	Principal è un'entità servizio Microsoft Entra.
Group	Principal è un gruppo di sicurezza.
ServicePrincipalProfile	Principal è un profilo dell'entità servizio.
EntireTenant	Principal rappresenta tutti gli utenti tenant.

RestoreWorkspaceRequest

Oggetto

Richiesta di ripristino di un'area di lavoro eliminata.

Nome	Tipo	Descrizione
newWorkspaceAdminPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Amministratore dell'area di lavoro.
newWorkspaceName	string	Nome dell'area di lavoro. Obbligatorio se la richiesta di ripristino è relativa all'area di lavoro personale.

ServicePrincipalDetails

Oggetto

Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.

Nome	Tipo	Descrizione
aadAppId	string (uuid)	Microsoft Entra AppId dell'entità servizio.

ServicePrincipalPrincipal

Oggetto

Rappresenta un'entità servizio Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalDetails	ServicePrincipalDetails	Dettagli specifici dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipal.
type	string: ServicePrincipal	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

ServicePrincipalProfileDetails

Oggetto

Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.

Nome	Tipo	Descrizione
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	Entità padre del profilo dell'entità servizio.

ServicePrincipalProfilePrincipal

Oggetto

Rappresenta un profilo dell'entità servizio.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Dettagli del profilo dell'entità servizio. Applicabile quando il tipo principale è ServicePrincipalProfile.
type	string: ServicePrincipalProfile	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.

UserDetails

Oggetto

Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.

Nome	Tipo	Descrizione
userPrincipalName	string	Nome dell'entità utente.

UserPrincipal

Oggetto

Rappresenta un'entità utente di Microsoft Entra.

Nome	Tipo	Descrizione
displayName	string	Nome visualizzato dell'entità.
id	string (uuid)	ID dell'entità.
type	string: User	Tipo dell'entità. È possibile aggiungere altri tipi di entità nel tempo.
userDetails	UserDetails	Dettagli specifici dell'entità utente. Applicabile quando il tipo principale è User.