Skip to content

Commit f80fb1e

Browse files
cool-mistSuryaidear1203
authored
[Synapse] Add Get Workspace, Read/List BigDataPools, SqlPools, IntegrationRuntimes API spec from the data-plane (#10128)
* [Synapse] Add Get Workspace, Read/List BigDataPools, SqlPools, IntegrationRuntimes API spec from the data-plane * Refer to new swagger files in the readme * Update references * Update package name * Remove trailing whitespaces and refer to endpoint instead of SynapseDnsSuffix parameter * Move new swagger and examples inside artifacts folder, and update readme * Update title to ArtifactsClient * Update api-version to 2019-06-01-preview * Fix CI failures * Fix SDK violations * Prettier check * Fix LintDiff errors * Fix Lintdiff * Update Read API swagger specs * Update configuration file * Add capacity to SQL pool * Update capacity definition Co-authored-by: Surya <[email protected]> Co-authored-by: Dongwei Wang <[email protected]>
1 parent 9dd3603 commit f80fb1e

File tree

16 files changed

+788
-144
lines changed

16 files changed

+788
-144
lines changed

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json‎

Lines changed: 4 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -2313,70 +2313,13 @@
23132313
}
23142314
},
23152315
"definitions": {
2316-
"Resource": {
2317-
"description": "Azure Synapse top-level resource.",
2318-
"properties": {
2319-
"id": {
2320-
"type": "string",
2321-
"description": "The resource identifier.",
2322-
"readOnly": true
2323-
},
2324-
"name": {
2325-
"type": "string",
2326-
"description": "The resource name.",
2327-
"readOnly": true
2328-
},
2329-
"type": {
2330-
"type": "string",
2331-
"description": "The resource type.",
2332-
"readOnly": true
2333-
},
2334-
"location": {
2335-
"type": "string",
2336-
"description": "The resource location.",
2337-
"x-ms-mutability": [
2338-
"create",
2339-
"read"
2340-
]
2341-
},
2342-
"tags": {
2343-
"type": "object",
2344-
"additionalProperties": {
2345-
"type": "string"
2346-
},
2347-
"description": "The resource tags."
2348-
},
2349-
"eTag": {
2350-
"type": "string",
2351-
"description": "Etag identifies change in the resource.",
2352-
"readOnly": true
2353-
}
2354-
}
2355-
},
23562316
"SubResource": {
23572317
"description": "Azure Synapse nested resource, which belongs to a workspace.",
2358-
"properties": {
2359-
"id": {
2360-
"type": "string",
2361-
"description": "The resource identifier.",
2362-
"readOnly": true
2363-
},
2364-
"name": {
2365-
"type": "string",
2366-
"description": "The resource name.",
2367-
"readOnly": true
2368-
},
2369-
"type": {
2370-
"type": "string",
2371-
"description": "The resource type.",
2372-
"readOnly": true
2373-
},
2374-
"etag": {
2375-
"type": "string",
2376-
"description": "Etag identifies change in the resource.",
2377-
"readOnly": true
2318+
"allOf": [
2319+
{
2320+
"$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/AzureEntityResource"
23782321
}
2379-
}
2322+
]
23802323
},
23812324
"SubResourceDebugResource": {
23822325
"description": "Azure Synapse nested debug resource.",
@@ -3151,29 +3094,6 @@
31513094
}
31523095
}
31533096
},
3154-
"Workspace": {
3155-
"description": "Workspace resource type.",
3156-
"type": "object",
3157-
"allOf": [
3158-
{
3159-
"$ref": "#/definitions/Resource"
3160-
}
3161-
],
3162-
"properties": {
3163-
"identity": {
3164-
"$ref": "#/definitions/WorkspaceIdentity",
3165-
"description": "Managed service identity of the workspace."
3166-
},
3167-
"properties": {
3168-
"x-ms-client-flatten": true,
3169-
"$ref": "#/definitions/WorkspaceProperties",
3170-
"description": "Properties of the workspace."
3171-
}
3172-
},
3173-
"additionalProperties": {
3174-
"type": "object"
3175-
}
3176-
},
31773097
"WorkspaceUpdateParameters": {
31783098
"description": "Parameters for updating a workspace resource.",
31793099
"properties": {
@@ -3219,35 +3139,6 @@
32193139
"type"
32203140
]
32213141
},
3222-
"WorkspaceProperties": {
3223-
"description": "Workspace resource properties.",
3224-
"properties": {
3225-
"provisioningState": {
3226-
"description": "Workspace provisioning state, example Succeeded.",
3227-
"type": "string",
3228-
"readOnly": true
3229-
},
3230-
"createTime": {
3231-
"description": "Time the workspace was created in ISO8601 format.",
3232-
"type": "string",
3233-
"readOnly": true,
3234-
"format": "date-time"
3235-
},
3236-
"version": {
3237-
"description": "Version of the workspace.",
3238-
"type": "string",
3239-
"readOnly": true
3240-
},
3241-
"defaultStorage": {
3242-
"description": "Linked service reference.",
3243-
"$ref": "#/definitions/LinkedServiceReference"
3244-
},
3245-
"defaultSqlServer": {
3246-
"description": "Linked service reference.",
3247-
"$ref": "#/definitions/LinkedServiceReference"
3248-
}
3249-
}
3250-
},
32513142
"DatasetReference": {
32523143
"description": "Dataset reference type.",
32533144
"properties": {

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPools.json‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "2019-06-01-preview",
5+
"title": "ArtifactsClient"
6+
},
7+
"x-ms-parameterized-host": {
8+
"hostTemplate": "{endpoint}",
9+
"useSchemePrefix": false,
10+
"parameters": [
11+
{
12+
"$ref": "#/parameters/Endpoint"
13+
}
14+
]
15+
},
16+
"schemes": [
17+
"https"
18+
],
19+
"consumes": [
20+
"application/json"
21+
],
22+
"produces": [
23+
"application/json"
24+
],
25+
"paths": {
26+
"/bigDataPools": {
27+
"get": {
28+
"tags": [
29+
"BigDataPools"
30+
],
31+
"operationId": "BigDataPools_List",
32+
"description": "List Big Data Pools",
33+
"x-ms-examples": {
34+
"List Big Data Pools": {
35+
"$ref": "./examples/BigDataPools_List.json"
36+
}
37+
},
38+
"parameters": [
39+
{
40+
"$ref": "#/parameters/ApiVersionParameter"
41+
}
42+
],
43+
"responses": {
44+
"200": {
45+
"description": "Success response.",
46+
"schema": {
47+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfoListResult"
48+
}
49+
},
50+
"default": {
51+
"description": "Error response describing why the operation failed.",
52+
"schema": {
53+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract"
54+
}
55+
}
56+
}
57+
}
58+
},
59+
"/bigDataPools/{bigDataPoolName}": {
60+
"get": {
61+
"tags": [
62+
"BigDataPools"
63+
],
64+
"operationId": "BigDataPools_Get",
65+
"description": "Get Big Data Pool",
66+
"x-ms-examples": {
67+
"Get Big Data Pool": {
68+
"$ref": "./examples/BigDataPools_Get.json"
69+
}
70+
},
71+
"parameters": [
72+
{
73+
"$ref": "#/parameters/ApiVersionParameter"
74+
},
75+
{
76+
"$ref": "#/parameters/BigDataPoolNameParameter"
77+
}
78+
],
79+
"responses": {
80+
"200": {
81+
"description": "Success response.",
82+
"schema": {
83+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json#/definitions/BigDataPoolResourceInfo"
84+
}
85+
},
86+
"default": {
87+
"description": "Error response describing why the operation failed.",
88+
"schema": {
89+
"$ref": "../../../../resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/workspace.json#/definitions/ErrorContract"
90+
}
91+
}
92+
}
93+
}
94+
}
95+
},
96+
"definitions": {},
97+
"parameters": {
98+
"ApiVersionParameter": {
99+
"name": "api-version",
100+
"in": "query",
101+
"required": true,
102+
"type": "string",
103+
"description": "The Synapse client API Version."
104+
},
105+
"Endpoint": {
106+
"name": "endpoint",
107+
"description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.",
108+
"required": true,
109+
"type": "string",
110+
"in": "path",
111+
"x-ms-skip-url-encoding": true,
112+
"x-ms-parameter-location": "client"
113+
},
114+
"BigDataPoolNameParameter": {
115+
"name": "bigDataPoolName",
116+
"in": "path",
117+
"required": true,
118+
"type": "string",
119+
"description": "The Big Data Pool name",
120+
"x-ms-parameter-location": "method"
121+
}
122+
}
123+
}

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/BigDataPools_Get.json‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"bigDataPoolName": "pool1",
5+
"api-version": "2020-01-01-preview"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"properties": {
11+
"creationDate": "2020-07-14T10:09:52.5133333Z",
12+
"sparkVersion": "2.4",
13+
"nodeCount": 3,
14+
"nodeSize": "Small",
15+
"nodeSizeFamily": "MemoryOptimized",
16+
"autoScale": {
17+
"enabled": true,
18+
"minNodeCount": 3,
19+
"maxNodeCount": 20
20+
},
21+
"autoPause": {
22+
"enabled": true,
23+
"delayInMinutes": 15
24+
},
25+
"provisioningState": "Succeeded"
26+
},
27+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1",
28+
"name": "pool1",
29+
"type": "Microsoft.Synapse/workspaces/sparkComputes",
30+
"location": "southeastasia",
31+
"tags": {}
32+
}
33+
},
34+
"default": {
35+
"body": {
36+
"error": {
37+
"code": "Error code",
38+
"message": "Error message"
39+
}
40+
}
41+
}
42+
}
43+
}

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/BigDataPools_List.json‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"api-version": "2020-01-01-preview"
5+
},
6+
"responses": {
7+
"200": {
8+
"body": {
9+
"value": [
10+
{
11+
"properties": {
12+
"creationDate": "2020-07-14T10:09:52.5133333Z",
13+
"sparkVersion": "2.4",
14+
"nodeCount": 3,
15+
"nodeSize": "Small",
16+
"nodeSizeFamily": "MemoryOptimized",
17+
"autoScale": {
18+
"enabled": true,
19+
"minNodeCount": 3,
20+
"maxNodeCount": 20
21+
},
22+
"autoPause": {
23+
"enabled": true,
24+
"delayInMinutes": 15
25+
},
26+
"provisioningState": "Succeeded"
27+
},
28+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/sparkComputes/pool1",
29+
"name": "pool1",
30+
"type": "Microsoft.Synapse/workspaces/sparkComputes",
31+
"location": "southeastasia",
32+
"tags": {}
33+
}
34+
]
35+
}
36+
},
37+
"default": {
38+
"body": {
39+
"error": {
40+
"code": "Error code",
41+
"message": "Error message"
42+
}
43+
}
44+
}
45+
}
46+
}

‎specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/IntegrationRuntimes_Get.json‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"parameters": {
3+
"endpoint": "exampleWorkspace.dev.azuresynapse.net",
4+
"integrationRuntimeName": "IntegrationRuntime1",
5+
"api-version": "2020-01-01-preview"
6+
},
7+
"responses": {
8+
"200": {
9+
"body": {
10+
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationruntimes/IntegrationRuntime1",
11+
"name": "IntegrationRuntime1",
12+
"type": "Microsoft.Synapse/workspaces/integrationruntimes",
13+
"properties": {
14+
"type": "Managed",
15+
"typeProperties": {
16+
"computeProperties": {
17+
"location": "Australia Southeast",
18+
"dataFlowProperties": {
19+
"computeType": "General",
20+
"coreCount": 8,
21+
"timeToLive": 0
22+
}
23+
}
24+
}
25+
},
26+
"etag": "00000000-0000-0000-0000-000000000000"
27+
}
28+
},
29+
"default": {
30+
"body": {
31+
"error": {
32+
"code": "Error code",
33+
"message": "Error message"
34+
}
35+
}
36+
}
37+
}
38+
}

0 commit comments

Comments
 (0)