Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DataFactory] Add synapse spark activities #19769

Merged
merged 3 commits into from
Jul 14, 2022
Merged

[DataFactory] Add synapse spark activities #19769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8f26ac
add spark activities into adf
wanyang7 Jul 14, 2022
e49ea34
add reference
wanyang7 Jul 14, 2022
eea5dd2
.\specification\
wanyang7 Jul 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions ...y/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6878,6 +6878,43 @@
"servicePrincipalId",
"servicePrincipalKey"
]
},
"AzureSynapseArtifactsLinkedService": {
"x-ms-discriminator-value": "AzureSynapseArtifacts",
"description": "Azure Synapse Analytics (Artifacts) linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureSynapseArtifactsLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureSynapseArtifactsLinkedServiceTypeProperties": {
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
"type": "object",
"properties": {
"endpoint": {
"type": "object",
"description": "https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string)."
},
"authentication": {
"type": "object",
"description": "Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string)."
}
},
"required": [
"endpoint"
]
}
}
}
244 changes: 244 additions & 0 deletions ...actory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7769,6 +7769,250 @@
"description": "Metadata item value. Type: string (or Expression with resultType string)."
}
}
},
"SynapseNotebookActivity": {
"description": "Execute Synapse notebook activity.",
"type": "object",
"x-ms-discriminator-value": "SynapseNotebook",
"allOf": [
{
"$ref": "#/definitions/ExecutionActivity"
}
],
"properties": {
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute Synapse notebook activity properties.",
"$ref": "#/definitions/SynapseNotebookActivityTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"SynapseNotebookActivityTypeProperties": {
"description": "Execute Synapse notebook activity properties.",
"type": "object",
"properties": {
"notebook": {
"description": "Synapse notebook reference.",
"$ref": "#/definitions/SynapseNotebookReference"
},
"sparkPool": {
"description": "The name of the big data pool which will be used to execute the notebook.",
"$ref": "#/definitions/BigDataPoolParametrizationReference"
},
"parameters": {
"description": "Notebook parameters.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/NotebookParameter"
}
},
"executorSize": {
"type": "object",
"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)."
},
"conf": {
"type": "object",
"description": "Spark configuration properties, which will override the 'conf' of the notebook you provide."
},
"driverSize": {
"type": "object",
"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)."
},
"numExecutors": {
"description": "Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.",
"type": "integer",
"format": "int32"
}
},
"required": [
"notebook"
]
},
"SynapseNotebookReference": {
"description": "Synapse notebook reference type.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Synapse notebook reference type.",
"enum": [
"NotebookReference"
],
"x-ms-enum": {
"name": "NotebookReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "object",
"description": "Reference notebook name. Type: string (or Expression with resultType string)."
}
},
"required": [
"type",
"referenceName"
]
},
"BigDataPoolParametrizationReference": {
"description": "Big data pool reference type.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Big data pool reference type.",
"enum": [
"BigDataPoolReference"
],
"x-ms-enum": {
"name": "BigDataPoolReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "object",
"description": "Reference big data pool name. Type: string (or Expression with resultType string)."
}
},
"required": [
"type",
"referenceName"
]
},
"NotebookParameter": {
"description": "Notebook parameter.",
"type": "object",
"properties": {
"value": {
"type": "object",
"description": "Notebook parameter value. Type: string (or Expression with resultType string).",
"x-nullable": true
},
"type": {
"description": "Notebook parameter type.",
"$ref": "#/definitions/NotebookParameterType"
}
}
},
"NotebookParameterType": {
"description": "Notebook parameter type.",
"type": "string",
"enum": [
"string",
"int",
"float",
"bool"
],
"x-ms-enum": {
"name": "NotebookParameterType",
"modelAsString": true
}
},
"SynapseSparkJobDefinitionActivity": {
"description": "Execute spark job activity.",
"type": "object",
"x-ms-discriminator-value": "SparkJob",
"allOf": [
{
"$ref": "#/definitions/ExecutionActivity"
}
],
"properties": {
"typeProperties": {
"x-ms-client-flatten": true,
"description": "Execute spark job activity properties.",
"$ref": "#/definitions/SynapseSparkJobActivityTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"SynapseSparkJobActivityTypeProperties": {
"description": "Execute spark job activity properties.",
"type": "object",
"properties": {
"sparkJob": {
"description": "Synapse spark job reference.",
"$ref": "#/definitions/SynapseSparkJobReference"
},
"args": {
"x-ms-client-name": "arguments",
"description": "User specified arguments to SynapseSparkJobDefinitionActivity.",
"type": "array",
"items": {
"description": "Type: string (or Expression with resultType string)."
},
"x-ms-identifiers": []
},
"file": {
"type": "object",
"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)."
},
"className": {
"type": "object",
"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)."
},
"files": {
"description": "Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide.",
"type": "array",
"items": {
"description": "Type: string (or Expression with resultType string)."
},
"x-ms-identifiers": []
},
"targetBigDataPool": {
"$ref": "#/definitions/BigDataPoolParametrizationReference",
"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."
},
"executorSize": {
"type": "object",
"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)."
},
"conf": {
"type": "object",
"description": "Spark configuration properties, which will override the 'conf' of the spark job definition you provide."
},
"driverSize": {
"type": "object",
"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)."
},
"numExecutors": {
"description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.",
"type": "integer",
"format": "int32"
}
},
"required": [
"sparkJob"
]
},
"SynapseSparkJobReference": {
"description": "Synapse spark job reference type.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Synapse spark job reference type.",
"enum": [
"SparkJobDefinitionReference"
],
"x-ms-enum": {
"name": "SparkJobReferenceType",
"modelAsString": true
}
},
"referenceName": {
"type": "string",
"description": "Reference spark job name."
}
},
"required": [
"type",
"referenceName"
]
}
}
}
37 changes: 37 additions & 0 deletions ...ion/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6623,6 +6623,43 @@
"servicePrincipalId",
"servicePrincipalKey"
]
},
"AzureSynapseArtifactsLinkedService": {
"x-ms-discriminator-value": "AzureSynapseArtifacts",
"description": "Azure Synapse Analytics (Artifacts) linked service.",
"type": "object",
"allOf": [
{
"$ref": "#/definitions/LinkedService"
}
],
"properties": {
"typeProperties": {
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureSynapseArtifactsLinkedServiceTypeProperties"
}
},
"required": [
"typeProperties"
]
},
"AzureSynapseArtifactsLinkedServiceTypeProperties": {
"description": "Azure Synapse Analytics (Artifacts) linked service properties.",
"type": "object",
"properties": {
"endpoint": {
"type": "object",
"description": "https://<workspacename>.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string)."
},
"authentication": {
"type": "object",
"description": "Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string)."
}
},
"required": [
"endpoint"
]
}
}
}
26 changes: 23 additions & 3 deletions ...fication/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7430,6 +7430,23 @@
"additionalProperties": {
"$ref": "#/definitions/NotebookParameter"
}
},
"executorSize": {
"type": "object",
"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)."
},
"conf": {
"type": "object",
"description": "Spark configuration properties, which will override the 'conf' of the notebook you provide."
},
"driverSize": {
"type": "object",
"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)."
},
"numExecutors": {
"description": "Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide.",
"type": "integer",
"format": "int32"
}
},
"required": [
Expand Down Expand Up @@ -7470,7 +7487,8 @@
"type": "array",
"items": {
"description": "Type: string (or Expression with resultType string)."
}
},
"x-ms-identifiers": []
},
"file": {
"type": "object",
Expand All @@ -7485,7 +7503,8 @@
"type": "array",
"items": {
"description": "Type: string (or Expression with resultType string)."
}
},
"x-ms-identifiers": []
},
"targetBigDataPool": {
"$ref": "../artifacts.json#/definitions/BigDataPoolParametrizationReference",
Expand All @@ -7505,7 +7524,8 @@
},
"numExecutors": {
"description": "Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide.",
"type": "integer"
"type": "integer",
"format": "int32"
}
},
"required": [
Expand Down