Skip to content

Commit c424256

Browse files
wanyang7wanyang7
authored
[DataFactory] Add synapse spark activities (#19769)
* add spark activities into adf * add reference * .\specification\
1 parent 5353589 commit c424256

File tree

4 files changed

+341
-3
lines changed

4 files changed

+341
-3
lines changed

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6878,6 +6878,43 @@
68786878
"servicePrincipalId",
68796879
"servicePrincipalKey"
68806880
]
6881+
},
6882+
"AzureSynapseArtifactsLinkedService": {
6883+
"x-ms-discriminator-value": "AzureSynapseArtifacts",
6884+
"description": "Azure Synapse Analytics (Artifacts) linked service.",
6885+
"type": "object",
6886+
"allOf": [
6887+
{
6888+
"$ref": "#/definitions/LinkedService"
6889+
}
6890+
],
6891+
"properties": {
6892+
"typeProperties": {
6893+
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
6894+
"x-ms-client-flatten": true,
6895+
"$ref": "#/definitions/AzureSynapseArtifactsLinkedServiceTypeProperties"
6896+
}
6897+
},
6898+
"required": [
6899+
"typeProperties"
6900+
]
6901+
},
6902+
"AzureSynapseArtifactsLinkedServiceTypeProperties": {
6903+
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
6904+
"type": "object",
6905+
"properties": {
6906+
"endpoint": {
6907+
"type": "object",
6908+
"description": "https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string)."
6909+
},
6910+
"authentication": {
6911+
"type": "object",
6912+
"description": "Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string)."
6913+
}
6914+
},
6915+
"required": [
6916+
"endpoint"
6917+
]
68816918
}
68826919
}
68836920
}

