-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
InstancePools.json
413 lines (413 loc) · 13.3 KB
/
InstancePools.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
{
"swagger": "2.0",
"info": {
"version": "2020-02-02-preview",
"title": "SqlManagementClient",
"description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools/{instancePoolName}": {
"get": {
"tags": [
"InstancePools"
],
"description": "Gets an instance pool.",
"operationId": "InstancePools_Get",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"name": "instancePoolName",
"in": "path",
"description": "The name of the instance pool to be retrieved.",
"required": true,
"type": "string"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the specified instance pool.",
"schema": {
"$ref": "#/definitions/InstancePool"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 404 InstancePoolNotFound - An instance pool cannot be found"
}
},
"x-ms-examples": {
"Get an instance pool": {
"$ref": "./examples/GetInstancePool.json"
}
}
},
"put": {
"tags": [
"InstancePools"
],
"description": "Creates or updates an instance pool.",
"operationId": "InstancePools_CreateOrUpdate",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"name": "instancePoolName",
"in": "path",
"description": "The name of the instance pool to be created or updated.",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"description": "The requested instance pool resource state.",
"required": true,
"schema": {
"$ref": "#/definitions/InstancePool"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully updated the instance pool.",
"schema": {
"$ref": "#/definitions/InstancePool"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 InstancePoolRequestedVcoreCountIsInvalid - Requested vcore count for instance pool is invalid\n\n * 400 InstancePoolRequestMissingSku - Instance pool request is missing sku\n\n * 400 InstancePoolRequestMissingSkuTier - Instance pool request is missing sku tier\n\n * 400 InstancePoolRequestMissingSkuFamily - Instance pool request is missing sku family\n\n * 400 InstancePoolRequestedSubnetResourceIdIsInvalid - Subnet id for instance pool is null or empty\n\n * 409 InstancePoolBusy - An instance pool is busy with another ongoing operation"
},
"202": {
"description": "Accepted"
},
"201": {
"description": "Successfully created the instance pool.",
"schema": {
"$ref": "#/definitions/InstancePool"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Create an instance pool with all properties.": {
"$ref": "./examples/CreateOrUpdateInstancePoolMax.json"
},
"Create an instance pool with min properties.": {
"$ref": "./examples/CreateOrUpdateInstancePoolMin.json"
}
}
},
"delete": {
"tags": [
"InstancePools"
],
"description": "Deletes an instance pool",
"operationId": "InstancePools_Delete",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"name": "instancePoolName",
"in": "path",
"description": "The name of the instance pool to be deleted",
"required": true,
"type": "string"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully deleted the instance pool."
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 InstancePoolNotEmpty - An instance pool is not empty\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 404 InstancePoolNotFound - An instance pool cannot be found\n\n * 409 InstancePoolBusy - An instance pool is busy with another ongoing operation"
},
"202": {
"description": "Accepted"
},
"204": {
"description": "The specified instance pool does not exist."
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Delete an instance pool": {
"$ref": "./examples/DeleteInstancePool.json"
}
}
},
"patch": {
"tags": [
"InstancePools"
],
"description": "Updates an instance pool.",
"operationId": "InstancePools_Update",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"name": "instancePoolName",
"in": "path",
"description": "The name of the instance pool to be updated.",
"required": true,
"type": "string"
},
{
"name": "parameters",
"in": "body",
"description": "The requested instance pool resource state.",
"required": true,
"schema": {
"$ref": "#/definitions/InstancePoolUpdate"
}
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully updated the instance pool.",
"schema": {
"$ref": "#/definitions/InstancePool"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid."
},
"202": {
"description": "Accepted"
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"Patch an instance pool": {
"$ref": "./examples/PatchInstancePool.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/instancePools": {
"get": {
"tags": [
"InstancePools"
],
"description": "Gets a list of instance pools in the resource group",
"operationId": "InstancePools_ListByResourceGroup",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of instance pools.",
"schema": {
"$ref": "#/definitions/InstancePoolListResult"
}
},
"default": {
"description": "*** Error Responses: ***"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List instance pools by resource group": {
"$ref": "./examples/ListInstancePoolsByResourceGroup.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Sql/instancePools": {
"get": {
"tags": [
"InstancePools"
],
"description": "Gets a list of all instance pools in the subscription.",
"operationId": "InstancePools_List",
"parameters": [
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Successfully retrieved the list of instance pools in a subscription.",
"schema": {
"$ref": "#/definitions/InstancePoolListResult"
}
},
"default": {
"description": "*** Error Responses: ***"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"List instance pools in the subscription": {
"$ref": "./examples/ListInstancePoolsBySubscriptionId.json"
}
}
}
}
},
"definitions": {
"InstancePoolProperties": {
"description": "Properties of an instance pool.",
"required": [
"subnetId",
"vCores",
"licenseType"
],
"type": "object",
"properties": {
"subnetId": {
"description": "Resource ID of the subnet to place this instance pool in.",
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"vCores": {
"format": "int32",
"description": "Count of vCores belonging to this instance pool.",
"type": "integer",
"x-ms-mutability": [
"read",
"create"
]
},
"licenseType": {
"description": "The license type. Possible values are 'LicenseIncluded' (price for SQL license is included) and 'BasePrice' (without SQL license price).",
"enum": [
"LicenseIncluded",
"BasePrice"
],
"type": "string",
"x-ms-enum": {
"name": "InstancePoolLicenseType",
"modelAsString": true
},
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"InstancePool": {
"description": "An Azure SQL instance pool.",
"required": [
"location"
],
"type": "object",
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/TrackedResource"
}
],
"properties": {
"sku": {
"$ref": "../../../common/v1/types.json#/definitions/Sku",
"description": "The name and tier of the SKU."
},
"properties": {
"$ref": "#/definitions/InstancePoolProperties",
"description": "Resource properties.",
"x-ms-client-flatten": true
}
}
},
"InstancePoolUpdate": {
"description": "An update to an Instance pool.",
"type": "object",
"properties": {
"tags": {
"description": "Resource tags.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"InstancePoolListResult": {
"description": "A list of Azure SQL instance pools.",
"type": "object",
"properties": {
"value": {
"description": "Array of results.",
"type": "array",
"items": {
"$ref": "#/definitions/InstancePool"
},
"readOnly": true
},
"nextLink": {
"description": "Link to retrieve next page of results.",
"type": "string",
"readOnly": true
}
}
}
},
"parameters": {},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
}
}