Workspaces - Restore Workspace

Tjänst:
Admin
API-version:
v1

Återställer en borttagen arbetsyta.

Note

Det här API:et är en del av en förhandsversion och tillhandahålls endast i utvärderings- och utvecklingssyfte. Den kan ändras baserat på feedback och rekommenderas inte för produktionsanvändning.

Permissions

Anroparen måste ha administratörsbehörighet för infrastrukturresurser.

Obligatoriska delegerade omfång

Tenant.ReadWrite.All.

Limitations

Maximalt tio begäranden per minut.

Identiteter som stöds av Microsoft Entra

Det här API:et stöder Microsoft identiteter som anges i det här avsnittet.

Identity Support
User Yes
Tjänsthuvudnamn och hanterade identiteter Yes

Interface

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

URI-parametrar

Name I Obligatorisk Typ Description
workspaceId
 path True

string (uuid)

Arbetsytans ID.

Begärandetext

Name Typ Description
newWorkspaceAdminPrincipal Principal:

Arbetsytans administratör.
newWorkspaceName

string

Namnet på arbetsytan. Obligatoriskt om återställningsbegäran är för Min arbetsyta.

Svar

Name Typ Description
200 OK

Återställ arbetsytan.
429 Too Many Requests

ErrorResponse

Gränsen för tjänstfrekvens överskreds. Servern returnerar ett Retry-After huvud som anger i sekunder hur länge klienten måste vänta innan ytterligare begäranden skickas.

Sidhuvuden

Retry-After: integer
Other Status Codes

ErrorResponse

Vanliga felkoder:

  • UnknownError – Ett fel uppstod.

Exempel

Restore workspace example

Exempelbegäran

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

Exempelsvar

Statuskod:
200

Definitioner

Name Description
EntireTenantPrincipal

Representerar ett klientorganisationsobjekt
ErrorRelatedResource

Det felrelaterade resursinformationsobjektet.
ErrorResponse

Felsvaret.
ErrorResponseDetails

Information om felsvar.
GroupDetails

Gruppera specifik information. Gäller när huvudtypen är Group.
GroupPrincipal

Representerar en säkerhetsgrupp.
GroupType

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.
PrincipalType

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
RestoreWorkspaceRequest

Begäran om att återställa en borttagen arbetsyta.
ServicePrincipalDetails

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.
ServicePrincipalPrincipal

Representerar tjänstens huvudnamn för Microsoft Entra.
ServicePrincipalProfileDetails

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.
ServicePrincipalProfilePrincipal

Representerar en profil för tjänstens huvudnamn.
UserDetails

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.
UserPrincipal

Representerar ett Microsoft Entra-användarhuvudnamn.

EntireTenantPrincipal

Objekt

Representerar ett klientorganisationsobjekt

Name Typ Description
displayName

string

Huvudkontots visningsnamn.
id

string (uuid)

Huvudmannens ID.
type string:

EntireTenant

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ErrorRelatedResource

Objekt

Det felrelaterade resursinformationsobjektet.

Name Typ Description
resourceId

string

Det resurs-ID som ingår i felet.
resourceType

string

Typen av resurs som är inblandad i felet.

ErrorResponse

Objekt

Felsvaret.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
isRetriable

boolean

När det är sant kan begäran göras på nytt. Använd svarshuvudet Retry-After för att fastställa fördröjningen, om den är tillgänglig.
message

string

En mänsklig läsbar representation av felet.
moreDetails

ErrorResponseDetails[]

Lista över ytterligare felinformation.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.
requestId

string (uuid)

ID för den begäran som är associerad med felet.

ErrorResponseDetails

Objekt

Information om felsvar.

Name Typ Description
errorCode

string

En specifik identifierare som ger information om ett feltillstånd, vilket möjliggör standardiserad kommunikation mellan vår tjänst och dess användare.
message

string

En mänsklig läsbar representation av felet.
relatedResource

ErrorRelatedResource

Felrelaterad resursinformation.

GroupDetails

Objekt

Gruppera specifik information. Gäller när huvudtypen är Group.

Name Typ Description
groupType

GroupType

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

GroupPrincipal

Objekt

Representerar en säkerhetsgrupp.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.
groupDetails

GroupDetails

Gruppera specifik information. Gäller när huvudtypen är Group.
id

string (uuid)

Huvudmannens ID.
type string:

Group

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

GroupType

Uppräkning

Gruppens typ. Ytterligare grupptyper kan läggas till över tid.

Värde Description
Unknown

Huvudgrupptypen är okänd.
SecurityGroup

Huvudnamn är en säkerhetsgrupp.
DistributionList

Huvudnamn är en distributionslista.

PrincipalType

Uppräkning

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

Värde Description
User

Principal är ett Microsoft Entra-användarhuvudnamn.
ServicePrincipal

Principal är microsoft entra-tjänstens huvudnamn.
Group

Huvudnamn är en säkerhetsgrupp.
ServicePrincipalProfile

Huvudnamn är en profil för tjänstens huvudnamn.
EntireTenant

Huvudkontot representerar alla klientanvändare.

RestoreWorkspaceRequest

Objekt

Begäran om att återställa en borttagen arbetsyta.

Name Typ Description
newWorkspaceAdminPrincipal Principal:

Arbetsytans administratör.
newWorkspaceName

string

Namnet på arbetsytan. Obligatoriskt om återställningsbegäran är för Min arbetsyta.

ServicePrincipalDetails

Objekt

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.

Name Typ Description
aadAppId

string (uuid)

Tjänstens huvudnamns Microsoft Entra AppId.

ServicePrincipalPrincipal

Objekt

Representerar tjänstens huvudnamn för Microsoft Entra.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.
id

string (uuid)

Huvudmannens ID.
servicePrincipalDetails

ServicePrincipalDetails

Specifik information om tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipal.
type string:

ServicePrincipal

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

ServicePrincipalProfileDetails

Objekt

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.

Name Typ Description
parentPrincipal Principal:

Tjänstens huvudnamnsprofils överordnade huvudnamn.

ServicePrincipalProfilePrincipal

Objekt

Representerar en profil för tjänstens huvudnamn.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.
id

string (uuid)

Huvudmannens ID.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Profilinformation för tjänstens huvudnamn. Gäller när huvudtypen är ServicePrincipalProfile.
type string:

ServicePrincipalProfile

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.

UserDetails

Objekt

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.

Name Typ Description
userPrincipalName

string

Användarens huvudnamn.

UserPrincipal

Objekt

Representerar ett Microsoft Entra-användarhuvudnamn.

Name Typ Description
displayName

string

Huvudkontots visningsnamn.
id

string (uuid)

Huvudmannens ID.
type string:

User

Typ av huvudnamn. Ytterligare huvudnamnstyper kan läggas till över tid.
userDetails

UserDetails

Specifik information om användarens huvudnamn. Gäller när huvudtypen är User.