SynapseSparkJobDefinitionActivity interface

パッケージ:

@azure/synapse-artifacts

Spark ジョブ アクティビティを実行します。

Extends

ExecutionActivity

プロパティ

arguments	SynapseSparkJobDefinitionActivity に対してユーザーが指定した引数。
authentication	Spark ジョブ定義の実行に使用される認証方法。
className	指定した Spark ジョブ定義の 'className' をオーバーライドする、完全修飾識別子またはメイン定義ファイル内のメイン クラス。 型: string (または resultType 文字列を含む式)。
conf	Spark 構成プロパティ。指定した Spark ジョブ定義の "conf" をオーバーライドします。
configurationType	Spark 構成の種類。
driverSize	ジョブの指定された Spark プールに割り当てられたドライバーに使用されるコアとメモリの数。これは、指定した Spark ジョブ定義の 'driverCores' と 'driverMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
executorSize	ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。これは、指定した Spark ジョブ定義の 'executorCores' と 'executorMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
file	ジョブに使用されるメイン ファイル。指定した Spark ジョブ定義の 'file' がオーバーライドされます。 型: string (または resultType 文字列を含む式)。
files	(非推奨。pythonCodeReference と filesV2 を使用してください)メイン定義ファイルの参照に使用される追加のファイル。これは、指定した Spark ジョブ定義の 'files' をオーバーライドします。
filesV2	メイン定義ファイルの参照に使用される追加のファイル。これは、指定した Spark ジョブ定義の 'jars' と 'files' をオーバーライドします。
numExecutors	このジョブで起動する Executor の数。これにより、指定した Spark ジョブ定義の 'numExecutors' がオーバーライドされます。 型: 整数 (または resultType 整数を持つ式)。
pythonCodeReference	メイン定義ファイルの参照に使用される追加の Python コード ファイル。これは、指定した Spark ジョブ定義の 'pyFiles' をオーバーライドします。
scanFolder	メイン定義ファイルのルート フォルダーからサブフォルダーをスキャンすると、これらのファイルが参照ファイルとして追加されます。 'jars'、'pyFiles'、'files' または 'archives' という名前のフォルダーがスキャンされ、フォルダー名では大文字と小文字が区別されます。 型: boolean (または resultType ブール値を持つ式)。
sparkConfig	Spark 構成プロパティ。
sparkJob	Synapse Spark ジョブリファレンス。
targetBigDataPool	Spark バッチ ジョブの実行に使用されるビッグ データ プールの名前。指定した Spark ジョブ定義の 'targetBigDataPool' をオーバーライドします。
targetSparkConfiguration	Spark ジョブの Spark 構成。
type	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

継承されたプロパティ

dependsOn	アクティビティは条件によって異なります。
description	アクティビティの説明。
linkedServiceName	リンクされたサービス参照。
name	アクティビティ名。
onInactiveMarkAs	状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。
policy	アクティビティ ポリシー。
state	アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。
userProperties	アクティビティ ユーザーのプロパティ。

プロパティの詳細

arguments

SynapseSparkJobDefinitionActivity に対してユーザーが指定した引数。

arguments?: any[]

プロパティ値

any[]

authentication

Spark ジョブ定義の実行に使用される認証方法。

authentication?: SynapseActivityAuthentication

プロパティ値

SynapseActivityAuthentication

className

指定した Spark ジョブ定義の 'className' をオーバーライドする、完全修飾識別子またはメイン定義ファイル内のメイン クラス。 型: string (または resultType 文字列を含む式)。

className?: any

プロパティ値

any

conf

Spark 構成プロパティ。指定した Spark ジョブ定義の "conf" をオーバーライドします。

conf?: any

プロパティ値

any

configurationType

Spark 構成の種類。

configurationType?: string

プロパティ値

string

driverSize

ジョブの指定された Spark プールに割り当てられたドライバーに使用されるコアとメモリの数。これは、指定した Spark ジョブ定義の 'driverCores' と 'driverMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。

driverSize?: any

プロパティ値

any

executorSize

