Managed Database Security Alert Policies - Create Or Update

Reference

Service:: SQL Database

API Version:: 2021-11-01

Creates or updates a database's security alert policy.

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

Request Body

Name	Required	Type	Description
properties.state	True	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.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.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.

Responses

Name	Type	Description
200 OK	ManagedDatabaseSecurityAlertPolicy	Successfully set the managed database security alert policy.
201 Created	ManagedDatabaseSecurityAlertPolicy	Successfully created the managed database security alert policy.
Other Status Codes		* Error Responses: *

Examples

Update a database's threat detection policy with all parameters

Update a database's threat detection policy with minimal parameters

Update a database's threat detection policy with all parameters

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

{
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}


import com.azure.resourcemanager.sql.fluent.models.ManagedDatabaseSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyName;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;
import java.util.Arrays;

/**
 * Samples for ManagedDatabaseSecurityAlertPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedDatabaseSecurityAlertCreateMax
     * .json
     */
    /**
     * Sample code: Update a database's threat detection policy with all parameters.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void
        updateADatabaseSThreatDetectionPolicyWithAllParameters(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseSecurityAlertPolicies()
            .createOrUpdateWithResponse("securityalert-4799", "securityalert-6440", "testdb",
                SecurityAlertPolicyName.DEFAULT,
                new ManagedDatabaseSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED)
                    .withDisabledAlerts(Arrays.asList("Sql_Injection", "Usage_Anomaly"))
                    .withEmailAddresses(Arrays.asList("[email protected]", "[email protected]"))
                    .withEmailAccountAdmins(true).withStorageEndpoint("https://mystorage.blob.core.windows.net")
                    .withStorageAccountAccessKey("fakeTokenPlaceholder").withRetentionDays(6),
                com.azure.core.util.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-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/managedInstances/databases/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [
      "[email protected]",
      "[email protected]"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageAccountAccessKey": "sdlfkjabc+sdlfkjsdlkfsjdfLDKFTERLKFDFKLjsdfksjdflsdkfD2342309432849328476458/3RSD==",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Update a database's threat detection policy with minimal parameters

Sample request

HTTP
Java

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

{
  "properties": {
    "state": "Enabled"
  }
}


import com.azure.resourcemanager.sql.fluent.models.ManagedDatabaseSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyName;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;

/**
 * Samples for ManagedDatabaseSecurityAlertPolicies CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedDatabaseSecurityAlertCreateMin
     * .json
     */
    /**
     * Sample code: Update a database's threat detection policy with minimal parameters.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateADatabaseSThreatDetectionPolicyWithMinimalParameters(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedDatabaseSecurityAlertPolicies()
            .createOrUpdateWithResponse("securityalert-4799", "securityalert-6440", "testdb",
                SecurityAlertPolicyName.DEFAULT,
                new ManagedDatabaseSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED),
                com.azure.core.util.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-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/managedInstance/databases/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageAccountAccessKey": "",
    "storageEndpoint": ""
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440/databases/testdb",
  "name": "default",
  "type": "Microsoft.Sql/managedInstance/databases/securityAlertPolicies",
  "properties": {
    "state": "Enabled",
    "emailAccountAdmins": true,
    "emailAddresses": [],
    "disabledAlerts": [],
    "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

Share via

Managed Database Security Alert Policies - Create Or Update

URI Parameters

Request Body

Responses

Examples

Update a database's threat detection policy with all parameters

Sample request

Sample response

Update a database's threat detection policy with minimal parameters

Sample request

Sample response

Definitions

ManagedDatabaseSecurityAlertPolicy

SecurityAlertPolicyName

SecurityAlertPolicyState

Additional resources