Workspaces - Assign To Capacity
Note
This API is in preview.
Assigns the specified workspace to the specified capacity.
Permissions
- The caller must have contributor permissions or be an Admin on the capacity.
- The caller must have admin role on the workspace.
Required Scope
Capacity.ReadWrite.All and Workspace.ReadWrite.All
Limitations
- Fabric items (non-PowerBI) don't support migration across region. For more information see moving data around.
- Workspaces with Fabric items (non-PowerBI) can only be assigned to Fabric, Fabric trialor Power BI Premium capacity. For more information see Microsoft Fabric license types.
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/assignToCapacity
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
capacityId | True |
string |
The ID of the capacity the workspace should be assigned to. |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
Request accepted, assignment is in progress. |
|
Other Status Codes |
Common error codes:
|
Examples
Assign a workspace to capacity example
Sample Request
POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff512/assignToCapacity
{
"capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2"
}
Sample Response
Definitions
Name | Description |
---|---|
Assign |
A capacity assignment request. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
AssignWorkspaceToCapacityRequest
A capacity assignment request.
Name | Type | Description |
---|---|---|
capacityId |
string |
The ID of the capacity the workspace should be assigned to. |
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. |