Custom Pools - Create Workspace Custom Pool

Service:

Spark

API Version:

v1

Note

This API is in preview.

Create custom pool.

Permissions

The caller must have admin workspace role.

Required Delegated Scopes

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

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools

URI Parameters

Name	In	Required	Type	Description
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Required	Type	Description
autoScale	True	AutoScaleProperties	Autoscale.
dynamicExecutorAllocation	True	DynamicExecutorAllocationProperties	Dynamic executor allocation.
name	True	string	Custom pool name. The name must be between 1 and 64 characters long and must contain only letters, numbers, dashes, underscores and spaces. Custom pool names must be unique within the workspace. "Starter Pool" is a reserved custom pool name.
nodeFamily	True	NodeFamily	Node family.
nodeSize	True	NodeSize	Node size.

Responses

Name	Type	Description
201 Created	CustomPool	Request completed successfully. Headers Location: string
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Create custom pool example

Sample request

HTTP

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

{
  "name": "pool1",
  "nodeFamily": "MemoryOptimized",
  "nodeSize": "Small",
  "autoScale": {
    "enabled": true,
    "minNodeCount": 1,
    "maxNodeCount": 2
  },
  "dynamicExecutorAllocation": {
    "enabled": true,
    "minExecutors": 1,
    "maxExecutors": 1
  }
}

Sample response

Status code:

201

Location: https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/spark/pools/2367293d-b70b-4b33-97f2-161b8d04a8d7

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

Definitions

Name	Description
AutoScaleProperties	Autoscale properties.
CreateCustomPoolRequest	Create custom pool request payload.
CustomPool	Custom pool.
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.

CreateCustomPoolRequest

Create custom pool request payload.

Name	Type	Description
autoScale	AutoScaleProperties	Autoscale.
dynamicExecutorAllocation	DynamicExecutorAllocationProperties	Dynamic executor allocation.
name	string	Custom pool name. The name must be between 1 and 64 characters long and must contain only letters, numbers, dashes, underscores and spaces. Custom pool names must be unique within the workspace. "Starter Pool" is a reserved custom pool name.
nodeFamily	NodeFamily	Node family.
nodeSize	NodeSize	Node size.

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.

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