SynapseNotebookActivity interface

パッケージ:

@azure/synapse-artifacts

Synapse ノートブック アクティビティを実行します。

Extends

ExecutionActivity

プロパティ

authentication	ノートブックの実行に使用される認証方法。
conf	Spark 構成プロパティ。指定したノートブックの 'conf' をオーバーライドします。
configurationType	Spark 構成の種類。
driverSize	セッションの指定された Spark プールに割り当てられたドライバーに使用されるコアとメモリの数。これは、指定したノートブックの 'driverCores' と 'driverMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
executorSize	セッションの指定された Spark プールに割り当てられた Executor に使用されるコアとメモリの数。これは、指定したノートブックの 'executorCores' と 'executorMemory' をオーバーライドするために使用されます。 型: string (または resultType 文字列を含む式)。
notebook	Synapse Notebook リファレンス。
numExecutors	このセッションで起動する Executor の数。これにより、指定したノートブックの 'numExecutors' がオーバーライドされます。 型: 整数 (または resultType 整数を持つ式)。
parameters	ノートブックのパラメーター。
sparkConfig	Spark 構成プロパティ。
sparkPool	ノートブックの実行に使用されるビッグ データ プールの名前。
targetSparkConfiguration	Spark ジョブの Spark 構成。
type	ポリモーフィック識別子。このオブジェクトは、さまざまな型を指定します。

継承されたプロパティ

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

プロパティの詳細

authentication

ノートブックの実行に使用される認証方法。

authentication?: SynapseActivityAuthentication

プロパティ値

SynapseActivityAuthentication

conf

Spark 構成プロパティ。指定したノートブックの 'conf' をオーバーライドします。

conf?: any

プロパティ値

any

configurationType

Spark 構成の種類。

configurationType?: string

プロパティ値

string

driverSize

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

driverSize?: any

プロパティ値

any

executorSize

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

executorSize?: any

プロパティ値

any

notebook

Synapse Notebook リファレンス。

notebook: SynapseNotebookReference

プロパティ値

SynapseNotebookReference

numExecutors

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

numExecutors?: any

プロパティ値

any

parameters

ノートブックのパラメーター。

parameters?: {[propertyName: string]: NotebookParameter}

プロパティ値

{[propertyName: string]: NotebookParameter}

sparkConfig

Spark 構成プロパティ。

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

プロパティ値

{[propertyName: string]: any}

sparkPool

ノートブックの実行に使用されるビッグ データ プールの名前。

sparkPool?: BigDataPoolParametrizationReference

プロパティ値

BigDataPoolParametrizationReference

targetSparkConfiguration

Spark ジョブの Spark 構成。

targetSparkConfiguration?: SparkConfigurationParametrizationReference

プロパティ値

SparkConfigurationParametrizationReference

type

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

type: "SynapseNotebook"

プロパティ値

"SynapseNotebook"

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

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から継承