RunNotebookSparkSessionOptions interface

Package:

@azure/synapse-artifacts

Properties

archives	Archives to be used in this session
configuration	Spark configuration properties
driverCores	Number of cores to use for the driver process
driverMemory	Amount of memory to use for the driver process
executorCores	Number of cores to use for each executor
executorCount	Number of executors to launch for this session
executorMemory	Amount of memory to use per executor process
files	files to be used in this session
heartbeatTimeoutInSecond	Timeout in second to which session be orphaned
isQueueable	Whether to queue session creation if Spark pool doesn't have enough capacity. Default value is true in notebook runs API
jars	jars to be used in this session
kind	The session kind
name	The name of this session
proxyUser	User to impersonate when starting the session
pythonFiles	Python files to be used in this session
queue	The name of the YARN queue to which submitted
tags	Dictionary of <string>

Property Details

archives

Archives to be used in this session

archives?: string[]

Property Value

string[]

configuration

Spark configuration properties

configuration?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

driverCores

Number of cores to use for the driver process

driverCores?: number

Property Value

number

driverMemory

Amount of memory to use for the driver process

driverMemory?: string

Property Value

string

executorCores

Number of cores to use for each executor

executorCores?: number

Property Value

number

executorCount

Number of executors to launch for this session

executorCount?: number

Property Value

number

executorMemory

Amount of memory to use per executor process

executorMemory?: string

Property Value

string

files

files to be used in this session

files?: string[]

Property Value

string[]

heartbeatTimeoutInSecond

Timeout in second to which session be orphaned

heartbeatTimeoutInSecond?: number

Property Value

number

isQueueable

Whether to queue session creation if Spark pool doesn't have enough capacity. Default value is true in notebook runs API

isQueueable?: boolean

Property Value

boolean

jars

jars to be used in this session

jars?: string[]

Property Value

string[]

kind

The session kind

kind?: string

Property Value

string

name

The name of this session

name?: string

Property Value

string

proxyUser

User to impersonate when starting the session

proxyUser?: string

Property Value

string

pythonFiles

Python files to be used in this session

pythonFiles?: string[]

Property Value

string[]

queue

The name of the YARN queue to which submitted

queue?: any

Property Value

any

tags

Dictionary of <string>

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}