{ "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": "ServerAdvancedThreatProtectionSettings" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings": { "get": { "operationId": "ServerAdvancedThreatProtectionSettings_ListByServer", "tags": [ "ServerAdvancedThreatProtectionSettings" ], "description": "Get a list of the server's Advanced Threat Protection states.", "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" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/LogicalServerAdvancedThreatProtectionListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List the server's Advanced Threat Protection settings.": { "$ref": "./examples/ServerAdvancedThreatProtectionSettingsListByServer.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/advancedThreatProtectionSettings/{advancedThreatProtectionName}": { "get": { "operationId": "ServerAdvancedThreatProtectionSettings_Get", "tags": [ "ServerAdvancedThreatProtectionSettings" ], "description": "Get a server's Advanced Threat Protection state.", "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": "advancedThreatProtectionName", "in": "path", "description": "The name of the Advanced Threat Protection state.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "AdvancedThreatProtectionName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/ServerAdvancedThreatProtection" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a server's Advanced Threat Protection settings": { "$ref": "./examples/ServerAdvancedThreatProtectionSettingsGet.json" } } }, "put": { "operationId": "ServerAdvancedThreatProtectionSettings_CreateOrUpdate", "tags": [ "ServerAdvancedThreatProtectionSettings" ], "description": "Creates or updates an Advanced Threat Protection state.", "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": "advancedThreatProtectionName", "in": "path", "description": "The name of the Advanced Threat Protection state.", "required": true, "type": "string", "enum": [ "Default" ], "x-ms-enum": { "name": "AdvancedThreatProtectionName", "modelAsString": true, "values": [ { "name": "Default", "value": "Default", "description": "Default" } ] } }, { "name": "parameters", "in": "body", "description": "The server Advanced Threat Protection state.", "required": true, "schema": { "$ref": "#/definitions/ServerAdvancedThreatProtection" } } ], "responses": { "200": { "description": "Resource 'ServerAdvancedThreatProtection' update operation succeeded", "schema": { "$ref": "#/definitions/ServerAdvancedThreatProtection" } }, "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 server's Advanced Threat Protection settings with all parameters.": { "$ref": "./examples/ServerAdvancedThreatProtectionSettingsCreateMax.json" }, "Update a server's Advanced Threat Protection settings with minimal parameters.": { "$ref": "./examples/ServerAdvancedThreatProtectionSettingsCreateMin.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/ServerAdvancedThreatProtection" }, "x-ms-long-running-operation": true } } }, "definitions": { "LogicalServerAdvancedThreatProtectionListResult": { "type": "object", "description": "A list of the server's Advanced Threat Protection configurations.", "properties": { "value": { "type": "array", "description": "Array of results.", "items": { "$ref": "#/definitions/ServerAdvancedThreatProtection" }, "readOnly": true }, "nextLink": { "type": "string", "description": "Link to retrieve next page of results.", "readOnly": true } } }, "ServerAdvancedThreatProtection": { "type": "object", "description": "A server Advanced Threat Protection.", "properties": { "properties": { "$ref": "./common.json#/definitions/AdvancedThreatProtectionProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] } }, "parameters": {} }