ジョブの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。これは、指定した Spark ジョブ定義の 'executorCores' と 'executorMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。

executorSize?: any

プロパティ値

any

file

ジョブに使用されるメイン ファイル。指定した Spark ジョブ定義の 'file' がオーバーライドされます。 型: string (または resultType 文字列を含む式)。

file?: any

プロパティ値

any

files

(非推奨。pythonCodeReference と filesV2 を使用してください)メイン定義ファイルの参照に使用される追加のファイル。これは、指定した Spark ジョブ定義の 'files' をオーバーライドします。

files?: any[]

プロパティ値

any[]

filesV2

メイン定義ファイルの参照に使用される追加のファイル。これは、指定した Spark ジョブ定義の 'jars' と 'files' をオーバーライドします。

filesV2?: any[]

プロパティ値

any[]

numExecutors

このジョブで起動する Executor の数。これにより、指定した Spark ジョブ定義の 'numExecutors' がオーバーライドされます。 型: 整数 (または resultType 整数を持つ式)。

numExecutors?: any

プロパティ値

any

pythonCodeReference

メイン定義ファイルの参照に使用される追加の Python コード ファイル。これは、指定した Spark ジョブ定義の 'pyFiles' をオーバーライドします。

pythonCodeReference?: any[]

プロパティ値

any[]

scanFolder

メイン定義ファイルのルート フォルダーからサブフォルダーをスキャンすると、これらのファイルが参照ファイルとして追加されます。 'jars'、'pyFiles'、'files' または 'archives' という名前のフォルダーがスキャンされ、フォルダー名では大文字と小文字が区別されます。 型: boolean (または resultType ブール値を持つ式)。

scanFolder?: any

プロパティ値

any

sparkConfig

Spark 構成プロパティ。

sparkConfig?: {[propertyName: string]: any}

プロパティ値

{[propertyName: string]: any}

sparkJob

Synapse Spark ジョブリファレンス。

sparkJob: SynapseSparkJobReference

プロパティ値

SynapseSparkJobReference

targetBigDataPool

Spark バッチ ジョブの実行に使用されるビッグ データ プールの名前。指定した Spark ジョブ定義の 'targetBigDataPool' をオーバーライドします。

targetBigDataPool?: BigDataPoolParametrizationReference

プロパティ値

BigDataPoolParametrizationReference

targetSparkConfiguration

Spark ジョブの Spark 構成。

targetSparkConfiguration?: SparkConfigurationParametrizationReference

プロパティ値

SparkConfigurationParametrizationReference

type

ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

type: "SparkJob"

プロパティ値

"SparkJob"

継承されたプロパティの詳細

dependsOn

アクティビティは条件によって異なります。

dependsOn?: ActivityDependency[]

プロパティ値

ActivityDependency[]

ExecutionActivity.dependsOnから継承

description

アクティビティの説明。

description?: string

プロパティ値

string

ExecutionActivity.descriptionから継承

linkedServiceName

リンクされたサービス参照。

linkedServiceName?: LinkedServiceReference

プロパティ値

LinkedServiceReference

ExecutionActivity.linkedServiceNameから継承

name

アクティビティ名。

name: string

プロパティ値

string

ExecutionActivity.name から継承

onInactiveMarkAs

状態が非アクティブに設定されている場合のアクティビティの状態の結果。 これは省略可能なプロパティであり、アクティビティが非アクティブのときに指定されていない場合、状態は既定で Succeeded になります。

onInactiveMarkAs?: string

プロパティ値

string

ExecutionActivity.onInactiveMarkAsから継承

policy

アクティビティ ポリシー。

policy?: ActivityPolicy

プロパティ値

ActivityPolicy

ExecutionActivity.policyから継承

state

アクティビティの状態。 これは省略可能なプロパティであり、指定しない場合、状態は既定でアクティブになります。

state?: string

プロパティ値

string

ExecutionActivity.stateから継承

userProperties

アクティビティ ユーザーのプロパティ。

userProperties?: UserProperty[]

プロパティ値

UserProperty[]

ExecutionActivity.userPropertiesから継承