Edit

Share via

Published - Get Spark Compute (preview)

Service:
Environment
API Version:
v1

Get environment spark compute.

Note

This API is part of a Preview release and is provided for evaluation and development purposes only. It may change based on feedback and is not recommended for production use. This preview API will be deprecated on March 1, 2026, and replaced by a stable version, available here. The new version introduces breaking changes and is not backward compatible. When calling this API, callers must specify true as the value for the query parameter preview.

Deprecation Notice

A new query parameter preview has been introduced to facilitate this transition:

  • The preview query parameter currently defaults to true.
  • Set the value of the preview query parameter to false to use the stable Release version of this API.
  • Starting March 1, 2026, the default value for preview will change to false.

To ensure compatibility, explicitly set the preview parameter to your desired value (true or false).

It is recommended to migrate your integration to use the Release version as soon as possible by specifying false for the preview query parameter (the default value for the preview query parameter will be set to false on API's deprecation date).

The following incompatible changes were introduced in the Release version:

  • Response property sparkProperties's type was changed from object to the list of SparkProperty.

Permissions

Read permission for the environment item.

Required Delegated Scopes

Item.Read.All or Item.ReadWrite.All or Environment.Read.All or Environment.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity Support
User Yes
Service principal and Managed identities Yes

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/environments/{environmentId}/sparkcompute?preview={preview}

URI Parameters

Name In Required Type Description
environmentId
 path True

string (uuid)

The environment ID.
workspaceId
 path True

string (uuid)

The workspace ID.
preview
 query True

boolean

This parameter specifies which version of the API to use. Set to true to use the preview version described on this page, or to false to use the Release version detailed here. Starting March 1, 2026, the default value for preview will change to false.

Responses

Name Type Description
200 OK

EnvironmentSparkComputePreview

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Get environment Spark compute example

Sample request

GET https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/environments/707cfd07-cbf1-41da-aad7-dd157ddb8c11/sparkcompute?preview=True

Sample response

Status code:
200 
{
  "instancePool": {
    "name": "MyWorkspacePool",
    "type": "Workspace",
    "id": "78942136-106c-4f3e-80fc-7ff4eae11603"
  },
  "driverCores": 4,
  "driverMemory": "56g",
  "executorCores": 4,
  "executorMemory": "56g",
  "dynamicExecutorAllocation": {
    "enabled": false,
    "minExecutors": 1,
    "maxExecutors": 1
  },
  "sparkProperties": {
    "spark.acls.enable": "false"
  },
  "runtimeVersion": "1.2"
}

Definitions

Name Description
CustomPoolType

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

Dynamic executor allocation proerties.
EnvironmentSparkComputePreview
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
InstancePool

An instance of a pool.

CustomPoolType

Enumeration

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

Value Description
Workspace

Workspace custom pool
Capacity

Capacity custom pool

DynamicExecutorAllocationProperties

Object

Dynamic executor allocation proerties.

Name Type Description
enabled

boolean

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

integer (int32)

minimum: 1

The maximum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than the instance pool maxNodeCount.
minExecutors

integer (int32)

minimum: 1

The minimum executor number for dynamic allocation and the minimum for this property is 1. The maximum value has to be lower than maxExecutors.

EnvironmentSparkComputePreview

Object
Name Type Description
driverCores

integer (int32)

Spark driver core. Must be one of the following values: 4, 8, 16, 32, 64.
driverMemory

string

Spark driver memory.
dynamicExecutorAllocation

DynamicExecutorAllocationProperties

Dynamic executor allocation.
executorCores

integer (int32)

Spark executor core. Must be one of the following values: 4, 8, 16, 32, 64.
executorMemory

string

Spark executor memory.
instancePool

InstancePool

Environment pool has to be a valid custom pool. "Starter Pool" means use starter pool.
runtimeVersion

string

Runtime version, find the supported fabric runtimes.
sparkProperties

object

Spark properties. The dictionary-based contract for defining Spark properties will be deprecated on January 31, 2026. Please migrate to using a list of key-value pairs instead.

ErrorRelatedResource

Object

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

Object

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

Object

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.

InstancePool

Object

An instance of a pool.

Name Type Description
id

string (uuid)

Instance pool ID.
name

string

Instance pool name.
type

CustomPoolType

Instance pool type.