-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
guestDiagnosticSettingsAssociation_API.json
424 lines (424 loc) · 13.9 KB
/
guestDiagnosticSettingsAssociation_API.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
{
"swagger": "2.0",
"info": {
"title": "Guest Diagnostic Settings Association API",
"description": "API to Add/Remove/List Guest Diagnostics Settings Association for Azure Resources",
"x-ms-code-generation-settings": {
"name": "MonitorManagementClient"
},
"version": "2018-06-01-preview"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/{resourceUri}/providers/microsoft.insights/guestDiagnosticSettingsAssociation/{associationName}": {
"put": {
"description": "Creates or updates guest diagnostics settings association.",
"tags": [
"GuestDiagnosticsSettingsAssociation"
],
"operationId": "GuestDiagnosticsSettingsAssociation_CreateOrUpdate",
"x-ms-examples": {
"Create or update an guest diagnostic settings association": {
"$ref": "./examples/createOrUpdateGuestDiagnosticSettingsAssociation.json"
}
},
"parameters": [
{
"name": "resourceUri",
"in": "path",
"required": true,
"type": "string",
"description": "The fully qualified ID of the resource, including the resource name and resource type.",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"name": "diagnosticSettingsAssociation",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
},
"description": "The diagnostic settings association to create or update."
}
],
"responses": {
"200": {
"description": "An existing guest diagnostic settings association was successfully updated.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
}
},
"201": {
"description": "A new guest diagnostic settings association was successfully created.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
}
},
"default": {
"description": "An error occurred and the guest diagnostic settings association could not be created or updated.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"get": {
"description": "Gets guest diagnostics association settings.",
"tags": [
"GuestDiagnosticsSettingsAssociation"
],
"operationId": "GuestDiagnosticsSettingsAssociation_Get",
"x-ms-examples": {
"Create or update an guest diagnostic settings association": {
"$ref": "./examples/getGuestDiagnosticSettingsAssociation.json"
}
},
"parameters": [
{
"name": "resourceUri",
"in": "path",
"required": true,
"type": "string",
"description": "The fully qualified ID of the resource, including the resource name and resource type.",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The request succeeded.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
}
},
"default": {
"description": "An error occurred and the diagnostic settings association could not be retrieved.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"delete": {
"description": "Delete guest diagnostics association settings.",
"tags": [
"GuestDiagnosticsSettingsAssociation"
],
"x-ms-examples": {
"Create or update an guest diagnostic settings association": {
"$ref": "./examples/deleteGuestDiagnosticSettingsAssociation.json"
}
},
"operationId": "GuestDiagnosticsSettingsAssociation_Delete",
"parameters": [
{
"name": "resourceUri",
"in": "path",
"required": true,
"type": "string",
"description": "The fully qualified ID of the resource, including the resource name and resource type.",
"x-ms-skip-url-encoding": true
},
{
"$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The diagnostic settings association was successfully deleted."
},
"204": {
"description": "The diagnostic settings association does not exist. It may have already been deleted."
},
"default": {
"description": "An error occurred and the diagnostic settings association could not be deleted.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
},
"patch": {
"description": "Updates an existing guestDiagnosticsSettingsAssociation Resource. To update other fields use the CreateOrUpdate method",
"operationId": "GuestDiagnosticsSettingsAssociation_Update",
"parameters": [
{
"name": "resourceUri",
"in": "path",
"required": true,
"type": "string",
"description": "The fully qualified ID of the resource, including the resource name and resource type.",
"x-ms-skip-url-encoding": true
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/DiagnosticSettingsAssociationNameParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResourcePatch"
},
"description": "Parameters supplied to the operation."
}
],
"responses": {
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
},
"200": {
"description": "An existing guest diagnostics setting resource was successfully updated.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
}
}
},
"x-ms-examples": {
"Update a service diagnostic setting": {
"$ref": "./examples/updateGuestDiagnosticSettingsAssociation.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettingsAssociations": {
"get": {
"description": "Get a list of all guest diagnostic settings association in a subscription.",
"operationId": "GuestDiagnosticsSettingsAssociation_List",
"x-ms-pageable": {
"nextLinkName": null
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The request succeeded.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationList"
}
},
"default": {
"description": "An error occurred and the list of guest diagnostic settings association could not be retrieved.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.insights/guestDiagnosticSettingsAssociations": {
"get": {
"description": "Get a list of all guest diagnostic settings association in a resource group.",
"operationId": "GuestDiagnosticsSettingsAssociation_ListByResourceGroup",
"x-ms-pageable": {
"nextLinkName": null
},
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The request succeeded.",
"schema": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationList"
}
},
"default": {
"description": "An error occurred and the list of guest diagnostic settings association could not be retrieved.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
}
}
}
},
"definitions": {
"ErrorResponse": {
"description": "Describes the format of Error response.",
"type": "object",
"properties": {
"code": {
"description": "Error code",
"type": "string"
},
"message": {
"description": "Error message indicating why the operation failed.",
"type": "string"
}
}
},
"GuestDiagnosticSettingsAssociationList": {
"description": "A list of guest diagnostic settings association.",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/GuestDiagnosticSettingsAssociationResource"
},
"description": "The list of guest diagnostic settings association."
},
"nextLink": {
"type": "string",
"description": "Provides the link to retrieve the next set of elements."
}
}
},
"GuestDiagnosticSettingsAssociationResourcePatch": {
"description": "Guest diagnostic setting resource for patch operations",
"properties": {
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags"
},
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/GuestDiagnosticSettingsAssociation",
"description": "The service diagnostics settings for an update operation."
}
}
},
"GuestDiagnosticSettingsAssociation": {
"description": "A guest diagnostic settings association.",
"properties": {
"guestDiagnosticSettingsName": {
"type": "string",
"description": "The guest diagnostic settings name."
}
},
"required": [
"guestDiagnosticSettingsName"
]
},
"GuestDiagnosticSettingsAssociationResource": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"required": [
"properties"
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/GuestDiagnosticSettingsAssociation",
"description": "The diagnostics settings associations of the resource."
}
},
"description": "Virtual machine guest diagnostic settings resource."
},
"Resource": {
"properties": {
"id": {
"type": "string",
"readOnly": true,
"description": "Azure resource Id"
},
"name": {
"type": "string",
"readOnly": true,
"description": "Azure resource name"
},
"type": {
"type": "string",
"readOnly": true,
"description": "Azure resource type"
},
"location": {
"type": "string",
"description": "Resource location",
"x-ms-mutability": [
"create",
"read"
]
},
"tags": {
"additionalProperties": {
"type": "string"
},
"description": "Resource tags"
}
},
"required": [
"location"
],
"x-ms-azure-resource": true,
"description": "An azure resource object"
}
},
"parameters": {
"DiagnosticSettingsAssociationNameParameter": {
"name": "associationName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the diagnostic settings association.",
"x-ms-parameter-location": "method"
}
}
}