‎specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json‎

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7769,6 +7769,250 @@
77697769
"description": "Metadata item value. Type: string (or Expression with resultType string)."
77707770
}
77717771
}
7772+
},
7773+
"SynapseNotebookActivity": {
7774+
"description": "Execute Synapse notebook activity.",
7775+
"type": "object",
7776+
"x-ms-discriminator-value": "SynapseNotebook",
7777+
"allOf": [
7778+
{
7779+
"$ref": "#/definitions/ExecutionActivity"
7780+
}
7781+
],
7782+
"properties": {
7783+
"typeProperties": {
7784+
"x-ms-client-flatten": true,
7785+
"description": "Execute Synapse notebook activity properties.",
7786+
"$ref": "#/definitions/SynapseNotebookActivityTypeProperties"
7787+
}
7788+
},
7789+
"required": [
7790+
"typeProperties"
7791+
]
7792+
},
7793+
"SynapseNotebookActivityTypeProperties": {
7794+
"description": "Execute Synapse notebook activity properties.",
7795+
"type": "object",
7796+
"properties": {
7797+
"notebook": {
7798+
"description": "Synapse notebook reference.",
7799+
"$ref": "#/definitions/SynapseNotebookReference"
7800+
},
7801+
"sparkPool": {
7802+
"description": "The name of the big data pool which will be used to execute the notebook.",
7803+
"$ref": "#/definitions/BigDataPoolParametrizationReference"
7804+
},
7805+
"parameters": {
7806+
"description": "Notebook parameters.",
7807+
"type": "object",
7808+
"additionalProperties": {
7809+
"$ref": "#/definitions/NotebookParameter"
7810+
}
7811+
},
7812+
"executorSize": {
7813+
"type": "object",
7814+
"description": "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)."
7815+
},
7816+
"conf": {
7817+
"type": "object",
7818+
"description": "Spark configuration properties, which will override the 'conf' of the notebook you provide."
7819+
},
7820+
"driverSize": {
7821+
"type": "object",
7822+
"description": "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)."
7823+
},
7824+
"numExecutors": {
7825+
"description": "Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.",
7826+
"type": "integer",
7827+
"format": "int32"
7828+
}
7829+
},
7830+
"required": [
7831+
"notebook"
7832+
]
7833+
},
7834+
"SynapseNotebookReference": {
7835+
"description": "Synapse notebook reference type.",
7836+
"type": "object",
7837+
"properties": {
7838+
"type": {
7839+
"type": "string",
7840+
"description": "Synapse notebook reference type.",
7841+
"enum": [
7842+
"NotebookReference"
7843+
],
7844+
"x-ms-enum": {
7845+
"name": "NotebookReferenceType",
7846+
"modelAsString": true
7847+
}
7848+
},
7849+
"referenceName": {
7850+
"type": "object",
7851+
"description": "Reference notebook name. Type: string (or Expression with resultType string)."
7852+
}
7853+
},
7854+
"required": [
7855+
"type",
7856+
"referenceName"
7857+
]
7858+
},
7859+
"BigDataPoolParametrizationReference": {
7860+
"description": "Big data pool reference type.",
7861+
"type": "object",
7862+
"properties": {
7863+
"type": {
7864+
"type": "string",
7865+
"description": "Big data pool reference type.",
7866+
"enum": [
7867+
"BigDataPoolReference"
7868+
],
7869+
"x-ms-enum": {
7870+
"name": "BigDataPoolReferenceType",
7871+
"modelAsString": true
7872+
}
7873+
},
7874+
"referenceName": {
7875+
"type": "object",
7876+
"description": "Reference big data pool name. Type: string (or Expression with resultType string)."
7877+
}
7878+
},
7879+
"required": [
7880+
"type",
7881+
"referenceName"
7882+
]
7883+
},
7884+
"NotebookParameter": {
7885+
"description": "Notebook parameter.",
7886+
"type": "object",
7887+
"properties": {
7888+
"value": {
7889+
"type": "object",
7890+
"description": "Notebook parameter value. Type: string (or Expression with resultType string).",
7891+
"x-nullable": true
7892+
},
7893+
"type": {
7894+
"description": "Notebook parameter type.",
7895+
"$ref": "#/definitions/NotebookParameterType"
7896+
}
7897+
}
7898+
},
7899+
"NotebookParameterType": {
7900+
"description": "Notebook parameter type.",
7901+
"type": "string",
7902+
"enum": [
7903+
"string",
7904+
"int",
7905+
"float",
7906+
"bool"
7907+
],
7908+
"x-ms-enum": {
7909+
"name": "NotebookParameterType",
7910+
"modelAsString": true
7911+
}
7912+
},
7913+
"SynapseSparkJobDefinitionActivity": {
7914+
"description": "Execute spark job activity.",
7915+
"type": "object",
7916+
"x-ms-discriminator-value": "SparkJob",
7917+
"allOf": [
7918+
{
7919+
"$ref": "#/definitions/ExecutionActivity"
7920+
}
7921+
],
7922+
"properties": {
7923+
"typeProperties": {
7924+
"x-ms-client-flatten": true,
7925+
"description": "Execute spark job activity properties.",
7926+
"$ref": "#/definitions/SynapseSparkJobActivityTypeProperties"
7927+
}
7928+
},
7929+
"required": [
7930+
"typeProperties"
7931+
]
7932+
},
7933+
"SynapseSparkJobActivityTypeProperties": {
7934+
"description": "Execute spark job activity properties.",
7935+
"type": "object",
7936+
"properties": {
7937+
"sparkJob": {
7938+
"description": "Synapse spark job reference.",
7939+
"$ref": "#/definitions/SynapseSparkJobReference"
7940+
},
7941+
"args": {
7942+
"x-ms-client-name": "arguments",
7943+
"description": "User specified arguments to SynapseSparkJobDefinitionActivity.",
7944+
"type": "array",
7945+
"items": {
7946+
"description": "Type: string (or Expression with resultType string)."
7947+
},
7948+
"x-ms-identifiers": []
7949+
},
7950+
"file": {
7951+
"type": "object",
7952+
"description": "The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string)."
7953+
},
7954+
"className": {
7955+
"type": "object",
7956+
"description": "The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string)."
7957+
},
7958+
"files": {
7959+
"description": "Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.",
7960+
"type": "array",
7961+
"items": {
7962+
"description": "Type: string (or Expression with resultType string)."
7963+
},
7964+
"x-ms-identifiers": []
7965+
},
7966+
"targetBigDataPool": {
7967+
"$ref": "#/definitions/BigDataPoolParametrizationReference",
7968+
"description": "The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide."
7969+
},
7970+
"executorSize": {
7971+
"type": "object",
7972+
"description": "Number of core and memory to be used for executors allocated in the specified Spark pool for the job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string)."
7973+
},
7974+
"conf": {
7975+
"type": "object",
7976+
"description": "Spark configuration properties, which will override the 'conf' of the spark job definition you provide."
7977+
},
7978+
"driverSize": {
7979+
"type": "object",
7980+
"description": "Number of core and memory to be used for driver allocated in the specified Spark pool for the job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string)."
7981+
},
7982+
"numExecutors": {
7983+
"description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.",
7984+
"type": "integer",
7985+
"format": "int32"
7986+
}
7987+
},
7988+
"required": [
7989+
"sparkJob"
7990+
]
7991+
},
7992+
"SynapseSparkJobReference": {
7993+
"description": "Synapse spark job reference type.",
7994+
"type": "object",
7995+
"properties": {
7996+
"type": {
7997+
"type": "string",
7998+
"description": "Synapse spark job reference type.",
7999+
"enum": [
8000+
"SparkJobDefinitionReference"
8001+
],
8002+
"x-ms-enum": {
8003+
"name": "SparkJobReferenceType",
8004+
"modelAsString": true
8005+
}
8006+
},
8007+
"referenceName": {
8008+
"type": "string",
8009+
"description": "Reference spark job name."
8010+
}
8011+
},
8012+
"required": [
8013+
"type",
8014+
"referenceName"
8015+
]
77728016
}
77738017
}
77748018
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6623,6 +6623,43 @@
66236623
"servicePrincipalId",
66246624
"servicePrincipalKey"
66256625
]
6626+
},
6627+
"AzureSynapseArtifactsLinkedService": {
6628+
"x-ms-discriminator-value": "AzureSynapseArtifacts",
6629+
"description": "Azure Synapse Analytics (Artifacts) linked service.",
6630+
"type": "object",
6631+
"allOf": [
6632+
{
6633+
"$ref": "#/definitions/LinkedService"
6634+
}
6635+
],
6636+
"properties": {
6637+
"typeProperties": {
6638+
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
6639+
"x-ms-client-flatten": true,
6640+
"$ref": "#/definitions/AzureSynapseArtifactsLinkedServiceTypeProperties"
6641+
}
6642+
},
6643+
"required": [
6644+
"typeProperties"
6645+
]
6646+
},
6647+
"AzureSynapseArtifactsLinkedServiceTypeProperties": {
6648+
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
6649+
"type": "object",
6650+
"properties": {
6651+
"endpoint": {
6652+
"type": "object",
6653+
"description": "https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string)."
6654+
},
6655+
"authentication": {
6656+
"type": "object",
6657+
"description": "Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string)."
6658+
}
6659+
},
6660+
"required": [
6661+
"endpoint"
6662+
]
66266663
}
66276664
}
66286665
}

