Edit

Share via

Workspaces - Update Workspace

Service:
Core
API Version:
v1

Updates the specified workspace properties.

Permissions

The caller must have admin workspace role.

Required Delegated Scopes

Workspace.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

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

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Type Description
description

string

The workspace description.
The description cannot contain more than 4000 characters.
displayName

string

The workspace display name.
The display name cannot contain more than 256 characters.
Workspace names must be unique within the tenant.
"Admin monitoring" is a reserved workspace name.

Responses

Name Type Description
200 OK

Workspace

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Update a workspace example

Sample request

PATCH https://api.fabric.microsoft.com/v1/workspaces/33bae707-5fe7-4352-89bd-061a1318b60a

{
  "displayName": "Workspace New displayName",
  "description": "Workspace New description"
}

Sample response

Status code:
200 
{
  "id": "33bae707-5fe7-4352-89bd-061a1318b60a",
  "displayName": "Workspace New displayName",
  "description": "Workspace New description",
  "type": "Workspace",
  "domainId": "686177b9-ef29-45e4-a5db-1786ca6dbb9f"
}

Definitions

Name Description
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
UpdateWorkspaceRequest

Update workspace request payload.
Workspace

A workspace object.
WorkspaceType

A workspace type. Additional workspace types may be added over time.

ErrorRelatedResource

Object

The error related resource details object.

Name Type Description
resourceId

string

The resource ID that's involved in the error.
resourceType

string

The type of the resource that's involved in the error.

ErrorResponse

Object

The error response.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
moreDetails

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

The error related resource details.
requestId

string

ID of the request associated with the error.

ErrorResponseDetails

Object

The error response details.

Name Type Description
errorCode

string

A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message

string

A human readable representation of the error.
relatedResource

ErrorRelatedResource

The error related resource details.

UpdateWorkspaceRequest

Object

Update workspace request payload.

Name Type Description
description

string

The workspace description.
The description cannot contain more than 4000 characters.
displayName

string

The workspace display name.
The display name cannot contain more than 256 characters.
Workspace names must be unique within the tenant.
"Admin monitoring" is a reserved workspace name.

Workspace

Object

A workspace object.

Name Type Description
apiEndpoint

string (uri)

HTTP URL that represents the API endpoint specific to the workspace. This endpoint value is returned when the user enables preferWorkspaceSpecificEndpoints. It allows for API access over private links.
capacityId

string (uuid)

The ID of the capacity the workspace is assigned to.
description

string

The workspace description.
displayName

string

The workspace display name.
domainId

string (uuid)

The ID of the domain the workspace is assigned to.
id

string (uuid)

The workspace ID.
type

WorkspaceType

The workspace type.

WorkspaceType

Enumeration

A workspace type. Additional workspace types may be added over time.

Value Description
Personal

My folder or My workspace used to manage user items.
Workspace

Workspace used to manage the Fabric items.
AdminWorkspace

Admin monitoring workspace. Contains admin reports such as the audit report and the usage and adoption report.