Skip to content

Introducing new API for Azure Security Center Settings #3511

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.

Sign up for GitHub

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
jianghaolu merged 5 commits into from Aug 27, 2018
Merged

Introducing new API for Azure Security Center Settings #3511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d54953d
Add new API for Azure Security Center Settings
tomer-weinberger Jul 26, 2018
1efe8f5
Changed SettingsPUT API to receive parameter and not definition.
tomer-weinberger Jul 26, 2018
41e9a4f
- changed settings parameter name in example and in security paramete…
tomer-weinberger Jul 29, 2018
caeaaa8
changes settings to setting in Settings API
tomer-weinberger Jul 30, 2018
ee991b7
settings kind to setting kind in settings CSM API
tomer-weinberger Jul 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions ...r/Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSetting_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"api-version": "2017-08-01-preview",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"settingName": "MCAS"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
"kind": "DataExportSetting",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
}
}
}
}
}
32 changes: 32 additions & 0 deletions .../Microsoft.Security/preview/2017-08-01-preview/examples/Settings/GetSettings_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"api-version": "2017-08-01-preview",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
"kind": "DataExportSetting",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/WDATP",
"name": "WDATP",
"kind": "DataExportSetting",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": false
}
}
]
}
}
}
}
29 changes: 29 additions & 0 deletions ...icrosoft.Security/preview/2017-08-01-preview/examples/Settings/UpdateSetting_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"parameters": {
"api-version": "2017-08-01-preview",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"settingName": "MCAS",
"setting": {
Copy link
Copy Markdown
Contributor

@jianghaolu jianghaolu Jul 26, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "settings"?

Copy link
Copy Markdown
Author

@ghost ghost Jul 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right changed parameter in example and in parameter definition to match.

"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
"kind": "DataExportSetting",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/settings/MCAS",
"name": "MCAS",
"kind": "DataExportSetting",
"type": "Microsoft.Security/settings",
"properties": {
"enabled": true
}
}
}
}
}
234 changes: 234 additions & 0 deletions ...ion/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/security.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -727,6 +727,124 @@
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings": {
"get": {
"x-ms-examples": {
"Get settings of subscription": {
"$ref": "./examples/Settings/GetSettings_example.json"
}
},
"tags": [
"Settings"
],
"description": "Settings about different configurations in security center",
"operationId": "Settings_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/SubscriptionId"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SettingsList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings/{settingName}": {
"get": {
"x-ms-examples": {
"Get a setting on subscription": {
"$ref": "./examples/Settings/GetSetting_example.json"
}
},
"tags": [
"Settings"
],
"description": "Settings of different configurations in security center",
"operationId": "Settings_Get",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/SettingName"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"put": {
"x-ms-examples": {
"Update a setting for subscription": {
"$ref": "./examples/Settings/UpdateSetting_example.json"
}
},
"tags": [
"Settings"
],
"description": "updating settings about different configurations in security center",
"operationId": "Settings_Update",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/SettingName"
},
{
"$ref": "#/parameters/Setting"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -781,6 +899,16 @@
},
"x-ms-azure-resource": true
},
"Kind": {
"type": "object",
"description": "Describes an Azure resource with kind",
"properties": {
"kind": {
"type": "string",
"description": "Kind of the resource"
}
}
},
"SecurityContactList": {
"type": "object",
"description": "List of security contacts response",
Expand Down Expand Up @@ -1118,6 +1246,90 @@
"description": "The size (%) of the segment."
}
}
},
"SettingsList": {
"type": "object",
"description": "Subscription settings list.",
"properties": {
"value": {
"type": "array",
"description": "The settings list.",
"items": {
"$ref": "#/definitions/Setting"
}
},
"nextLink": {
"readOnly": true,
"type": "string",
"description": "The URI to fetch the next page."
}
}
},
"Setting": {
"type": "object",
"description": "Represents a security setting in Azure Security Center.",
"discriminator": "kind",
"properties": {},
"allOf": [
{
"$ref": "#/definitions/Resource"
},
{
"$ref": "#/definitions/SettingKind"
}
]
},
"DataExportSetting": {
"type": "object",
"description": "Represents a data export setting",
"x-ms-discriminator-value": "DataExportSetting",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"description": "Data export setting data",
"$ref": "#/definitions/DataExportSettingProperties"
}
},
"allOf": [
{
"$ref": "#/definitions/Setting"
}
]
},
"SettingKind": {
"type": "object",
"description": "The kind of the security setting",
"properties": {
"kind": {
"type": "string",
"description": "the kind of the settings string",
"enum": [
"DataExportSetting"
],
"x-ms-enum": {
"name": "SettingKind",
"modelAsString": true,
"values": [
{
"value": "DataExportSetting"
}
]
}
}
}
},
"DataExportSettingProperties": {
"type": "object",
"description": "The data export setting properties",
"properties": {
"enabled": {
"type": "boolean",
"description": "Is the data export setting is enabled"
}
},
"required": [
"enabled"
]
}
},
"parameters": {
Expand Down Expand Up @@ -1210,6 +1422,28 @@
},
"x-ms-parameter-location": "method"
},
"SettingName": {
"name": "settingName",
"in": "path",
"required": true,
"type": "string",
"description": "Name of setting",
"enum": [
"MCAS",
"WDATP"
],
"x-ms-parameter-location": "method"
},
"Setting": {
"name": "setting",
"in": "body",
"required": true,
"description": "Setting object",
"schema": {
"$ref": "#/definitions/Setting"
},
"x-ms-parameter-location": "method"
},
"AutoProvisioningSettingName": {
"name": "settingName",
"in": "path",
Expand Down