-
Notifications
You must be signed in to change notification settings - Fork 5k
/
customerlockbox.json
516 lines (516 loc) · 15.5 KB
/
customerlockbox.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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
{
"swagger": "2.0",
"info": {
"version": "2018-02-28-preview",
"title": "Customer Lockbox",
"description": "Azure Customer Lockbox API Reference"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/providers/Microsoft.CustomerLockbox/operations": {
"get": {
"tags": [
"Operations"
],
"description": "Lists all the available REST API operations.",
"operationId": "Operations_List",
"x-ms-examples": {
"List available operations for the Customer Lockbox resource provider": {
"$ref": "./examples/Operations_List.json"
}
},
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK. Successfully retrieved operation list.",
"schema": {
"$ref": "#/definitions/OperationListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}": {
"get": {
"tags": [
"Requests"
],
"description": "Get Customer Lockbox request",
"operationId": "Requests_Get",
"x-ms-examples": {
"Get a lockbox request in subscription scope": {
"$ref": "./examples/Requests_Get_InSubscription.json"
}
},
"parameters": [
{
"$ref": "#/parameters/RequestIdParameter"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Retrieval of Customer Lockbox request successful.",
"schema": {
"$ref": "#/definitions/LockboxRequestResponse"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}/UpdateApproval": {
"post": {
"tags": [
"Requests"
],
"description": "Update Customer Lockbox request approval status API",
"operationId": "Requests_UpdateStatus",
"x-ms-examples": {
"Update a lockbox request status": {
"$ref": "./examples/Requests_UpdateStatus.json"
}
},
"parameters": [
{
"name": "approval",
"in": "body",
"description": "The approval object to update request status.",
"required": true,
"schema": {
"$ref": "#/definitions/Approval"
}
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"$ref": "#/parameters/RequestIdParameter"
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Update of Request Status successful",
"schema": {
"$ref": "#/definitions/Approval"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests": {
"get": {
"tags": [
"Requests"
],
"description": "Lists all of the Lockbox requests in the given subscription.",
"operationId": "Requests_List",
"x-ms-examples": {
"List lockbox requests with no filters": {
"$ref": "./examples/Requests_List.json"
},
"List lockbox requests in a subscription with filter by request status (eg. $filter=properties/status eq 'Pending')": {
"$ref": "./examples/Requests_List_FilterByStatus.json"
}
},
"parameters": [
{
"name": "$filter",
"in": "query",
"required": false,
"type": "string",
"description": "The $filter OData query parameter. Only filter by request status is supported, e.g $filter=properties/status eq 'Pending'"
},
{
"$ref": "#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Successfully listed the Lockbox requests under the given subscription.",
"schema": {
"$ref": "#/definitions/RequestListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"OperationListResult": {
"description": "Result of the request to list Customer Lockbox operations. It contains a list of operations.",
"properties": {
"value": {
"description": "List of Customer Lockbox operations supported by the Microsoft.StreamAnalytics resource provider.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/Operation"
}
},
"nextLink": {
"description": "URL to get the next set of operation list results if there are any.",
"type": "string",
"readOnly": true
}
}
},
"Operation": {
"description": "Operation result model for ARM RP",
"type": "object",
"readOnly": true,
"properties": {
"name": {
"description": "Gets or sets action name",
"type": "string",
"readOnly": true
},
"isDataAction": {
"description": "Gets or sets a value indicating whether it is a data plane action",
"type": "string",
"readOnly": true
},
"display": {
"description": "Contains the localized display information for this particular operation / action.",
"readOnly": true,
"properties": {
"provider": {
"description": "The localized friendly form of the resource provider name.",
"type": "string",
"readOnly": true
},
"resource": {
"description": "The localized friendly form of the resource type related to this action/operation.",
"type": "string",
"readOnly": true
},
"operation": {
"description": "The localized friendly name for the operation.",
"type": "string",
"readOnly": true
},
"description": {
"description": "The localized friendly description for the operation.",
"type": "string",
"readOnly": true
}
}
},
"properties": {
"description": "Gets or sets properties",
"type": "string",
"readOnly": true
},
"origin": {
"description": "Gets or sets origin",
"type": "string",
"readOnly": true
}
}
},
"RequestListResult": {
"description": "Object containing a list of streaming jobs.",
"properties": {
"value": {
"type": "array",
"description": "A list of Lockbox requests. Populated by a 'List' operation.",
"items": {
"$ref": "#/definitions/LockboxRequestResponse"
},
"readOnly": true
},
"nextLink": {
"type": "string",
"readOnly": true,
"description": "URL to get the next set of operation list results if there are any."
}
}
},
"LockboxRequestResponse": {
"description": "A Lockbox request response object, containing all information associated with the request.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The Arm resource id of the Lockbox request.",
"readOnly": true
},
"name": {
"type": "string",
"description": "The name of the Lockbox request.",
"readOnly": true
},
"type": {
"type": "string",
"description": "The type of the Lockbox request.",
"readOnly": true
},
"properties": {
"$ref": "#/definitions/LockboxRequestResponseProperties",
"description": "The properties that are associated with a lockbox request."
}
}
},
"LockboxRequestResponseProperties": {
"description": "The properties that are associated with a lockbox request.",
"type": "object",
"properties": {
"requestId": {
"type": "string",
"readOnly": true,
"description": "The Lockbox request ID."
},
"justification": {
"type": "string",
"readOnly": true,
"description": "The justification of the requestor."
},
"status": {
"$ref": "#/definitions/LockboxRequestStatus",
"description": "The status of the request."
},
"createdDateTime": {
"format": "date-time",
"type": "string",
"description": "The creation time of the request.",
"readOnly": true
},
"expirationDateTime": {
"format": "date-time",
"type": "string",
"description": "The expiration time of the request.",
"readOnly": true
},
"duration": {
"type": "string",
"description": "The duration of the request in hours.",
"readOnly": true
},
"resourceIds": {
"type": "string",
"description": "A list of resource IDs associated with the Lockbox request separated by ','.",
"readOnly": true
},
"resourceType": {
"type": "string",
"description": "The resource type of the requested resources.",
"readOnly": true
},
"supportRequest": {
"type": "string",
"description": "The id of the support request associated.",
"readOnly": true
},
"supportCaseUrl": {
"type": "string",
"description": "The url of the support case.",
"readOnly": true
},
"workItemSource": {
"type": "string",
"description": "The support case system that was used to initiate the request.",
"readOnly": true
},
"subscriptionId": {
"type": "string",
"description": "The subscription ID.",
"readOnly": true
}
}
},
"LockboxRequestStatus": {
"enum": [
"Initializing",
"Pending",
"Approving",
"Denying",
"Approved",
"Denied",
"Expired",
"Revoking",
"Revoked",
"Error",
"Unknown",
"Completed",
"Completing"
],
"type": "string",
"description": "The status of the request.",
"x-ms-enum": {
"name": "Status",
"modelAsString": true
}
},
"Approval": {
"description": "Request content object, in the use of Approve or Deny a Lockbox request.",
"type": "object",
"properties": {
"status": {
"enum": [
"Approve",
"Deny"
],
"type": "string",
"description": "Approval decision to the Lockbox request.",
"x-ms-enum": {
"name": "Status",
"modelAsString": true
}
},
"reason": {
"type": "string",
"description": "Reason of the decision"
}
}
},
"ErrorResponse": {
"x-ms-external": true,
"description": "An error response from the Lockbox service.",
"properties": {
"error": {
"$ref": "#/definitions/ErrorBody",
"description": "Detailed information about the error encountered."
}
}
},
"ErrorBody": {
"x-ms-external": true,
"description": "An error response body from the Lockbox service.",
"properties": {
"code": {
"type": "string",
"description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
},
"message": {
"type": "string",
"description": "A message describing the error, intended to be suitable for display in a user interface."
},
"target": {
"type": "string",
"description": "The target of the particular error. For example, the name of the property in error."
},
"additionalInfo": {
"type": "array",
"items": {
"$ref": "#/definitions/ErrorAdditionalInfo"
},
"description": "A list of error details about the error."
}
}
},
"ErrorAdditionalInfo": {
"x-ms-external": true,
"description": "An error additional info for the Lockbox service.",
"properties": {
"type": {
"type": "string",
"description": "The type of error info."
},
"info": {
"type": "object",
"description": "Additional information about the request that is in error state.",
"properties": {
"currentStatus": {
"$ref": "#/definitions/LockboxRequestStatus",
"description": "The current status/state of the request quired."
}
}
}
}
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"description": "The API version to be used with the HTTP request.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"RequestIdParameter": {
"name": "requestId",
"in": "path",
"description": "The Lockbox request ID.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
}
},
"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"
}
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
]
}