Workspaces - Restore Workspace

服务:

Admin

API 版本:

v1

注意

此 API 以预览版提供。

还原已删除的工作区。

权限

调用方必须具有 Fabric 管理员权限。

所需的委派范围

Tenant.ReadWrite.All。

局限性

每分钟最多 10 个请求。

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

身份	支持
用户	是的
服务主体 和 托管标识	是的

接口

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

URI 参数

名称	在	必需	类型	说明
workspaceId	path	True	string uuid	工作区 ID。

请求正文

名称	类型	说明
newWorkspaceAdminPrincipal	Principal	工作区的管理员。
newWorkspaceName	string	工作区的名称。 如果还原请求用于 “我的工作区”，则是必需的。

响应

名称	类型	说明
200 OK		已成功还原工作区。
Other Status Codes	ErrorResponse	常见错误代码： UnknownError - 发生错误。

示例

Restore workspace example

示例请求

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

示例响应

状态代码:

200

定义

名称	说明
ErrorRelatedResource	与错误相关的资源详细信息对象。
ErrorResponse	错误响应。
ErrorResponseDetails	错误响应详细信息。
GroupDetails	组特定详细信息。 当主体类型 Group时适用。
GroupType	组的类型。 可能会随着时间的推移添加其他组类型。
Principal	表示标识或Microsoft Entra 组。
PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
RestoreWorkspaceRequest	还原已删除工作区的请求。
ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称	类型	说明
resourceId	string	错误中涉及的资源 ID。
resourceType	string	错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
moreDetails	ErrorResponseDetails[]	其他错误详细信息的列表。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。
requestId	string	与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称	类型	说明
errorCode	string	提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message	string	错误的人工可读表示形式。
relatedResource	ErrorRelatedResource	与错误相关的资源详细信息。

GroupDetails

Object

组特定详细信息。 当主体类型 Group时适用。

名称	类型	说明
groupType	GroupType	组的类型。 可能会随着时间的推移添加其他组类型。

GroupType

Enumeration

组的类型。 可能会随着时间的推移添加其他组类型。

值	说明
DistributionList	主体是通讯组列表。
SecurityGroup	主体是安全组。
Unknown	主体组类型未知。

Principal

Object

表示标识或Microsoft Entra 组。

名称	类型	说明
displayName	string	主体的显示名称。
groupDetails	GroupDetails	组特定详细信息。 当主体类型 Group时适用。
id	string uuid	主体的 ID。
servicePrincipalDetails	ServicePrincipalDetails	服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。
type	PrincipalType	主体的类型。 可能会随着时间的推移添加其他主体类型。
userDetails	UserDetails	用户主体特定详细信息。 当主体类型 User时适用。

PrincipalType

Enumeration

主体的类型。 可能会随着时间的推移添加其他主体类型。

值	说明
Group	主体是安全组。
ServicePrincipal	主体是Microsoft Entra 服务主体。
ServicePrincipalProfile	主体是服务主体配置文件。
User	主体是Microsoft Entra 用户主体。

RestoreWorkspaceRequest

Object

还原已删除工作区的请求。

名称	类型	说明
newWorkspaceAdminPrincipal	Principal	工作区的管理员。
newWorkspaceName	string	工作区的名称。 如果还原请求用于 “我的工作区”，则是必需的。

ServicePrincipalDetails

Object

服务主体特定详细信息。 当主体类型 ServicePrincipal时适用。

名称	类型	说明
aadAppId	string uuid	服务主体的 Microsoft Entra AppId。

ServicePrincipalProfileDetails

Object

服务主体配置文件详细信息。 当主体类型 ServicePrincipalProfile时适用。

名称	类型	说明
parentPrincipal	Principal	服务主体配置文件的父主体。

UserDetails

Object

用户主体特定详细信息。 当主体类型 User时适用。

名称	类型	说明
userPrincipalName	string	用户主体名称。