Custom Pools - Create Workspace Custom Pool
Note
This API is in preview.
Create custom pool.
Permissions
The caller must have Admin role on the workspace.
Required Delegated Scopes
Workspace.ReadWrite.All
POST http://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/pools
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
autoScale | True |
Autoscale. |
|
dynamicExecutorAllocation | True |
Dynamic executor allocation. |
|
name | True |
string |
Custom pool name. |
nodeFamily | True |
Node family. |
|
nodeSize | True |
Node size. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
Request completed successfully. Headers Location: string |
|
Other Status Codes |
Common error codes:
|
Examples
Create custom pool example
Sample request
POST http://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
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 |
---|---|
Auto |
Autoscale properties. |
Create |
Create custom pool request payload. |
Custom |
Custom pool. |
Custom |
Custom pool type. Additional |
Dynamic |
Dynamic executor allocation proerties. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Node |
Node family. Additional |
Node |
Node size. Additional |
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 |
Autoscale. |
|
dynamicExecutorAllocation |
Dynamic executor allocation. |
|
name |
string |
Custom pool name. |
nodeFamily |
Node family. |
|
nodeSize |
Node size. |
CustomPool
Custom pool.
Name | Type | Description |
---|---|---|
autoScale |
Autoscale. |
|
dynamicExecutorAllocation |
Dynamic executor allocation. |
|
id |
string |
Custom pool ID. |
name |
string |
Custom pool name. |
nodeFamily |
Node family. |
|
nodeSize |
Node size. |
|
type |
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 |
List of additional error details. |
|
relatedResource |
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 |
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 |