Skip to content

Commit 54c17d8

Browse files
kerendkerend
authored
[Hub Generated] Review request for Microsoft.Security to add version preview/2021-07-01-preview (#15857)
* Adds base for updating Microsoft.Security from version preview/2021-05-01-preview to version 2021-07-01-preview * Updates readme * Updates API version in new specs and examples * . * . * . * . * . * . * . * . * . * . * . * . * . * . * . * .
1 parent 0cfcacb commit 54c17d8

File tree

7 files changed

+534
-1
lines changed

7 files changed

+534
-1
lines changed

‎specification/security/resource-manager/Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json‎

Lines changed: 355 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,355 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"title": "Security Center",
5+
"description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
6+
"version": "2021-07-01-preview"
7+
},
8+
"host": "management.azure.com",
9+
"schemes": [
10+
"https"
11+
],
12+
"consumes": [
13+
"application/json"
14+
],
15+
"produces": [
16+
"application/json"
17+
],
18+
"security": [
19+
{
20+
"azure_auth": [
21+
"user_impersonation"
22+
]
23+
}
24+
],
25+
"securityDefinitions": {
26+
"azure_auth": {
27+
"type": "oauth2",
28+
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
29+
"flow": "implicit",
30+
"description": "Azure Active Directory OAuth2 Flow",
31+
"scopes": {
32+
"user_impersonation": "impersonate your user account"
33+
}
34+
}
35+
},
36+
"paths": {
37+
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Security/customAssessmentAutomations/{customAssessmentAutomationName}": {
38+
"get": {
39+
"summary": "Gets a custom assessment automation",
40+
"description": "Gets a single custom assessment automation by name for the provided subscription and resource group.",
41+
"tags": [
42+
"customAssessmentAutomations"
43+
],
44+
"operationId": "CustomAssessmentAutomations_Get",
45+
"parameters": [
46+
{
47+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
48+
},
49+
{
50+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
51+
},
52+
{
53+
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
54+
},
55+
{
56+
"$ref": "#/parameters/customAssessmentAutomationName"
57+
}
58+
],
59+
"x-ms-examples": {
60+
"Get a Custom Assessment Automation": {
61+
"$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationGet_example.json"
62+
}
63+
},
64+
"responses": {
65+
"200": {
66+
"description": "OK",
67+
"schema": {
68+
"$ref": "#/definitions/customAssessmentAutomation"
69+
}
70+
},
71+
"default": {
72+
"description": "Error response describing why the operation failed.",
73+
"schema": {
74+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
75+
}
76+
}
77+
}
78+
},
79+
"put": {
80+
"summary": "Creates a custom assessment automation",
81+
"description": "Creates or updates a custom assessment automation for the provided subscription. Please note that providing an existing custom assessment automation will replace the existing record.",
82+
"tags": [
83+
"customAssessmentAutomations"
84+
],
85+
"operationId": "CustomAssessmentAutomations_Create",
86+
"parameters": [
87+
{
88+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
89+
},
90+
{
91+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
92+
},
93+
{
94+
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
95+
},
96+
{
97+
"$ref": "#/parameters/customAssessmentAutomationName"
98+
},
99+
{
100+
"$ref": "#/parameters/customAssessmentAutomationBody"
101+
}
102+
],
103+
"x-ms-examples": {
104+
"Create a Custom Assessment Automation": {
105+
"$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationCreate_example.json"
106+
}
107+
},
108+
"responses": {
109+
"201": {
110+
"description": "Created",
111+
"schema": {
112+
"$ref": "#/definitions/customAssessmentAutomation"
113+
}
114+
},
115+
"200": {
116+
"description": "OK - Updated",
117+
"schema": {
118+
"$ref": "#/definitions/customAssessmentAutomation"
119+
}
120+
},
121+
"default": {
122+
"description": "Error response describing why the operation failed.",
123+
"schema": {
124+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
125+
}
126+
}
127+
}
128+
},
129+
"delete": {
130+
"summary": "Deletes a custom assessment automation",
131+
"description": "Deletes a custom assessment automation by name for a provided subscription",
132+
"tags": [
133+
"customAssessmentAutomations"
134+
],
135+
"operationId": "CustomAssessmentAutomations_Delete",
136+
"parameters": [
137+
{
138+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
139+
},
140+
{
141+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
142+
},
143+
{
144+
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
145+
},
146+
{
147+
"$ref": "#/parameters/customAssessmentAutomationName"
148+
}
149+
],
150+
"x-ms-examples": {
151+
"Delete a Custom Assessment Automation": {
152+
"$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationDelete_example.json"
153+
}
154+
},
155+
"responses": {
156+
"200": {
157+
"description": "OK - Custom Assessment Automation was deleted"
158+
},
159+
"204": {
160+
"description": "No Content - Custom Assessment Automation does not exist"
161+
},
162+
"default": {
163+
"description": "Error response describing why the operation failed.",
164+
"schema": {
165+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
166+
}
167+
}
168+
}
169+
}
170+
},
171+
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Security/customAssessmentAutomations": {
172+
"get": {
173+
"summary": "List custom assessment automations in a subscription and a resource group",
174+
"description": "List custom assessment automations by provided subscription and resource group",
175+
"tags": [
176+
"customAssessmentAutomations"
177+
],
178+
"operationId": "CustomAssessmentAutomations_ListByResourceGroup",
179+
"parameters": [
180+
{
181+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
182+
},
183+
{
184+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
185+
},
186+
{
187+
"$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName"
188+
}
189+
],
190+
"x-ms-examples": {
191+
"List Custom Assessment Automations in a subscription and a resource group": {
192+
"$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationListByResourceGroup_example.json"
193+
}
194+
},
195+
"responses": {
196+
"200": {
197+
"description": "OK - Returns a collection of Custom Assessment Automations",
198+
"schema": {
199+
"$ref": "#/definitions/customAssessmentAutomationsListResult"
200+
}
201+
},
202+
"default": {
203+
"description": "Error response that describes why the operation failed.",
204+
"schema": {
205+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
206+
}
207+
}
208+
},
209+
"x-ms-pageable": {
210+
"nextLinkName": "nextLink"
211+
}
212+
}
213+
},
214+
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/customAssessmentAutomations": {
215+
"get": {
216+
"summary": "List custom assessment automations in a subscription",
217+
"description": "List custom assessment automations by provided subscription",
218+
"tags": [
219+
"customAssessmentAutomations"
220+
],
221+
"operationId": "CustomAssessmentAutomations_ListBySubscription",
222+
"parameters": [
223+
{
224+
"$ref": "../../../common/v1/types.json#/parameters/ApiVersion"
225+
},
226+
{
227+
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
228+
}
229+
],
230+
"x-ms-examples": {
231+
"List Custom Assessment Automations in a subscription": {
232+
"$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationListBySubscription_example.json"
233+
}
234+
},
235+
"responses": {
236+
"200": {
237+
"description": "OK - Returns a collection of Custom Assessment Automations",
238+
"schema": {
239+
"$ref": "#/definitions/customAssessmentAutomationsListResult"
240+
}
241+
},
242+
"default": {
243+
"description": "Error response that describes why the operation failed.",
244+
"schema": {
245+
"$ref": "../../../common/v1/types.json#/definitions/CloudError"
246+
}
247+
}
248+
},
249+
"x-ms-pageable": {
250+
"nextLinkName": "nextLink"
251+
}
252+
}
253+
}
254+
},
255+
"definitions": {
256+
"customAssessmentAutomationsListResult": {
257+
"type": "object",
258+
"description": "A list of Custom Assessment Automations",
259+
"properties": {
260+
"value": {
261+
"description": "Collection of Custom Assessment Automations",
262+
"readOnly": true,
263+
"type": "array",
264+
"items": {
265+
"$ref": "#/definitions/customAssessmentAutomation"
266+
}
267+
},
268+
"nextLink": {
269+
"description": "The link used to get the next page of operations.",
270+
"type": "string"
271+
}
272+
}
273+
},
274+
"customAssessmentAutomation": {
275+
"type": "object",
276+
"description": "Custom Assessment Automation",
277+
"properties": {
278+
"properties": {
279+
"x-ms-client-flatten": true,
280+
"description": "describes Custom Assessment Automation properties.",
281+
"$ref": "#/definitions/customAssessmentAutomationProperties"
282+
}
283+
},
284+
"allOf": [
285+
{
286+
"$ref": "../../../common/v1/types.json#/definitions/Resource"
287+
}
288+
]
289+
},
290+
"customAssessmentAutomationProperties": {
291+
"type": "object",
292+
"description": "describes the Custom Assessment Automation properties",
293+
"properties": {
294+
"compressedQuery": {
295+
"description": "GZip encoded KQL query representing the assessment automation results required.",
296+
"type": "string"
297+
},
298+
"supportedCloud": {
299+
"description": "Relevant cloud for the custom assessment automation.",
300+
"type": "string",
301+
"enum": [
302+
"AWS"
303+
],
304+
"x-ms-enum": {
305+
"name": "supportedCloudEnum",
306+
"modelAsString": true
307+
},
308+
"x-ms-client-default": "AWS"
309+
},
310+
"severity": {
311+
"description": "The severity to relate to the assessments generated by this assessment automation.",
312+
"type": "string",
313+
"enum": [
314+
"High",
315+
"Medium",
316+
"Low"
317+
],
318+
"x-ms-enum": {
319+
"name": "severityEnum",
320+
"modelAsString": true
321+
},
322+
"x-ms-client-default": "Low"
323+
},
324+
"description": {
325+
"description": "The description to relate to the assessments generated by this assessment automation.",
326+
"type": "string"
327+
},
328+
"remediationDescription": {
329+
"description": "The remediation description to relate to the assessments generated by this assessment automation.",
330+
"type": "string"
331+
}
332+
}
333+
}
334+
},
335+
"parameters": {
336+
"customAssessmentAutomationName": {
337+
"name": "customAssessmentAutomationName",
338+
"in": "path",
339+
"required": true,
340+
"type": "string",
341+
"description": "Name of the Custom Assessment Automation.",
342+
"x-ms-parameter-location": "method"
343+
},
344+
"customAssessmentAutomationBody": {
345+
"name": "customAssessmentAutomationBody",
346+
"in": "body",
347+
"description": "Custom Assessment Automation body",
348+
"required": true,
349+
"schema": {
350+
"$ref": "#/definitions/customAssessmentAutomation"
351+
},
352+
"x-ms-parameter-location": "method"
353+
}
354+
}
355+
}

0 commit comments

Comments
 (0)