Add ManagedServerSecurityAlertPolicy and ManagedDatabaseSecurityAlert… #4521
There are no files selected for viewing
This file contains 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,337 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "version": "2017-03-01-preview", | ||
| "title": "SqlManagementClient", | ||
| "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." | ||
| }, | ||
| "host": "management.azure.com", | ||
| "schemes": [ | ||
| "https" | ||
| ], | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "paths": { | ||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}": { | ||
|
There was a problem hiding this comment. LIST api to get all securityAlertPolicies for a database missing. There was a problem hiding this comment. We will open a work item for this |
||
| "get": { | ||
| "tags": [ | ||
| "ManagedDatabaseSecurityAlertPolicies" | ||
| ], | ||
| "description": "Gets a managed database's security alert policy.", | ||
| "operationId": "ManagedDatabaseSecurityAlertPolicies_Get", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ResourceGroupParameter" | ||
| }, | ||
| { | ||
| "name": "managedInstanceName", | ||
| "in": "path", | ||
| "description": "The name of the managed instance.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "description": "The name of the managed database for which the security alert policy is defined.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "name": "securityAlertPolicyName", | ||
| "in": "path", | ||
| "description": "The name of the security alert policy.", | ||
| "required": true, | ||
| "type": "string", | ||
| "enum": [ | ||
| "default" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "SecurityAlertPolicyName", | ||
| "modelAsString": true | ||
| } | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successfully retrieved the managed database security alert policy.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "*** Error Responses: ***\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.\n\n * 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Get a database's threat detection policy": { | ||
| "$ref": "./examples/ManagedDatabaseSecurityAlertGet.json" | ||
| } | ||
| } | ||
| }, | ||
| "put": { | ||
| "tags": [ | ||
| "ManagedDatabaseSecurityAlertPolicies" | ||
| ], | ||
| "description": "Creates or updates a database's security alert policy.", | ||
| "operationId": "ManagedDatabaseSecurityAlertPolicies_CreateOrUpdate", | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/parameters/ResourceGroupParameter" | ||
| }, | ||
| { | ||
| "name": "managedInstanceName", | ||
| "in": "path", | ||
| "description": "The name of the managed instance.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "description": "The name of the managed database for which the security alert policy is defined.", | ||
| "required": true, | ||
| "type": "string" | ||
| }, | ||
| { | ||
| "name": "securityAlertPolicyName", | ||
| "in": "path", | ||
| "description": "The name of the security alert policy.", | ||
| "required": true, | ||
| "type": "string", | ||
| "enum": [ | ||
| "default" | ||
| ], | ||
| "x-ms-enum": { | ||
| "name": "SecurityAlertPolicyName", | ||
| "modelAsString": true | ||
| } | ||
| }, | ||
| { | ||
| "name": "parameters", | ||
| "in": "body", | ||
| "description": "The database security alert policy.", | ||
| "required": true, | ||
| "schema": { | ||
| "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" | ||
| } | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/SubscriptionIdParameter" | ||
| }, | ||
| { | ||
| "$ref": "#/parameters/ApiVersionParameter" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "200": { | ||
| "description": "Successfully set the managed database security alert policy.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" | ||
| } | ||
| }, | ||
| "default": { | ||
| "description": "*** Error Responses: ***" | ||
| }, | ||
| "201": { | ||
| "description": "Successfully created the managed database security alert policy.", | ||
| "schema": { | ||
| "$ref": "#/definitions/ManagedDatabaseSecurityAlertPolicy" | ||
| } | ||
| } | ||
| }, | ||
| "x-ms-examples": { | ||
| "Update a database's threat detection policy with minimal parameters": { | ||
| "$ref": "./examples/ManagedDatabaseSecurityAlertCreateMin.json" | ||
| }, | ||
| "Update a database's threat detection policy with all parameters": { | ||
| "$ref": "./examples/ManagedDatabaseSecurityAlertCreateMax.json" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "SecurityAlertPolicyProperties": { | ||
| "description": "Properties of a security alert policy.", | ||
| "required": [ | ||
| "state" | ||
| ], | ||
| "type": "object", | ||
| "properties": { | ||
| "state": { | ||
| "description": "Specifies the state of the policy, whether it is enabled or disabled.", | ||
| "enum": [ | ||
| "New", | ||
| "Enabled", | ||
| "Disabled" | ||
| ], | ||
| "type": "string", | ||
| "x-ms-enum": { | ||
| "name": "SecurityAlertPolicyState", | ||
| "modelAsString": false | ||
| } | ||
| }, | ||
| "disabledAlerts": { | ||
| "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "emailAddresses": { | ||
| "description": "Specifies an array of e-mail addresses to which the alert is sent.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "emailAccountAdmins": { | ||
| "description": "Specifies that the alert is sent to the account administrators.", | ||
| "type": "boolean" | ||
| }, | ||
| "storageEndpoint": { | ||
| "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", | ||
| "type": "string" | ||
| }, | ||
| "storageAccountAccessKey": { | ||
|
There was a problem hiding this comment. should not be returned in the response of a Get or PUT. A better model may be to fetch it on behalf of the user using s2S auth. There was a problem hiding this comment. We will open a work item for this |
||
| "description": "Specifies the identifier key of the Threat Detection audit storage account.", | ||
| "type": "string" | ||
| }, | ||
| "retentionDays": { | ||
| "format": "int32", | ||
| "description": "Specifies the number of days to keep in the Threat Detection audit logs.", | ||
| "type": "integer" | ||
| }, | ||
| "creationTime": { | ||
| "format": "date-time", | ||
| "description": "Specifies the UTC creation time of the policy.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| } | ||
| } | ||
| }, | ||
| "ManagedDatabaseSecurityAlertPolicy": { | ||
| "description": "A managed database security alert policy.", | ||
| "type": "object", | ||
| "allOf": [ | ||
| { | ||
| "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" | ||
| } | ||
| ], | ||
| "properties": { | ||
| "properties": { | ||
| "$ref": "#/definitions/SecurityAlertPolicyProperties", | ||
| "description": "Resource properties.", | ||
| "x-ms-client-flatten": true | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "parameters": { | ||
| "SubscriptionIdParameter": { | ||
| "name": "subscriptionId", | ||
| "in": "path", | ||
| "description": "The subscription ID that identifies an Azure subscription.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "client" | ||
| }, | ||
| "ApiVersionParameter": { | ||
| "name": "api-version", | ||
| "in": "query", | ||
| "description": "The API version to use for the request.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "client" | ||
| }, | ||
| "ResourceGroupParameter": { | ||
| "name": "resourceGroupName", | ||
| "in": "path", | ||
| "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "ServerNameParameter": { | ||
| "name": "serverName", | ||
| "in": "path", | ||
| "description": "The name of the server.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "ManagedInstanceNameParameter": { | ||
| "name": "managedInstanceName", | ||
| "in": "path", | ||
| "description": "The name of the managed instance.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "DatabaseNameParameter": { | ||
| "name": "databaseName", | ||
| "in": "path", | ||
| "description": "The name of the database.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "BlobAuditingPolicyNameParameter": { | ||
| "name": "blobAuditingPolicyName", | ||
| "in": "path", | ||
| "description": "The name of the blob auditing policy.", | ||
| "required": true, | ||
| "type": "string", | ||
| "enum": [ | ||
| "default" | ||
| ], | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "SqlVirtualMachineInstanceNameParameter": { | ||
| "name": "sqlVirtualMachineInstanceName", | ||
| "in": "path", | ||
| "description": "The name of the SqlVirtualMachineInstance.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "SqlVirtualMachineContainerNameParameter": { | ||
| "name": "sqlVirtualMachineContainerName", | ||
| "in": "path", | ||
| "description": "The name of the SqlVirtualMachineContainer.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| }, | ||
| "VirtualClusterNameParameter": { | ||
| "name": "virtualClusterName", | ||
| "in": "path", | ||
| "description": "The name of the virtual cluster.", | ||
| "required": true, | ||
| "type": "string", | ||
| "x-ms-parameter-location": "method" | ||
| } | ||
| }, | ||
| "securityDefinitions": { | ||
| "azure_auth": { | ||
| "type": "oauth2", | ||
| "description": "Azure Active Directory OAuth2 Flow", | ||
| "flow": "implicit", | ||
| "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", | ||
| "scopes": { | ||
| "user_impersonation": "impersonate your user account" | ||
| } | ||
| } | ||
| } | ||
| } | ||
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.
Also, it may be helpful to have a PATCH APi for this. For example to update the state of a policy, doing a PUT may be an overkill. PATCH will be much more convenient.
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.
After thinking about it we don't think that a patch is needed in our customer scenarios