SqlPoolStoredProcedureActivity interface

Package:

@azure/synapse-artifacts

Execute SQL pool stored procedure activity.

Extends

Activity

Properties

sqlPool	SQL pool stored procedure reference.
storedProcedureName	Stored procedure name. Type: string (or Expression with resultType string).
storedProcedureParameters	Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".
type	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

dependsOn	Activity depends on condition.
description	Activity description.
name	Activity name.
onInactiveMarkAs	Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.
state	Activity state. This is an optional property and if not provided, the state will be Active by default.
userProperties	Activity user properties.

Property Details

sqlPool

SQL pool stored procedure reference.

sqlPool: SqlPoolReference

Property Value

SqlPoolReference

storedProcedureName

Stored procedure name. Type: string (or Expression with resultType string).

storedProcedureName: any

Property Value

any

storedProcedureParameters

Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}".

storedProcedureParameters?: any

Property Value

any

type

Polymorphic discriminator, which specifies the different types this object can be

type: "SqlPoolStoredProcedure"

Property Value

"SqlPoolStoredProcedure"

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From Activity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From Activity.description

name

Activity name.

name: string

Property Value

string

Inherited From Activity.name

onInactiveMarkAs

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

onInactiveMarkAs?: string

Property Value

string

Inherited From Activity.onInactiveMarkAs

state

Activity state. This is an optional property and if not provided, the state will be Active by default.

state?: string

Property Value

string

Inherited From Activity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From Activity.userProperties