Edit

Share via

Workspace Settings - Update Spark Settings

Service:
Spark
API Version:
v1

Update workspace spark settings.

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 and Managed identities Yes

Interface

PATCH https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/spark/settings

URI Parameters

Name In Required Type Description
workspaceId
 path True

string (uuid)

The workspace ID.

Request Body

Name Type Description
automaticLog

AutomaticLogProperties

Automatic log settings.
environment

EnvironmentProperties

Environment settings.
highConcurrency

HighConcurrencyProperties

High concurrency settings.
job

SparkJobsProperties

Job management settings.
pool

PoolProperties

Pool settings.

Responses

Name Type Description
200 OK

WorkspaceSparkSettings

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Update workspace Spark settings default pool using pool ID example
Update workspace Spark settings example

Update workspace Spark settings default pool using pool ID example

Sample request

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

{
  "pool": {
    "defaultPool": {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  }
}

Sample response

Status code:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  }
}

Update workspace Spark settings example

Sample request

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

{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Sample response

Status code:
200 
{
  "automaticLog": {
    "enabled": false
  },
  "highConcurrency": {
    "notebookInteractiveRunEnabled": false,
    "notebookPipelineRunEnabled": false
  },
  "pool": {
    "customizeComputeEnabled": false,
    "defaultPool": {
      "name": "Starter Pool",
      "type": "Workspace",
      "id": "00000000-0000-0000-0000-000000000000"
    },
    "starterPool": {
      "maxNodeCount": 3,
      "maxExecutors": 1
    }
  },
  "environment": {
    "name": "environment1",
    "runtimeVersion": "1.2"
  },
  "job": {
    "conservativeJobAdmissionEnabled": false,
    "sessionTimeoutInMinutes": 20
  }
}

Definitions

Name Description
AutomaticLogProperties

Automatic Log Properties.
CustomPoolType

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

Properties of an environment.
ErrorRelatedResource

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
HighConcurrencyProperties

High Concurrency Properties.
InstancePool
PoolProperties

Properties of a pool
SparkJobsProperties

Properties of a Spark job.
StarterPoolProperties

Custom starter pool.
UpdateWorkspaceSparkSettingsRequest

Update workspace Spark settings request payload.
WorkspaceSparkSettings

Workspace Spark settings.

AutomaticLogProperties

Object

Automatic Log Properties.

Name Type Description
enabled

boolean

The status of the automatic log. False - Disabled, true - Enabled.

CustomPoolType

Enumeration

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

Value Description
Workspace

Workspace level custom pool
Capacity

Capacity level custom pool

EnvironmentProperties

Object

Properties of an environment.

Name Type Description
name

string

The name of the default environment. Empty string indicated there is no workspace default environment.
runtimeVersion

string

Runtime version. For example: 1.3

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.

HighConcurrencyProperties

Object

High Concurrency Properties.

Name Type Description
notebookInteractiveRunEnabled

boolean

The status of the high concurrency for notebook interactive run. False - Disabled, true - Enabled.
notebookPipelineRunEnabled

boolean

The status of the high concurrency for notebook pipeline run. False - Disabled, true - Enabled.

InstancePool

Object
Name Type Description
id

string (uuid)

Instance pool ID.
name

string

Instance pool name.
type

CustomPoolType

Instance pool type.

PoolProperties

Object

Properties of a pool

Name Type Description
customizeComputeEnabled

boolean

Customize compute configurations for items. False - Disabled, true - Enabled.
defaultPool

InstancePool

Default pool for workspace. It should be a valid custom pool name. "Starter Pool" means use starter pool.
starterPool

StarterPoolProperties

Customize starter pool. For more information about configuring starter pool, see configuring starter pool.

SparkJobsProperties

Object

Properties of a Spark job.

Name Type Description
conservativeJobAdmissionEnabled

boolean

Reserve maximum cores for active Spark jobs. When this setting is enabled, your Fabric capacity reserves the maximum number of cores needed for active Spark jobs, ensuring job reliability by making sure that cores are available if a job scales up. When this setting is disabled, jobs are started based on the minimum number of cores needed, letting more jobs run at the same time. For more information see job admission and management. False - Disabled, true - Enabled.
sessionTimeoutInMinutes

integer (int32)

minimum: 1
maximum: 20160

Time to terminate inactive Spark sessions. The maximum is 14 days.

StarterPoolProperties

Object

Custom starter pool.

Name Type Description
maxExecutors

integer (int32)

minimum: 1

The maximum executors count.
maxNodeCount

integer (int32)

minimum: 1

The maximum node count.

UpdateWorkspaceSparkSettingsRequest

Object

Update workspace Spark settings request payload.

Name Type Description
automaticLog

AutomaticLogProperties

Automatic log settings.
environment

EnvironmentProperties

Environment settings.
highConcurrency

HighConcurrencyProperties

High concurrency settings.
job

SparkJobsProperties

Job management settings.
pool

PoolProperties

Pool settings.

WorkspaceSparkSettings

Object

Workspace Spark settings.

Name Type Description
automaticLog

AutomaticLogProperties

Automatic log settings.
environment

EnvironmentProperties

Environment settings.
highConcurrency

HighConcurrencyProperties

High concurrency settings.
job

SparkJobsProperties

Job management settings.
pool

PoolProperties

Pool settings.