-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[Hub Generated] Review request for Microsoft.Security to add version preview/2021-07-01-preview #15857
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
leniatgh
merged 19 commits into
Azure:main
from
kerend:dev-security-Microsoft.Security-CUAS-2021-07-01-preview
Sep 22, 2021
Merged
[Hub Generated] Review request for Microsoft.Security to add version preview/2021-07-01-preview #15857
Changes from 14 commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
de0189b
Adds base for updating Microsoft.Security from version preview/2021-0…
kerend 055fe40
Updates readme
kerend f4fda53
Updates API version in new specs and examples
kerend 90370f8
.
kerend db421af
.
kerend ab6fb77
.
kerend 41ca7c1
.
kerend 77925f3
.
kerend 53a7c06
.
kerend 03856b9
.
kerend 7e7f45f
.
kerend 1dde42d
.
kerend b2b704e
.
kerend 5273a42
.
kerend ee72a7e
.
kerend 6422ff5
.
kerend 44a724c
.
kerend 2ff7f8d
.
kerend 7f5dfd3
.
kerend File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
335 changes: 335 additions & 0 deletions
335
...rce-manager/Microsoft.Security/preview/2021-07-01-preview/customAssessmentAutomation.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,335 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Security Center", | ||
| "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", | ||
| "version": "2021-07-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": { | ||
| "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Security/customAssessmentAutomations/{customAssessmentAutomationName}": { | ||
| "get": { | ||
| "summary": "Gets a custom assessment automation", | ||
| "description": "Gets a single custom assessment automation by name for the provided subscription and resource group.", | ||
| "tags": [ | ||
| "customAssessmentAutomations" | ||
| ], | ||
| "operationId": "CustomAssessmentAutomations_Get", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/customAssessmentAutomationName" | ||
| } | ||
| ], | ||
| "x-ms-examples": { | ||
| "Get a Custom Assessment Automation": { | ||
| "$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationGet_example.json" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v1/types.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "put": { | ||
| "summary": "Creates a custom assessment automation", | ||
| "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.", | ||
| "tags": [ | ||
| "customAssessmentAutomations" | ||
| ], | ||
| "operationId": "CustomAssessmentAutomations_Create", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/customAssessmentAutomationName" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/customAssessmentAutomationBody" | ||
| } | ||
| ], | ||
| "x-ms-examples": { | ||
| "Create a Custom Assessment Automation": { | ||
| "$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationCreate_example.json" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "201": { | ||
| "description": "Created", | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomation" | ||
| } | ||
| }, | ||
| "200": { | ||
| "description": "OK - Updated", | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomation" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v1/types.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "delete": { | ||
| "summary": "Deletes a custom assessment automation", | ||
| "description": "Deletes a custom assessment automation by name for a provided subscription", | ||
| "tags": [ | ||
| "customAssessmentAutomations" | ||
| ], | ||
| "operationId": "CustomAssessmentAutomations_Delete", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/customAssessmentAutomationName" | ||
| } | ||
| ], | ||
| "x-ms-examples": { | ||
| "Delete a Custom Assessment Automation": { | ||
| "$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationDelete_example.json" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK - Custom Assessment Automation was deleted" | ||
| }, | ||
| "204": { | ||
| "description": "No Content - Custom Assessment Automation does not exist" | ||
| }, | ||
| "default": { | ||
| "description": "Error response describing why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v1/types.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Security/customAssessmentAutomations": { | ||
| "get": { | ||
| "summary": "List custom assessment automations", | ||
| "description": "List custom assessment automations by provided subscription and resource group", | ||
| "tags": [ | ||
| "customAssessmentAutomations" | ||
| ], | ||
| "operationId": "CustomAssessmentAutomations_ListByResourceGroup", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" | ||
| } | ||
| ], | ||
| "x-ms-examples": { | ||
| "List Custom Assessment Automations": { | ||
| "$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationListByResourceGroup_example.json" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK - Returns a collection of Custom Assessment Automations", | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomationsListResult" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response that describes why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v1/types.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/subscriptions/{subscriptionId}/providers/Microsoft.Security/customAssessmentAutomations": { | ||
| "get": { | ||
| "summary": "List custom assessment automations", | ||
| "description": "List custom assessment automations by provided subscription", | ||
| "tags": [ | ||
| "customAssessmentAutomations" | ||
| ], | ||
| "operationId": "CustomAssessmentAutomations_ListBySubscription", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" | ||
| }, | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" | ||
| } | ||
| ], | ||
| "x-ms-examples": { | ||
| "List Custom Assessment Automations": { | ||
| "$ref": "./examples/CustomAssessmentAutomations/customAssessmentAutomationListBySubscription_example.json" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK - Returns a collection of Custom Assessment Automations", | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomationsListResult" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "Error response that describes why the operation failed.", | ||
| "schema": { | ||
| "$ref": "../../../common/v1/types.json#/definitions/CloudError" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "customAssessmentAutomationsListResult": { | ||
| "type": "object", | ||
| "description": "A list of Custom Assessment Automations", | ||
| "properties": { | ||
| "value": { | ||
| "description": "Collection of Custom Assessment Automations", | ||
| "readOnly": true, | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#/definitions/customAssessmentAutomation" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "customAssessmentAutomation": { | ||
| "type": "object", | ||
| "description": "Custom Assessment Automation", | ||
| "properties": { | ||
| "properties": { | ||
| "x-ms-client-flatten": true, | ||
| "description": "describes Custom Assessment Automation properties.", | ||
| "$ref": "#/definitions/customAssessmentAutomationProperties" | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/definitions/Resource" | ||
| } | ||
| ] | ||
| }, | ||
| "customAssessmentAutomationProperties": { | ||
| "type": "object", | ||
| "description": "describes the Custom Assessment Automation properties", | ||
| "properties": { | ||
| "compressedQuery": { | ||
| "description": "GZip encoded KQL query representing the assessment automation results required.", | ||
| "type": "string" | ||
| }, | ||
| "supportedCloud": { | ||
| "description": "Relevant cloud for the custom assessment automation.", | ||
| "type": "string", | ||
| "enum": [ | ||
| "AWS" | ||
| ] | ||
| }, | ||
| "severity": { | ||
| "description": "The severity to relate to the assessments generated by this assessment automation.", | ||
| "type": "string", | ||
| "enum": [ | ||
| "High", | ||
| "Medium", | ||
| "Low" | ||
| ] | ||
| }, | ||
| "description": { | ||
| "description": "The description to relate to the assessments generated by this assessment automation.", | ||
| "type": "string" | ||
| }, | ||
| "remediationDescription": { | ||
| "description": "The remediation description to relate to the assessments generated by this assessment automation.", | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "customAssessmentAutomationName": { | ||
| "name": "customAssessmentAutomationName", | ||
| "in": "path", | ||
| "required": true, | ||
| "type": "string", | ||
| "description": "Name of the Custom Assessment Automation.", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "customAssessmentAutomationBody": { | ||
| "name": "customAssessmentAutomationBody", | ||
| "in": "body", | ||
| "description": "Custom Assessment Automation body", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/customAssessmentAutomation" | ||
| }, | ||
| "x-ms-parameter-location": "method" | ||
| } | ||
| } | ||
| } | ||
47 changes: 47 additions & 0 deletions
47
...review/examples/CustomAssessmentAutomations/customAssessmentAutomationCreate_example.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| { | ||
| "parameters": { | ||
| "api-version": "2021-07-01-preview", | ||
| "subscriptionId": "e5d1b86c-3051-44d5-8802-aa65d45a279b", | ||
| "resourceGroupName": "TestResourceGroup", | ||
| "customAssessmentAutomationName": "MyCustomAssessmentAutomation", | ||
| "customAssessmentAutomationBody": { | ||
| "properties": { | ||
| "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=", | ||
| "supportedCloud": "AWS", | ||
| "severity": "Medium", | ||
| "description": "Data should be encrypted", | ||
| "remediationDescription": "Encrypt store by..." | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/33e7cc6e-a139-4723-a0e5-76993aee0771", | ||
| "name": "33e7cc6e-a139-4723-a0e5-76993aee0771", | ||
| "type": "Microsoft.Security/customAssessmentAutomations", | ||
| "properties": { | ||
| "compressedQuery": "H4sIAAAAAAAAAwtILC4uzy9KCcjPyUyu5OWqUShJzE5VMAQAlMJzABgAAAA=", | ||
| "supportedCloud": "AWS", | ||
| "severity": "Medium", | ||
| "description": "Data should be encrypted", | ||
| "remediationDescription": "Encrypt store by..." | ||
| } | ||
| } | ||
| }, | ||
| "201": { | ||
| "body": { | ||
| "id": "/subscriptions/e5d1b86c-3051-44d5-8802-aa65d45a279b/resourcegroups/TestResourceGroup/providers/Microsoft.Security/customAssessmentAutomations/33e7cc6e-a139-4723-a0e5-76993aee0771", | ||
| "name": "33e7cc6e-a139-4723-a0e5-76993aee0771", | ||
| "type": "Microsoft.Security/customAssessmentAutomations", | ||
| "properties": { | ||
| "compressedQuery": "H4sIAAAAAAAAAwvIz8lMrgzKz0nlqlFIrShJzUtR8Cz2SE3MKcmoVLBVUE9LzClOVQcA1IFnficAAAA=", | ||
| "supportedCloud": "AWS", | ||
| "severity": "Low", | ||
| "description": "organization passwords policy", | ||
| "remediationDescription": "Change password policy to..." | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
12 changes: 12 additions & 0 deletions
12
...review/examples/CustomAssessmentAutomations/customAssessmentAutomationDelete_example.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| { | ||
| "parameters": { | ||
| "api-version": "2021-07-01-preview", | ||
| "subscriptionId": "e5d1b86c-3051-44d5-8802-aa65d45a279b", | ||
| "resourceGroupName": "TestResourceGroup", | ||
| "customAssessmentAutomationName": "MyCustomAssessmentAutomation" | ||
| }, | ||
| "responses": { | ||
| "200": {}, | ||
| "204": {} | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Define x-ms-paging on collection API. Currently even if you don't need/support paging, by declaring the paging constructs, you can enable paging in future with out introducing a new api version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment applicable in other places too.