Workspaces - Update Workspace
Note
This API is in preview.
Updates the properties of the specified workspace.
Permissions
The caller must have admin role on the workspace.
Required Delegated Scopes
Workspace.ReadWrite.All
Interface
PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Type | Description |
---|---|---|
description |
string |
The workspace description. |
displayName |
string |
The workspace display name. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
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
{
"id": "33bae707-5fe7-4352-89bd-061a1318b60a",
"displayName": "Workspace New displayName",
"description": "Workspace New description",
"type": "Workspace"
}
Definitions
Name | Description |
---|---|
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Update |
Update workspace request payload. |
Workspace |
A workspace object. |
Workspace |
A Workspace type. Additional Workspace types may be added over time. |
ErrorRelatedResource
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
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 |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
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 |
The error related resource details. |
UpdateWorkspaceRequest
Update workspace request payload.
Name | Type | Description |
---|---|---|
description |
string |
The workspace description. |
displayName |
string |
The workspace display name. |
Workspace
A workspace object.
Name | Type | Description |
---|---|---|
capacityId |
string |
The ID of the capacity the workspace is assigned to. |
description |
string |
The workspace description. |
displayName |
string |
The workspace display name. |
id |
string |
The workspace ID. |
type |
The workspace type. |
WorkspaceType
A Workspace type. Additional Workspace types may be added over time.
Name | Type | Description |
---|---|---|
Personal |
string |
A personal workspace |
Workspace |
string |
A collaborative workspace |