Skip to content

Commit bee7248

Browse files
idear1203Dongwei Wang
idear1203
and
Dongwei Wang
authored
[Synapse] - fix scheme for Artifacts and update readme to include KQL scripts for October release (#16035)
* [Synapse] - fix scheme for Notebook, Spark Job definition and SQL script * Update dataset, linked service and pipeline * Update release tag for october release * Correct type of result limit * Add arguments for SynapseSparkJobActivityTypeProperties Co-authored-by: Dongwei Wang <dongwwa@microsoft.com>
1 parent 2b586b9 commit bee7248

File tree

8 files changed

+168
-8
lines changed

8 files changed

+168
-8
lines changed

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SqlScript.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
},
6262
"resultLimit": {
6363
"description": "Limit of results, '-1' for no limit.",
64-
"type": "number"
64+
"type": "integer"
6565
},
6666
"metadata": {
6767
"description": "The metadata of the SQL script.",

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

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,6 +2318,37 @@
23182318
}
23192319
}
23202320
},
2321+
"AmazonRdsForSqlServerTableDataset": {
2322+
"x-ms-discriminator-value": "AmazonRdsForSqlServerTable",
2323+
"description": "The Amazon RDS for SQL Server dataset.",
2324+
"type": "object",
2325+
"allOf": [
2326+
{
2327+
"$ref": "#/definitions/Dataset"
2328+
}
2329+
],
2330+
"properties": {
2331+
"typeProperties": {
2332+
"description": "The Amazon RDS for SQL Server dataset properties.",
2333+
"x-ms-client-flatten": true,
2334+
"$ref": "#/definitions/AmazonRdsForSqlServerTableDatasetTypeProperties"
2335+
}
2336+
}
2337+
},
2338+
"AmazonRdsForSqlServerTableDatasetTypeProperties": {
2339+
"description": "The Amazon RDS for SQL Server dataset properties.",
2340+
"type": "object",
2341+
"properties": {
2342+
"schema": {
2343+
"type": "object",
2344+
"description": "The schema name of the SQL Server dataset. Type: string (or Expression with resultType string)."
2345+
},
2346+
"table": {
2347+
"type": "object",
2348+
"description": "The table name of the SQL Server dataset. Type: string (or Expression with resultType string)."
2349+
}
2350+
}
2351+
},
23212352
"RestResourceDataset": {
23222353
"x-ms-discriminator-value": "RestResource",
23232354
"description": "A Rest service dataset.",

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

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,51 @@
280280
"connectionString"
281281
]
282282
},
283+
"AmazonRdsForSqlServerLinkedService": {
284+
"x-ms-discriminator-value": "AmazonRdsForSqlServer",
285+
"description": "Amazon RDS for SQL Server linked service.",
286+
"type": "object",
287+
"allOf": [
288+
{
289+
"$ref": "#/definitions/LinkedService"
290+
}
291+
],
292+
"properties": {
293+
"typeProperties": {
294+
"description": "Amazon RDS for SQL Server linked service properties.",
295+
"x-ms-client-flatten": true,
296+
"$ref": "#/definitions/AmazonRdsForSqlServerLinkedServiceTypeProperties"
297+
}
298+
},
299+
"required": [
300+
"typeProperties"
301+
]
302+
},
303+
"AmazonRdsForSqlServerLinkedServiceTypeProperties": {
304+
"description": "SQL Server linked service properties.",
305+
"type": "object",
306+
"properties": {
307+
"connectionString": {
308+
"description": "The connection string. Type: string, SecureString or AzureKeyVaultSecretReference.",
309+
"type": "object"
310+
},
311+
"userName": {
312+
"type": "object",
313+
"description": "The on-premises Windows authentication user name. Type: string (or Expression with resultType string)."
314+
},
315+
"password": {
316+
"description": "The on-premises Windows authentication password.",
317+
"$ref": "../artifacts.json#/definitions/SecretBase"
318+
},
319+
"encryptedCredential": {
320+
"type": "object",
321+
"description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)."
322+
}
323+
},
324+
"required": [
325+
"connectionString"
326+
]
327+
},
283328
"AzureSqlDatabaseLinkedService": {
284329
"x-ms-discriminator-value": "AzureSqlDatabase",
285330
"description": "Microsoft Azure SQL Database linked service.",

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,16 @@
4242
"items": {
4343
"$ref": "#/definitions/NotebookCell"
4444
}
45+
},
46+
"folder": {
47+
"description": "The folder that this notebook is in. If not specified, this notebook will appear at the root level.",
48+
"type": "object",
49+
"properties": {
50+
"name": {
51+
"description": "The name of the folder that this notebook is in.",
52+
"type": "string"
53+
}
54+
}
4555
}
4656
},
4757
"additionalProperties": {

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

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2274,6 +2274,44 @@
22742274
}
22752275
}
22762276
},
2277+
"AmazonRdsForSqlServerSource": {
2278+
"description": "A copy activity Amazon RDS for SQL Server source.",
2279+
"type": "object",
2280+
"allOf": [
2281+
{
2282+
"$ref": "#/definitions/TabularSource"
2283+
}
2284+
],
2285+
"properties": {
2286+
"sqlReaderQuery": {
2287+
"type": "object",
2288+
"description": "SQL reader query. Type: string (or Expression with resultType string)."
2289+
},
2290+
"sqlReaderStoredProcedureName": {
2291+
"type": "object",
2292+
"description": "Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string)."
2293+
},
2294+
"storedProcedureParameters": {
2295+
"description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\".",
2296+
"type": "object",
2297+
"additionalProperties": {
2298+
"$ref": "#/definitions/StoredProcedureParameter"
2299+
}
2300+
},
2301+
"produceAdditionalTypes": {
2302+
"description": "Which additional types to produce.",
2303+
"type": "object"
2304+
},
2305+
"partitionOption": {
2306+
"description": "The partition mechanism that will be used for Sql read in parallel. Possible values include: \"None\", \"PhysicalPartitionsOfTable\", \"DynamicRange\".",
2307+
"type": "object"
2308+
},
2309+
"partitionSettings": {
2310+
"description": "The settings that will be leveraged for Sql source partitioning.",
2311+
"$ref": "#/definitions/SqlPartitionSettings"
2312+
}
2313+
}
2314+
},
22772315
"AzureSqlSource": {
22782316
"description": "A copy activity Azure SQL source.",
22792317
"type": "object",
@@ -7168,6 +7206,14 @@
71687206
"sparkJob": {
71697207
"description": "Synapse spark job reference.",
71707208
"$ref": "../artifacts.json#/definitions/SynapseSparkJobReference"
7209+
},
7210+
"args": {
7211+
"x-ms-client-name": "arguments",
7212+
"description": "User specified arguments to SynapseSparkJobDefinitionActivity.",
7213+
"type": "array",
7214+
"items": {
7215+
"description": "Type: string (or Expression with resultType string)."
7216+
}
71717217
}
71727218
},
71737219
"required": [

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@
2929
"jobProperties": {
3030
"description": "The properties of the Spark job.",
3131
"$ref": "#/definitions/SparkJobProperties"
32+
},
33+
"folder": {
34+
"description": "The folder that this Spark job definition is in. If not specified, this Spark job definition will appear at the root level.",
35+
"type": "object",
36+
"properties": {
37+
"name": {
38+
"description": "The name of the folder that this Spark job definition is in.",
39+
"type": "string"
40+
}
41+
}
3242
}
3343
},
3444
"additionalProperties": {

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

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@
2828
"content": {
2929
"description": "The content of the SQL script.",
3030
"$ref": "#/definitions/SqlScriptContent"
31+
},
32+
"folder": {
33+
"description": "The folder that this SQL script is in. If not specified, this SQL script will appear at the root level.",
34+
"type": "object",
35+
"properties": {
36+
"name": {
37+
"description": "The name of the folder that this SQL script is in.",
38+
"type": "string"
39+
}
40+
}
3141
}
3242
},
3343
"additionalProperties": {
@@ -49,6 +59,10 @@
4959
"description": "The connection used to execute the SQL script.",
5060
"$ref": "#/definitions/SqlConnection"
5161
},
62+
"resultLimit": {
63+
"description": "Limit of results, '-1' for no limit.",
64+
"type": "integer"
65+
},
5266
"metadata": {
5367
"description": "The metadata of the SQL script.",
5468
"$ref": "#/definitions/SqlScriptMetadata"
@@ -58,8 +72,7 @@
5872
"type": "object"
5973
},
6074
"required": [
61-
"query",
62-
"currentConnection"
75+
"query"
6376
]
6477
},
6578
"SqlScriptMetadata": {
@@ -94,15 +107,19 @@
94107
"name": {
95108
"description": "The identifier of the connection.",
96109
"type": "string"
110+
},
111+
"poolName": {
112+
"description": "The associated SQL pool name (supported by SQL pool v3)",
113+
"type": "string"
114+
},
115+
"databaseName": {
116+
"description": "The associated database name (supported by SQL pool v3)",
117+
"type": "string"
97118
}
98119
},
99120
"additionalProperties": {
100121
"type": "object"
101-
},
102-
"required": [
103-
"type",
104-
"name"
105-
]
122+
}
106123
}
107124
}
108125
}

‎specification/synapse/data-plane/readme.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ These settings apply only when `--tag=package-artifacts-composite-v1` is specifi
6666

6767
``` yaml $(tag) == 'package-artifacts-composite-v1'
6868
input-file:
69+
- Microsoft.Synapse/preview/2021-06-01-preview/kqlScripts.json
6970
- Microsoft.Synapse/preview/2021-06-01-preview/sparkConfigurations.json
7071
- Microsoft.Synapse/preview/2021-06-01-preview/entityTypes/SparkConfiguration.json
7172
- Microsoft.Synapse/stable/2020-12-01/artifacts.json

0 commit comments

Comments
 (0)