{ "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": "ManagedServerSecurityAlertPolicies" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies": { "get": { "operationId": "ManagedServerSecurityAlertPolicies_ListByInstance", "tags": [ "ManagedServerSecurityAlertPolicies" ], "description": "Get the managed server's threat detection 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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ManagedServerSecurityAlertPolicyListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get the managed server's threat detection policies": { "$ref": "./examples/ManagedServerSecurityAlertListByInstance.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies/{securityAlertPolicyName}": { "get": { "operationId": "ManagedServerSecurityAlertPolicies_Get", "tags": [ "ManagedServerSecurityAlertPolicies" ], "description": "Get a managed server's threat detection 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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "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/ManagedServerSecurityAlertPolicy" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a managed server's threat detection policy": { "$ref": "./examples/ManagedServerSecurityAlertGet.json" } } }, "put": { "operationId": "ManagedServerSecurityAlertPolicies_CreateOrUpdate", "tags": [ "ManagedServerSecurityAlertPolicies" ], "description": "Creates or updates a threat detection 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": "managedInstanceName", "in": "path", "description": "The name of the managed instance.", "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 managed server security alert policy.", "required": true, "schema": { "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" } } ], "responses": { "200": { "description": "Resource 'ManagedServerSecurityAlertPolicy' update operation succeeded", "schema": { "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Update a managed server's threat detection policy with all parameters": { "$ref": "./examples/ManagedServerSecurityAlertCreateMax.json" }, "Update a managed server's threat detection policy with minimal parameters": { "$ref": "./examples/ManagedServerSecurityAlertCreateMin.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ManagedServerSecurityAlertPolicy" }, "x-ms-long-running-operation": true } } }, "definitions": { "ManagedServerSecurityAlertPolicy": { "type": "object", "description": "A managed server 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" } ] }, "ManagedServerSecurityAlertPolicyListResult": { "type": "object", "description": "The response of a ManagedServerSecurityAlertPolicy list operation.", "properties": { "value": { "type": "array", "description": "The ManagedServerSecurityAlertPolicy items on this page", "items": { "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] } }, "parameters": {} }