Database Security Alert Policies - Get

Reference

Service:: SQL Database

API Version:: 2021-11-01

Gets a database's security alert policy.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/default?api-version=2021-11-01

URI Parameters

Name	In	Required	Type	Description
databaseName	path	True	string	The name of the database for which the security alert policy is defined.
resourceGroupName	path	True	string	The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
securityAlertPolicyName	path	True	SecurityAlertPolicyName	The name of the security alert policy.
serverName	path	True	string	The name of the server.
subscriptionId	path	True	string	The subscription ID that identifies an Azure subscription.
api-version	query	True	string	The API version to use for the request.

Responses

Name	Type	Description
200 OK	DatabaseSecurityAlertPolicy	Successfully retrieved the database security alert policy.
Other Status Codes		* Error Responses: * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database. 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account. 400 SecurityAlertPoliciesStorageAccountIsDisabled - The storage account provided in the threat detection policy is disabled. 400 SecurityAlertPoliciesInsufficientDiskSpace - Insufficient disk space to save security alert policy metadata in the database 400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist. 400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid. 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object. 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client. 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance. 404 SubscriptionDoesNotHaveServer - The requested server was not found 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later 500 DatabaseIsUnavailable - Loading failed. Please try again later. 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings

Name

Type

Description

200 OK

DatabaseSecurityAlertPolicy

Successfully retrieved the database security alert policy.

Other Status Codes

*** Error Responses: ***

400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions - Insufficient read or write permissions on the provided storage account.
400 SecurityAlertPoliciesStorageAccountIsDisabled - The storage account provided in the threat detection policy is disabled.
400 SecurityAlertPoliciesInsufficientDiskSpace - Insufficient disk space to save security alert policy metadata in the database
400 SecurityAlertPoliciesInvalidStorageAccountName - The provided storage account is not valid or does not exist.
400 SecurityAlertPoliciesInvalidStorageAccountCredentials - The provided storage account access key is not valid.
400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.
400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.
400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later
400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later
404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.
404 SubscriptionDoesNotHaveServer - The requested server was not found
404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later
409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress
409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later
500 DatabaseIsUnavailable - Loading failed. Please try again later.
500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later
500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings

Examples

Get a database's threat detection policy

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/servers/securityalert-2080/databases/testdb/securityAlertPolicies/default?api-version=2021-11-01


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyName;

/** Samples for DatabaseSecurityAlertPolicies Get. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseSecurityAlertGet.json
     */
    /**
     * Sample code: Get a database's threat detection policy.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getADatabaseSThreatDetectionPolicy(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getDatabaseSecurityAlertPolicies().getWithResponse(
            "securityalert-6852", "securityalert-2080", "testdb", SecurityAlertPolicyName.DEFAULT, Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/servers/securityalert-2080/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/servers/databases/securityAlertPolicies",
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2020-04-03T04:41:33.937Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-04-03T04:41:33.937Z"
  },
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "test@consoto.com",
      "user@consoto.com"
    ],
    "disabledAlerts": [
      "Usage_Anomaly"
    ],
    "retentionDays": 0,
    "creationTime": "2020-04-03T04:41:33.937Z"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DatabaseSecurityAlertPolicy	A database security alert policy.
SecurityAlertPolicyName	The name of the security alert policy.
SecurityAlertsPolicyState	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
systemData	Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseSecurityAlertPolicy

A database security alert policy.

Name	Type	Description
id	string	Resource ID.
name	string	Resource name.
properties.creationTime	string	Specifies the UTC creation time of the policy.
properties.disabledAlerts	string[]	Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
properties.emailAccountAdmins	boolean	Specifies that the alert is sent to the account administrators.
properties.emailAddresses	string[]	Specifies an array of e-mail addresses to which the alert is sent.
properties.retentionDays	integer	Specifies the number of days to keep in the Threat Detection audit logs.
properties.state	SecurityAlertsPolicyState	Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.
properties.storageAccountAccessKey	string	Specifies the identifier key of the Threat Detection audit storage account.
properties.storageEndpoint	string	Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
systemData	systemData	SystemData of SecurityAlertPolicyResource.
type	string	Resource type.

SecurityAlertPolicyName

The name of the security alert policy.

Name	Type	Description
default	string

SecurityAlertsPolicyState

Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.

Name	Type	Description
Disabled	string
Enabled	string

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

Database Security Alert Policies - Get

URI Parameters

Responses

Examples

Get a database's threat detection policy

Sample Request

Sample Response

Definitions

createdByType

DatabaseSecurityAlertPolicy

SecurityAlertPolicyName

SecurityAlertsPolicyState

systemData

Additional resources