Skip to content

Commit

Permalink
Creating stable version for settings type (#5435)
Browse files Browse the repository at this point in the history
* Adding stable API version for Settings

* Changing new version Settings file
  • Loading branch information
chlahav authored and sergey-shandar committed Apr 6, 2019
1 parent 04b1040 commit d75670d
Show file tree
Hide file tree
Showing 5 changed files with 362 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"api-version": "2019-01-01",
"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
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"parameters": {
"api-version": "2019-01-01",
"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
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"parameters": {
"api-version": "2019-01-01",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23",
"settingName": "MCAS",
"setting": {
"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
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,251 @@
{
"swagger": "2.0",
"info": {
"title": "Security Center",
"description": "API spec for Microsoft.Security (Azure Security Center) resource provider",
"version": "2019-01-01"
},
"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}/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": "../../../common/v1/types.json#/parameters/ApiVersion"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/SettingsList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion"
},
{
"$ref": "../../../common/v1/types.json#/parameters/SubscriptionId"
},
{
"$ref": "#/parameters/SettingName"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Setting"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/parameters/ApiVersion"
},
{
"$ref": "../../../common/v1/types.json#/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": "../../../common/v1/types.json#/definitions/CloudError"
}
}
}
}
}
},
"definitions": {
"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/SettingResource"
}
]
},
"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"
}
]
},
"SettingResource": {
"type": "object",
"description": "The kind of the security setting",
"properties": {
"kind": {
"type": "string",
"description": "the kind of the settings string (DataExportSetting)",
"enum": ["DataExportSetting", "AlertSuppressionSetting"],
"x-ms-enum": {
"name": "SettingKind",
"modelAsString": true,
"values": [
{
"value": "DataExportSetting"
},
{
"value": "AlertSuppressionSetting"
}
]
}
}
},
"required": ["kind"],
"allOf": [
{
"$ref": "../../../common/v1/types.json#/definitions/Resource"
}
]
},
"DataExportSettingProperties": {
"type": "object",
"description": "The data export setting properties",
"properties": {
"enabled": {
"type": "boolean",
"description": "Is the data export setting is enabled"
}
},
"required": ["enabled"]
}
},
"parameters": {
"SettingName": {
"name": "settingName",
"in": "path",
"required": true,
"type": "string",
"description": "Name of setting: (MCAS/WDATP)",
"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"
}
}
}
31 changes: 30 additions & 1 deletion specification/security/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ These are the global settings for the Security API.
title: SecurityCenter
description: API spec for Microsoft.Security (Azure Security Center) resource provider
openapi-type: arm
tag: package-composite-v2
tag: package-composite-v3
```
## Composite packages
Expand Down Expand Up @@ -109,6 +109,35 @@ override-info:
title: SecurityCenter
```

### Tag: package-composite-v3

These settings apply only when `--tag=package-composite-v3` is specified on the command line.

```yaml $(tag) == 'package-composite-v3'
input-file:
- Microsoft.Security/stable/2018-06-01/pricings.json
- Microsoft.Security/stable/2019-01-01/alerts.json
- Microsoft.Security/stable/2019-01-01/settings.json
- Microsoft.Security/preview/2015-06-01-preview/allowedConnections.json
- Microsoft.Security/preview/2015-06-01-preview/discoveredSecuritySolutions.json
- Microsoft.Security/preview/2015-06-01-preview/externalSecuritySolutions.json
- Microsoft.Security/preview/2015-06-01-preview/jitNetworkAccessPolicies.json
- Microsoft.Security/preview/2015-06-01-preview/locations.json
- Microsoft.Security/preview/2015-06-01-preview/operations.json
- Microsoft.Security/preview/2015-06-01-preview/tasks.json
- Microsoft.Security/preview/2015-06-01-preview/topologies.json
- Microsoft.Security/preview/2017-08-01-preview/advancedThreatProtectionSettings.json
- Microsoft.Security/preview/2017-08-01-preview/autoProvisioningSettings.json
- Microsoft.Security/preview/2017-08-01-preview/compliances.json
- Microsoft.Security/preview/2017-08-01-preview/informationProtectionPolicies.json
- Microsoft.Security/preview/2017-08-01-preview/securityContacts.json
- Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json
# Needed when there is more than one input file
override-info:
title: SecurityCenter
```

---

# Code Generation
Expand Down

0 comments on commit d75670d

Please sign in to comment.