Share via

Managed Database Security Alert Policies - Get

  • Reference
Service:
SQL Database
API Version:
2021-11-01

Gets a managed database's security alert policy.

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

URI Parameters

Name In Required Type Description
databaseName
 path True

string

The name of the managed database for which the security alert policy is defined.
managedInstanceName
 path True

string

The name of the managed instance.
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.
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

ManagedDatabaseSecurityAlertPolicy

Successfully retrieved the managed database security alert policy.
Other Status Codes

*** Error Responses: ***

  • 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 UpdateNotAllowedOnServerContainingPausedDWDatabase - Setting server Threat Detection settings is not allowed on a server with a paused Data Warehouse database

  • 400 SecurityAlertPoliciesInsufficientDiskSpace - Insufficient disk space to save security alert policy metadata in the 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 InvalidServerSecurityAlertPolicyCreateRequest - The create server 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 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later

  • 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later

  • 404 SubscriptionDoesNotHaveServer - The requested server was not found

  • 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later

  • 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress

  • 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later

  • 500 DatabaseIsUnavailable - Loading failed. Please try again later.

  • 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later

  • 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings

Examples

Get a database's threat detection policy

Sample request

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

Sample response

Status code:
200 
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/managedInstances/securityalert-2080/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "disabledAlerts": [
      "Usage_Anomaly"
    ],
    "retentionDays": 0,
    "storageAccountAccessKey": "",
    "storageEndpoint": ""
  }
}

Definitions

Name Description
ManagedDatabaseSecurityAlertPolicy

A managed database security alert policy.
SecurityAlertPolicyName

The name of the security alert policy.
SecurityAlertPolicyState

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

ManagedDatabaseSecurityAlertPolicy

A managed 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

SecurityAlertPolicyState

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.
type

string

Resource type.

SecurityAlertPolicyName

The name of the security alert policy.

Name Type Description
default

string

SecurityAlertPolicyState

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

New

string