Capacities

Operations

Get Capacities

Returns a list of capacities the user has access to.

Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Get Refreshable For Capacity

Returns the specified refreshable for the specified capacity the user has access to

Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Get Refreshables

Returns a list of refreshables for all capacities of which the user has access to.

Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Get Refreshables For Capacity

Returns a list of refreshables for the specified capacity the user has access to

Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Get Workload

Returns the current state of a workload and if the workload is enabled also returns the maximum memory percentage that the workload can consume.

Note: Workload APIs are not relevant for Embedded Gen2 capacities.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Get Workloads

Returns the current state of the specified capacity workloads, if a workload is enabled also returns the maximum memory percentage that the workload can consume.

Note: Workload APIs are not relevant for Embedded Gen2 capacities.
Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

Groups AssignMyWorkspaceToCapacity

Assigns "My Workspace" to the specified capacity.
Note: To perform this operation, the user must have admin or assign permissions on the capacity. To unassign "My Workspace" from a capacity, Empty Guid (00000000-0000-0000-0000-000000000000) should be provided as capacityId.

Required scope: Capacity.ReadWrite.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

Groups AssignToCapacity

Assigns the specified workspace to the specified capacity.
Note: To perform this operation, the user must be admin on the specified workspace and have admin or assign permissions on the capacity. To unassign the specified workspace from a capacity, Empty Guid (00000000-0000-0000-0000-000000000000) should be provided as capacityId.

Required scope: Capacity.ReadWrite.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

Groups CapacityAssignmentStatus

Gets the status of the assignment to capacity operation of the specified workspace.
Note: To perform this operation, the user must be admin on the specified workspace.

Required scope: Workspace.Read.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

Groups CapacityAssignmentStatusMyWorkspace

Gets the status of "My Workspace" assignment to capacity operation.
Note:

Required scope: Workspace.Read.All and Workspace.ReadWrite.All
To set the permissions scope, see Register an app.

Patch Workload

Changes the state of a specific workload to Enabled or Disabled. When enabling a workload the maximum memory percentage that the workload can consume must be set.

Note: Workload APIs are not relevant for Embedded Gen2 capacities.
Required scope: Capacity.ReadWrite.All
To set the permissions scope, see Register an app.