{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "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" } } }, "tags": [ { "name": "DatabaseSecurityAlertPolicies" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies": { "get": { "operationId": "DatabaseSecurityAlertPolicies_ListByDatabase", "tags": [ "DatabaseSecurityAlertPolicies" ], "description": "Gets a list of database's security alert policies.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DatabaseSecurityAlertListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the database's threat detection policies": { "$ref": "./examples/DatabaseSecurityAlertListByDatabase.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "operationId": "DatabaseSecurityAlertPolicies_Get", "tags": [ "DatabaseSecurityAlertPolicies" ], "description": "Gets a database's security alert policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "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, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/DatabaseSecurityAlertPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a database's threat detection policy": { "$ref": "./examples/DatabaseSecurityAlertGet.json" } } }, "put": { "operationId": "DatabaseSecurityAlertPolicies_CreateOrUpdate", "tags": [ "DatabaseSecurityAlertPolicies" ], "description": "Creates or updates a database's security alert policy.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "databaseName", "in": "path", "description": "The name of the database.", "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, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } }, { "name": "parameters", "in": "body", "description": "The database security alert policy.", "required": true, "schema": { "$ref": "#/definitions/DatabaseSecurityAlertPolicy" } } ], "responses": { "200": { "description": "Resource 'DatabaseSecurityAlertPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/DatabaseSecurityAlertPolicy" } }, "201": { "description": "Resource 'DatabaseSecurityAlertPolicy' create operation succeeded", "schema": { "$ref": "#/definitions/DatabaseSecurityAlertPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a database's threat detection policy with all parameters": { "$ref": "./examples/DatabaseSecurityAlertCreateMax.json" }, "Update a database's threat detection policy with minimal parameters": { "$ref": "./examples/DatabaseSecurityAlertCreateMin.json" } } } } }, "definitions": { "DatabaseSecurityAlertListResult": { "type": "object", "description": "A list of the database's security alert policies.", "properties": { "value": { "type": "array", "description": "Array of results.", "items": { "$ref": "#/definitions/DatabaseSecurityAlertPolicy" }, "readOnly": true }, "nextLink": { "type": "string", "description": "Link to retrieve next page of results.", "readOnly": true } } }, "DatabaseSecurityAlertPolicy": { "type": "object", "description": "A database security alert policy.", "properties": { "properties": { "$ref": "./common.json#/definitions/SecurityAlertsPolicyProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] } }, "parameters": {} }