Custom Pools - List Workspace Custom Pools

  • Reference
Service:
Spark
API Version:
v1

Note

This API is in preview.

List custom pools.

Permissions

The caller must have viewer or higher workspace role.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All

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

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
workspaceId
 path True

string

uuid

The workspace ID.
continuationToken
 query

string

Continuation token. Used to get the next items in the list.

Responses

Name Type Description
200 OK

CustomPools

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

List custom pools example
List custom pools with continuation example

List custom pools example

Sample request

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ]
}

List custom pools with continuation example

Sample request

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools

Sample response

Status code:
200 
{
  "value": [
    {
      "id": "2367293d-b70b-4b33-97f2-161b8d04a8d7",
      "name": "pool1",
      "type": "Workspace",
      "nodeFamily": "MemoryOptimized",
      "nodeSize": "Small",
      "autoScale": {
        "enabled": true,
        "minNodeCount": 1,
        "maxNodeCount": 4
      },
      "dynamicExecutorAllocation": {
        "enabled": true,
        "minExecutors": 1,
        "maxExecutors": 2
      }
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name Description
AutoScaleProperties

Autoscale properties.
CustomPool

Custom pool.
CustomPools
CustomPoolType

Custom pool type. Additional CustomPoolType types may be added over time.
DynamicExecutorAllocationProperties

Dynamic executor allocation proerties.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
NodeFamily

Node family. Additional NodeFamily types may be added over time.
NodeSize

Node size. Additional NodeSize types may be added over time.

AutoScaleProperties

Autoscale properties.

Name Type Description
enabled

boolean

The status of the auto scale. False - Disabled, true - Enabled.
maxNodeCount

integer

The maximum node count.
minNodeCount

integer

The minimum node count.

CustomPool

Custom pool.

Name Type Description
autoScale

AutoScaleProperties

Autoscale.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamic executor allocation.
id

string

Custom pool ID.
name

string

Custom pool name.
nodeFamily

NodeFamily

Node family.
nodeSize

NodeSize

Node size.
type

CustomPoolType

Custom pool type.

CustomPools

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

CustomPool[]

A list of custom pools.

CustomPoolType

Custom pool type. Additional CustomPoolType types may be added over time.

Name Type Description
Capacity

string

Capacity level custom pool
Workspace

string

Workspace level custom pool

DynamicExecutorAllocationProperties

Dynamic executor allocation proerties.

Name Type Description
enabled

boolean

The status of the dynamic executor allocation. False - Disabled, true - Enabled.
maxExecutors

integer

The maximum executors.
minExecutors

integer

The minimum executors.

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.

NodeFamily

Node family. Additional NodeFamily types may be added over time.

Name Type Description
MemoryOptimized

string

Memory optimized

NodeSize

Node size. Additional NodeSize types may be added over time.

Name Type Description
Large

string

Large node size
Medium

string

Medium node size
Small

string

Small node size
XLarge

string

XLarge node size
XXLarge

string

XXLarge node size