你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SparkBatch interface

包:
@azure/synapse-spark

表示 SparkBatch 的接口。

方法

cancelSparkBatchJob(number, SparkBatchCancelSparkBatchJobOptionalParams)

取消正在运行的 Spark 批处理作业。
createSparkBatchJob(SparkBatchJobOptions, SparkBatchCreateSparkBatchJobOptionalParams)

创建新的 Spark 批处理作业。
getSparkBatchJob(number, SparkBatchGetSparkBatchJobOptionalParams)

获取单个 Spark 批处理作业。
getSparkBatchJobs(SparkBatchGetSparkBatchJobsOptionalParams)

列出在特定 Spark 池下运行的所有 Spark 批处理作业。

方法详细信息

cancelSparkBatchJob(number, SparkBatchCancelSparkBatchJobOptionalParams)

取消正在运行的 Spark 批处理作业。

function cancelSparkBatchJob(batchId: number, options?: SparkBatchCancelSparkBatchJobOptionalParams): Promise<void>

参数

batchId

number

批处理作业的标识符。

options
SparkBatchCancelSparkBatchJobOptionalParams

选项参数。

返回

Promise<void>

createSparkBatchJob(SparkBatchJobOptions, SparkBatchCreateSparkBatchJobOptionalParams)

创建新的 Spark 批处理作业。

function createSparkBatchJob(sparkBatchJobOptions: SparkBatchJobOptions, options?: SparkBatchCreateSparkBatchJobOptionalParams): Promise<SparkBatchJob>

参数

sparkBatchJobOptions
SparkBatchJobOptions

Livy 兼容的批处理作业请求有效负载。

options
SparkBatchCreateSparkBatchJobOptionalParams

选项参数。

返回

Promise<SparkBatchJob>

getSparkBatchJob(number, SparkBatchGetSparkBatchJobOptionalParams)

获取单个 Spark 批处理作业。

function getSparkBatchJob(batchId: number, options?: SparkBatchGetSparkBatchJobOptionalParams): Promise<SparkBatchJob>

参数

batchId

number

批处理作业的标识符。

options
SparkBatchGetSparkBatchJobOptionalParams

选项参数。

返回

Promise<SparkBatchJob>

getSparkBatchJobs(SparkBatchGetSparkBatchJobsOptionalParams)

列出在特定 Spark 池下运行的所有 Spark 批处理作业。

function getSparkBatchJobs(options?: SparkBatchGetSparkBatchJobsOptionalParams): Promise<SparkBatchJobCollection>

参数

options
SparkBatchGetSparkBatchJobsOptionalParams

选项参数。

返回

Promise<SparkBatchJobCollection>