Skip to content

Introducing new API for Advanced Threat Protection #3306

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
marstr merged 8 commits into from
Sep 17, 2018
Merged

Introducing new API for Advanced Threat Protection #3306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9bebc93
Introducing new API for Advanced Threat Protection
tomerlmsft Jun 26, 2018
eb87b43
Addressing pull request comments
tomerlmsft Jun 28, 2018
f0fc406
Renaming obejct from AdvancedThreatProtectionSettings to AdvancedThre…
tomerlmsft Jul 2, 2018
782c68f
Removed delete operation from the swagger definitions
tomerlmsft Jul 2, 2018
256d582
Fixed test failures
tomerlmsft Jul 2, 2018
5932dae
Changing "AdvancedThreatProtectionSettingName" parameter to enum type
tomerlmsft Jul 5, 2018
3382416
Changed param name from 'enabled' to 'isEnabled'
tomerlmsft Aug 15, 2018
ec16963
Merge branch 'master' into master
tomerlmsft Sep 17, 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
19 changes: 19 additions & 0 deletions ...review/examples/AdvancedThreatProtection/GetAdvancedThreatProtectionSettings_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"parameters": {
"api-version": "2017-08-01-preview",
"resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount",
"settingName": "current"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/advancedThreatProtectionSettings/current",
"name": "current",
"type": "Microsoft.Security/advancedThreatProtectionSettings",
"properties": {
"isEnabled": true
}
}
}
}
}
27 changes: 27 additions & 0 deletions ...review/examples/AdvancedThreatProtection/PutAdvancedThreatProtectionSettings_example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"parameters": {
"api-version": "2017-08-01-preview",
"resourceId": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount",
"settingName": "current",
"advancedThreatProtectionSetting": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/advancedThreatProtectionSettings/current",
"name": "current",
"type": "Microsoft.Security/advancedThreatProtectionSettings",
"properties": {
"isEnabled": true
}
}
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/SampleRG/providers/Microsoft.Storage/storageAccounts/samplestorageaccount/providers/Microsoft.Security/advancedThreatProtectionSettings/current",
"name": "current",
"type": "Microsoft.Security/advancedThreatProtectionSettings",
"properties": {
"isEnabled": true
}
}
}
}
}
126 changes: 126 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 @@ -728,6 +728,81 @@
}
}
},
"/{resourceId}/providers/Microsoft.Security/advancedThreatProtectionSettings/{settingName}": {
"get": {
"x-ms-examples": {
"Gets the Advanced Threat Protection settings for the specified resource.": {
"$ref": "./examples/AdvancedThreatProtection/GetAdvancedThreatProtectionSettings_example.json"
}
},
"tags": [ "AdvancedThreatProtection" ],
"description": "Gets the Advanced Threat Protection settings for the specified resource.",
"operationId": "AdvancedThreatProtection_Get",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/ResourceId"
},
{
"$ref": "#/parameters/AdvancedThreatProtectionSettingName"
}
],
"responses": {
"200": {
"description": "Successful request to get Advanced Threat Protection settings.",
"schema": {
"$ref": "#/definitions/AdvancedThreatProtectionSetting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
},
"put": {
"x-ms-examples": {
"Creates or updates the Advanced Threat Protection settings on a specified resource.": {
"$ref": "./examples/AdvancedThreatProtection/PutAdvancedThreatProtectionSettings_example.json"
}
},
"tags": [ "AdvancedThreatProtection" ],
"description": "Creates or updates the Advanced Threat Protection settings on a specified resource.",
"operationId": "AdvancedThreatProtection_Create",
"parameters": [
{
"$ref": "#/parameters/ApiVersion"
},
{
"$ref": "#/parameters/ResourceId"
},
{
"$ref": "#/parameters/AdvancedThreatProtectionSettingName"
},
{
"$ref": "#/parameters/AdvancedThreatProtectionSetting"
}
],
"responses": {
"200": {
"description": "Successful request to put Advanced Threat Protection settings.",
"schema": {
"$ref": "#/definitions/AdvancedThreatProtectionSetting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "#/definitions/CloudError"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Security/settings": {
"get": {
"x-ms-examples": {
Expand Down Expand Up @@ -1247,6 +1322,30 @@
}
}
},
"AdvancedThreatProtectionProperties": {
"properties": {
"isEnabled": {
"type": "boolean",
"description": "Indicates whether Advanced Threat Protection is enabled."
}
},
"description": "The Advanced Threat Protection settings."
},
"AdvancedThreatProtectionSetting": {
"type": "object",
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AdvancedThreatProtectionProperties"
}
},
"description": "The Advanced Threat Protection resource."
},
"SettingsList": {
"type": "object",
"description": "Subscription settings list.",
Expand Down Expand Up @@ -1469,6 +1568,33 @@
"type": "string",
"description": "name of the Compliance",
"x-ms-parameter-location": "method"
},
"ResourceId": {
"name": "resourceId",
"in": "path",
"required": true,
"type": "string",
"description": "The identifier of the resource.",
"x-ms-parameter-location": "method"
},
"AdvancedThreatProtectionSettingName": {
Copy link
Copy Markdown
Contributor

@ravbhatnagar ravbhatnagar Jul 3, 2018

Choose a reason for hiding this comment

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

if current is the only value supported for the setting name we should make an enum with one value.

Copy link
Copy Markdown
Contributor

@ravbhatnagar ravbhatnagar Jul 3, 2018

Choose a reason for hiding this comment

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

Also do you support a list API?

Copy link
Copy Markdown
Contributor Author

@tomerlmsft tomerlmsft Jul 5, 2018

Choose a reason for hiding this comment

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

I changed it to enum with one value, thanks for the comment.

Copy link
Copy Markdown
Contributor Author

@tomerlmsft tomerlmsft Jul 5, 2018

Choose a reason for hiding this comment

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

We don't support LIST in our API, the only available type of settings name right now is "current".

"name": "settingName",
"in": "path",
"required": true,
"type": "string",
"enum": ["current"],
"description": "Advanced Threat Protection setting name.",
"x-ms-parameter-location": "method"
},
"AdvancedThreatProtectionSetting": {
"name": "advancedThreatProtectionSetting",
"in": "body",
"required": true,
"description": "Advanced Threat Protection Settings",
"schema": {
"$ref": "#/definitions/AdvancedThreatProtectionSetting"
},
"x-ms-parameter-location": "method"
}
}
}