Capacities

Operations

Get Capacities

Returns a list of capacities that the user has access to.

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Get Refreshable For Capacity

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

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Get Refreshables

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

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Get Refreshables For Capacity

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

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Get Workload

Returns the current state of a workload. If the workload is enabled, the percentage of maximum memory that the workload can consume is also returned.

Workload APIs are not relevant for Embedded Gen2 capacities.

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Get Workloads

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

Workload APIs are not relevant for Embedded Gen2 capacities.

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

Groups AssignMyWorkspaceToCapacity

Assigns My Workspace to the specified capacity.

To unassign My Workspace from a capacity, provide an empty Guid (00000000-0000-0000-0000-000000000000) as the capacityId.

Permissions

The user must have administrator rights or assign permissions on the capacity.

Required scope

Capacity.ReadWrite.All and Workspace.ReadWrite.All

Groups AssignToCapacity

Assigns the specified workspace to the specified capacity.

To unassign My Workspace from a capacity, provide an empty Guid (00000000-0000-0000-0000-000000000000) as the capacityId.

Permissions

The user must have administrator rights or assign permissions on the capacity.

Required scope

Capacity.ReadWrite.All and Workspace.ReadWrite.All

Groups CapacityAssignmentStatus

Gets the status of the assignment-to-capacity operation for the specified workspace.

Permissions

The user must have administrator rights or assign permissions on the capacity.

Required scope

Workspace.Read.All and Workspace.ReadWrite.All

Groups CapacityAssignmentStatusMyWorkspace

Gets the status of the My Workspace assignment-to-capacity operation.

Required scope

Workspace.Read.All and Workspace.ReadWrite.All

Patch Workload

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

Workload APIs are not relevant for Embedded Gen2 capacities.

Required scope

Capacity.ReadWrite.All