‎specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7430,6 +7430,23 @@
74307430
"additionalProperties": {
74317431
"$ref": "#/definitions/NotebookParameter"
74327432
}
7433+
},
7434+
"executorSize": {
7435+
"type": "object",
7436+
"description": "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)."
7437+
},
7438+
"conf": {
7439+
"type": "object",
7440+
"description": "Spark configuration properties, which will override the 'conf' of the notebook you provide."
7441+
},
7442+
"driverSize": {
7443+
"type": "object",
7444+
"description": "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)."
7445+
},
7446+
"numExecutors": {
7447+
"description": "Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.",
7448+
"type": "integer",
7449+
"format": "int32"
74337450
}
74347451
},
74357452
"required": [
@@ -7470,7 +7487,8 @@
74707487
"type": "array",
74717488
"items": {
74727489
"description": "Type: string (or Expression with resultType string)."
7473-
}
7490+
},
7491+
"x-ms-identifiers": []
74747492
},
74757493
"file": {
74767494
"type": "object",
@@ -7485,7 +7503,8 @@
74857503
"type": "array",
74867504
"items": {
74877505
"description": "Type: string (or Expression with resultType string)."
7488-
}
7506+
},
7507+
"x-ms-identifiers": []
74897508
},
74907509
"targetBigDataPool": {
74917510
"$ref": "../artifacts.json#/definitions/BigDataPoolParametrizationReference",
@@ -7505,7 +7524,8 @@
75057524
},
75067525
"numExecutors": {
75077526
"description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.",
7508-
"type": "integer"
7527+
"type": "integer",
7528+
"format": "int32"
75097529
}
75107530
},
75117531
"required": [

0 commit comments

Comments
 (0)