SynapseNotebookActivity.yml

### YamlMime:TSType
name: SynapseNotebookActivity
uid: '@azure/arm-datafactory.SynapseNotebookActivity'
package: '@azure/arm-datafactory'
summary: Execute Synapse notebook activity.
fullName: SynapseNotebookActivity
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: conf
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.conf'
    package: '@azure/arm-datafactory'
    summary: >-
      Spark configuration properties, which will override the 'conf' of the
      notebook you provide.
    fullName: conf
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'conf?: any'
      return:
        description: ''
        type: any
  - name: configurationType
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.configurationType'
    package: '@azure/arm-datafactory'
    summary: The type of the spark config.
    fullName: configurationType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'configurationType?: string'
      return:
        description: ''
        type: string
  - name: driverSize
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.driverSize'
    package: '@azure/arm-datafactory'
    summary: >-
      Number of core and memory to be used for driver allocated in the specified
      Spark pool for the session, which will be used for overriding
      'driverCores' and 'driverMemory' of the notebook you provide. Type: string
      (or Expression with resultType string).
    fullName: driverSize
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'driverSize?: any'
      return:
        description: ''
        type: any
  - name: executorSize
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.executorSize'
    package: '@azure/arm-datafactory'
    summary: >-
      Number of core and memory to be used for executors allocated in the
      specified Spark pool for the session, which will be used for overriding
      'executorCores' and 'executorMemory' of the notebook you provide. Type:
      string (or Expression with resultType string).
    fullName: executorSize
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'executorSize?: any'
      return:
        description: ''
        type: any
  - name: notebook
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.notebook'
    package: '@azure/arm-datafactory'
    summary: Synapse notebook reference.
    fullName: notebook
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'notebook: SynapseNotebookReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.SynapseNotebookReference" />
  - name: numExecutors
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.numExecutors'
    package: '@azure/arm-datafactory'
    summary: >-
      Number of executors to launch for this session, which will override the
      'numExecutors' of the notebook you provide. Type: integer (or Expression
      with resultType integer).
    fullName: numExecutors
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'numExecutors?: any'
      return:
        description: ''
        type: any
  - name: parameters
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.parameters'
    package: '@azure/arm-datafactory'
    summary: Notebook parameters.
    fullName: parameters
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'parameters?: {[propertyName: string]: NotebookParameter}'
      return:
        description: ''
        type: >-
          {[propertyName: string]: <xref
          uid="@azure/arm-datafactory.NotebookParameter" />}
  - name: sparkConfig
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.sparkConfig'
    package: '@azure/arm-datafactory'
    summary: Spark configuration property.
    fullName: sparkConfig
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sparkConfig?: {[propertyName: string]: any}'
      return:
        description: ''
        type: '{[propertyName: string]: any}'
  - name: sparkPool
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.sparkPool'
    package: '@azure/arm-datafactory'
    summary: The name of the big data pool which will be used to execute the notebook.
    fullName: sparkPool
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'sparkPool?: BigDataPoolParametrizationReference'
      return:
        description: ''
        type: >-
          <xref uid="@azure/arm-datafactory.BigDataPoolParametrizationReference"
          />
  - name: targetSparkConfiguration
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.targetSparkConfiguration'
    package: '@azure/arm-datafactory'
    summary: The spark configuration of the spark job.
    fullName: targetSparkConfiguration
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'targetSparkConfiguration?: SparkConfigurationParametrizationReference'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/arm-datafactory.SparkConfigurationParametrizationReference"
          />
  - name: type
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.type'
    package: '@azure/arm-datafactory'
    summary: >-
      Polymorphic discriminator, which specifies the different types this object
      can be
    fullName: type
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'type: "SynapseNotebook"'
      return:
        description: ''
        type: '"SynapseNotebook"'
inheritedProperties:
  - name: dependsOn
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.dependsOn'
    package: '@azure/arm-datafactory'
    summary: Activity depends on condition.
    fullName: dependsOn
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'dependsOn?: ActivityDependency[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.ActivityDependency" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.dependsOn](xref:@azure/arm-datafactory.ExecutionActivity.dependsOn)
  - name: description
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.description'
    package: '@azure/arm-datafactory'
    summary: Activity description.
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.description](xref:@azure/arm-datafactory.ExecutionActivity.description)
  - name: linkedServiceName
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.linkedServiceName'
    package: '@azure/arm-datafactory'
    summary: Linked service reference.
    fullName: linkedServiceName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'linkedServiceName?: LinkedServiceReference'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.LinkedServiceReference" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.linkedServiceName](xref:@azure/arm-datafactory.ExecutionActivity.linkedServiceName)
  - name: name
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.name'
    package: '@azure/arm-datafactory'
    summary: Activity name.
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.name](xref:@azure/arm-datafactory.ExecutionActivity.name)
  - name: onInactiveMarkAs
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.onInactiveMarkAs'
    package: '@azure/arm-datafactory'
    summary: >-
      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.
    fullName: onInactiveMarkAs
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onInactiveMarkAs?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.onInactiveMarkAs](xref:@azure/arm-datafactory.ExecutionActivity.onInactiveMarkAs)
  - name: policy
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.policy'
    package: '@azure/arm-datafactory'
    summary: Activity policy.
    fullName: policy
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'policy?: ActivityPolicy'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.ActivityPolicy" />
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.policy](xref:@azure/arm-datafactory.ExecutionActivity.policy)
  - name: state
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.state'
    package: '@azure/arm-datafactory'
    summary: >-
      Activity state. This is an optional property and if not provided, the
      state will be Active by default.
    fullName: state
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'state?: string'
      return:
        description: ''
        type: string
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.state](xref:@azure/arm-datafactory.ExecutionActivity.state)
  - name: userProperties
    uid: '@azure/arm-datafactory.SynapseNotebookActivity.userProperties'
    package: '@azure/arm-datafactory'
    summary: Activity user properties.
    fullName: userProperties
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userProperties?: UserProperty[]'
      return:
        description: ''
        type: <xref uid="@azure/arm-datafactory.UserProperty" />[]
    inheritanceDescription: >-
      <b>Inherited From</b>
      [ExecutionActivity.userProperties](xref:@azure/arm-datafactory.ExecutionActivity.userProperties)
extends: <xref uid="@azure/arm-datafactory.ExecutionActivity" />