Domains - Assign Domain Workspaces By Capacities

  • Reference
Service:
Admin
API Version:
v1

Note

This API is in preview.

Assign all workspaces that reside on the specified capacities to the specified domain.

Preexisting domain assignments will be overridden unless bulk reassignment is blocked by domain management tenant settings.

Permissions

The caller must be a Fabric administrator.

This API supports long running operations (LRO).

Required Delegated Scopes

Tenant.ReadWrite.All.

Limitations

Maximum 10 requests per one minute per principal.

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal No
Managed identities No

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/assignWorkspacesByCapacities

URI Parameters

Name In Required Type Description
domainId
 path True

string

uuid

The domain ID.

Request Body

Name Type Description
capacitiesIds

string[]

The capacity IDs.

Responses

Name Type Description
202 Accepted

Operation is in progress.

Headers

  • Location: string
  • Retry-After: integer
  • x-ms-operation-id: string
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Assign domain workspaces by capacities example

Sample request

POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/assignWorkspacesByCapacities

{
  "capacitiesIds": [
    "796ce6ad-9163-4c16-9559-c68192a251de"
  ]
}

Sample response

Status code:
202 
Location: https://api.fabric.microsoft.com/operations/cfafbeb1-8037-4d0c-896e-a46fb27ff227
x-ms-operation-id: cfafbeb1-8037-4d0c-896e-a46fb27ff227
Retry-After: 30

Definitions

Name Description
AssignDomainWorkspacesByCapacitiesRequest

The request payload for assigning workspaces to a domain by capacity.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.

AssignDomainWorkspacesByCapacitiesRequest

The request payload for assigning workspaces to a domain by capacity.

Name Type Description
capacitiesIds

string[]

The capacity IDs.

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

ErrorResponseDetails[]

List of additional error details.
relatedResource

ErrorRelatedResource

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

ErrorRelatedResource

The error related resource details.