Skip to content

Commit 9c2191a

Browse files
authored
Swagger changes for setting minimalTlsVersion for workspace sql server post workspace creation (#17476)
* Checking in the swagger related changes to dedicated sql minial tls settings support * Updated the ms-examples related to minimal tls settings in both preview and stable folders * Fixing the swagger validation errors * Fixing the swagger model validation errors * Updated ms-examples and swagger files after review * Updated swagger files to include additional property * Fixing the swagger prettier check * Fixing the swagger model validation errors * Updated the ms-examples related to patch and changes in swagger files * Updated the swagger files for fixing few of the code review comments * Updated the swagger files for fixing few of the code review comments * Updated the swagger files for fixing few of the code review comments * Updated the swagger files and ms-examples for fixing code review comments * Updated the swagger files for fixing code review comments * Updated the swagger files for fixing code review comments
1 parent 1067b78 commit 9c2191a

9 files changed

+636
-0
lines changed

custom-words.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1154,6 +1154,7 @@ Lucene
11541154
Lumia
11551155
LUNs
11561156
Luxembourgish
1157+
Lminimal
11571158
machinelearning
11581159
machinelearningcompute
11591160
machinelearningexperimentation
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-1111-2222-3333-444444444444",
4+
"resourceGroupName": "workspace-6852",
5+
"workspaceName": "workspace-2080",
6+
"dedicatedSQLminimalTlsSettingsName": "default",
7+
"api-version": "2021-06-01-preview"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
13+
"name": "default",
14+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
15+
"location": "eastus",
16+
"properties": {
17+
"minimalTlsVersion": "1.1"
18+
}
19+
}
20+
}
21+
}
22+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-1111-2222-3333-444444444444",
4+
"resourceGroupName": "workspace-6852",
5+
"workspaceName": "workspace-2080",
6+
"api-version": "2021-06-01-preview"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
14+
"name": "default",
15+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
16+
"location": "eastus",
17+
"properties": {
18+
"minimalTlsVersion": "1.1"
19+
}
20+
},
21+
{
22+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
23+
"name": "default",
24+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
25+
"location": "eastus",
26+
"properties": {
27+
"minimalTlsVersion": "1.1"
28+
}
29+
}
30+
]
31+
}
32+
}
33+
}
34+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-1111-2222-3333-444444444444",
4+
"resourceGroupName": "workspace-6852",
5+
"workspaceName": "workspace-2080",
6+
"dedicatedSQLminimalTlsSettingsName": "default",
7+
"api-version": "2021-06-01-preview",
8+
"parameters": {
9+
"properties": {
10+
"minimalTlsVersion": "1.1"
11+
}
12+
}
13+
},
14+
"responses": {
15+
"200": {
16+
"body": {
17+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
18+
"name": "default",
19+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
20+
"properties": {
21+
"minimalTlsVersion": "1.1"
22+
}
23+
}
24+
},
25+
"202": {}
26+
}
27+
}

specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/sqlServer.json

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,6 +1188,185 @@
11881188
}
11891189
}
11901190
}
1191+
},
1192+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/dedicatedSQLminimalTlsSettings/{dedicatedSQLminimalTlsSettingsName}": {
1193+
"put": {
1194+
"operationId": "WorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings_Update",
1195+
"summary": "Update server's tls settings.",
1196+
"description": "Update workspace managed sql server's minimal tls settings.",
1197+
"tags": [
1198+
"WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings"
1199+
],
1200+
"deprecated": false,
1201+
"parameters": [
1202+
{
1203+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
1204+
},
1205+
{
1206+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
1207+
},
1208+
{
1209+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
1210+
},
1211+
{
1212+
"$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
1213+
},
1214+
{
1215+
"name": "dedicatedSQLminimalTlsSettingsName",
1216+
"in": "path",
1217+
"description": "The name of the dedicated sql minimal tls settings.",
1218+
"required": true,
1219+
"type": "string",
1220+
"enum": [
1221+
"default"
1222+
],
1223+
"x-ms-enum": {
1224+
"name": "DedicatedSQLMinimalTlsSettingsName",
1225+
"modelAsString": true
1226+
}
1227+
},
1228+
{
1229+
"schema": {
1230+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettings"
1231+
},
1232+
"in": "body",
1233+
"name": "parameters",
1234+
"description": "minimal tls settings",
1235+
"required": true
1236+
}
1237+
],
1238+
"responses": {
1239+
"200": {
1240+
"description": "Successfully updated dedicated sql minimal tls settings.",
1241+
"schema": {
1242+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettings"
1243+
}
1244+
},
1245+
"202": {
1246+
"description": "Accepted"
1247+
},
1248+
"default": {
1249+
"schema": {
1250+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
1251+
},
1252+
"description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong."
1253+
}
1254+
},
1255+
"consumes": [
1256+
"application/json"
1257+
],
1258+
"produces": [
1259+
"application/json"
1260+
],
1261+
"x-ms-long-running-operation": true,
1262+
"x-ms-examples": {
1263+
"Update tls version of the workspace managed sql server": {
1264+
"$ref": "./examples/UpdateWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json"
1265+
}
1266+
}
1267+
},
1268+
"get": {
1269+
"operationId": "WorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings_Get",
1270+
"summary": "Get server's minimal tls settings.",
1271+
"description": "Get workspace managed sql server's minimal tls settings.",
1272+
"tags": [
1273+
"WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings"
1274+
],
1275+
"parameters": [
1276+
{
1277+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
1278+
},
1279+
{
1280+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
1281+
},
1282+
{
1283+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
1284+
},
1285+
{
1286+
"$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
1287+
},
1288+
{
1289+
"name": "dedicatedSQLminimalTlsSettingsName",
1290+
"in": "path",
1291+
"required": true,
1292+
"type": "string",
1293+
"description": "The name of the dedicated sql minimal tls settings."
1294+
}
1295+
],
1296+
"responses": {
1297+
"200": {
1298+
"description": "Successfully retrieved dedicated sql minimal tls settings.",
1299+
"schema": {
1300+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettings"
1301+
}
1302+
},
1303+
"default": {
1304+
"schema": {
1305+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
1306+
},
1307+
"description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong."
1308+
}
1309+
},
1310+
"consumes": [],
1311+
"produces": [
1312+
"application/json"
1313+
],
1314+
"x-ms-examples": {
1315+
"Get workspace managed sql server dedicated sql minimal tls settings": {
1316+
"$ref": "./examples/GetWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json"
1317+
}
1318+
}
1319+
}
1320+
},
1321+
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/dedicatedSQLminimalTlsSettings": {
1322+
"get": {
1323+
"operationId": "WorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings_List",
1324+
"summary": "List workspace server's minimal tls settings.",
1325+
"description": "List workspace managed sql server's minimal tls settings.",
1326+
"tags": [
1327+
"WorkspaceManagedSqlServer, DedicatedSQLminimalTlsSettings"
1328+
],
1329+
"parameters": [
1330+
{
1331+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
1332+
},
1333+
{
1334+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
1335+
},
1336+
{
1337+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
1338+
},
1339+
{
1340+
"$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter"
1341+
}
1342+
],
1343+
"responses": {
1344+
"200": {
1345+
"description": "Successfully retrieved dedicated sql minimal tls settings.",
1346+
"schema": {
1347+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettingsListResult"
1348+
}
1349+
},
1350+
"default": {
1351+
"schema": {
1352+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
1353+
},
1354+
"description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 UnsupportedWorkspaceType - Unsupported operation for the workspace type.\n\n * 500 InternalServerError - Something went wrong."
1355+
}
1356+
},
1357+
"consumes": [],
1358+
"produces": [
1359+
"application/json"
1360+
],
1361+
"x-ms-pageable": {
1362+
"nextLinkName": "nextLink"
1363+
},
1364+
"x-ms-examples": {
1365+
"List dedicated sql minimal tls settings of the workspace managed sql server": {
1366+
"$ref": "./examples/ListWorkspaceManagedSqlServerDedicatedSQLminimalTlsSettings.json"
1367+
}
1368+
}
1369+
}
11911370
}
11921371
},
11931372
"definitions": {
@@ -1788,6 +1967,56 @@
17881967
"readOnly": true
17891968
}
17901969
}
1970+
},
1971+
"DedicatedSQLminimalTlsSettingsProperties": {
1972+
"description": "Properties of a dedicated sql minimal tls settings.",
1973+
"type": "object",
1974+
"properties": {
1975+
"minimalTlsVersion": {
1976+
"type": "string",
1977+
"description": "The minimal tls version of the sql server."
1978+
}
1979+
}
1980+
},
1981+
"DedicatedSQLminimalTlsSettings": {
1982+
"description": "Dedicated Sql Minimal Tls Settings Info",
1983+
"type": "object",
1984+
"allOf": [
1985+
{
1986+
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource"
1987+
}
1988+
],
1989+
"properties": {
1990+
"location": {
1991+
"description": "Resource location.",
1992+
"type": "string",
1993+
"readOnly": true
1994+
},
1995+
"properties": {
1996+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettingsProperties",
1997+
"description": "Resource properties.",
1998+
"x-ms-client-flatten": true
1999+
}
2000+
}
2001+
},
2002+
"DedicatedSQLminimalTlsSettingsListResult": {
2003+
"description": "A list of the server's dedicated sql minimal tls settings.",
2004+
"type": "object",
2005+
"properties": {
2006+
"value": {
2007+
"description": "Array of results.",
2008+
"type": "array",
2009+
"items": {
2010+
"$ref": "#/definitions/DedicatedSQLminimalTlsSettings"
2011+
},
2012+
"readOnly": true
2013+
},
2014+
"nextLink": {
2015+
"description": "Link to retrieve next page of results.",
2016+
"type": "string",
2017+
"readOnly": true
2018+
}
2019+
}
17912020
}
17922021
}
17932022
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-1111-2222-3333-444444444444",
4+
"resourceGroupName": "workspace-6852",
5+
"workspaceName": "workspace-2080",
6+
"dedicatedSQLminimalTlsSettingsName": "default",
7+
"api-version": "2021-06-01"
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
13+
"name": "default",
14+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
15+
"location": "eastus",
16+
"properties": {
17+
"minimalTlsVersion": "1.1"
18+
}
19+
}
20+
}
21+
}
22+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"parameters": {
3+
"subscriptionId": "00000000-1111-2222-3333-444444444444",
4+
"resourceGroupName": "workspace-6852",
5+
"workspaceName": "workspace-2080",
6+
"api-version": "2021-06-01"
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"value": [
12+
{
13+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
14+
"name": "default",
15+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
16+
"location": "eastus",
17+
"properties": {
18+
"minimalTlsVersion": "1.1"
19+
}
20+
},
21+
{
22+
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-6852/providers/Microsoft.Synapse/workspaces/workspace-2080/dedicatedSQLminimalTlsSettings/default",
23+
"name": "default",
24+
"type": "Microsoft.Synapse/workspaces/dedicatedSQLminimalTlsSettings",
25+
"location": "eastus",
26+
"properties": {
27+
"minimalTlsVersion": "1.1"
28+
}
29+
}
30+
]
31+
}
32+
}
33+
}
34+
}

0 commit comments

Comments
 (0)