Database Security Alert Policies - Create Or Update

Referencia

Service:: SQL Database

API Version:: 2021-11-01

Crea o actualiza la directiva de alertas de seguridad de una base de datos.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
databaseName	path	True	string	Nombre de la base de datos para la que se define la directiva de alertas de seguridad.
resourceGroupName	path	True	string	Nombre del grupo de recursos que contiene el recurso. Puede obtener este valor en la API del Administrador de recursos o el portal de Azure.
securityAlertPolicyName	path	True	SecurityAlertPolicyName	Nombre de la directiva de alertas de seguridad.
serverName	path	True	string	El nombre del servidor.
subscriptionId	path	True	string	El id. de suscripción que identifica una suscripción de Azure.
api-version	query	True	string	La versión de API que se usará para la solicitud.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.state	True	SecurityAlertsPolicyState	Especifica el estado de la directiva, tanto si está habilitado como deshabilitado o si aún no se ha aplicado una directiva en la base de datos específica.
properties.disabledAlerts		string[]	Especifica una matriz de alertas que están deshabilitadas. Los valores permitidos son: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
properties.emailAccountAdmins		boolean	Especifica que la alerta se envía a los administradores de la cuenta.
properties.emailAddresses		string[]	Especifica una matriz de direcciones de correo electrónico a las que se envía la alerta.
properties.retentionDays		integer	Especifica el número de días que se mantendrán en los registros de auditoría de detección de amenazas.
properties.storageAccountAccessKey		string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría de detección de amenazas.
properties.storageEndpoint		string	Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Este almacenamiento de blobs contendrá todos los registros de auditoría de detección de amenazas.

Respuestas

Nombre	Tipo	Description
200 OK	DatabaseSecurityAlertPolicy	Establezca correctamente la directiva de alertas de seguridad de la base de datos.
201 Created	DatabaseSecurityAlertPolicy	Se creó correctamente la directiva de alertas de seguridad de la base de datos.
Other Status Codes		Respuestas de error: *** 400 UpdateNotAllowedOnPausedDatabase: el usuario intentó realizar una actualización en una base de datos en pausa. 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions: permisos de lectura o escritura insuficientes en la cuenta de almacenamiento proporcionada. 400 SecurityAlertPoliciesStorageAccountIsDisabled: la cuenta de almacenamiento proporcionada en la directiva de detección de amenazas está deshabilitada. 400 SecurityAlertPoliciesInsufficientDiskSpace: espacio en disco insuficiente para ahorrar metadatos de directiva de alertas de seguridad en la base de datos 400 SecurityAlertPoliciesInvalidStorageAccountName: la cuenta de almacenamiento proporcionada no es válida o no existe. 400 SecurityAlertPoliciesInvalidStorageAccountCredentials: la clave de acceso de la cuenta de almacenamiento proporcionada no es válida. 400 InvalidDatabaseSecurityAlertPolicyCreateRequest: la solicitud de directiva de alerta de seguridad create database Threat Detection no existe o no tiene ningún objeto de propiedades. 400 DataSecurityInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido. 400 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde. 400 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde. 404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor. 404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado 404 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde. 409 DatabaseSecurityAlertPolicyInProgress: el establecimiento de la directiva de alertas de seguridad de la base de datos ya está en curso 409 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde. 500 DatabaseIsUnavailable: error al cargar. Vuelva a intentarlo más tarde. 500 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde. 500 GetDatabaseSecurityAlertPolicyFailed: no se pudo obtener la configuración de detección de amenazas

Nombre

Tipo

Description

200 OK

DatabaseSecurityAlertPolicy

Establezca correctamente la directiva de alertas de seguridad de la base de datos.

201 Created

DatabaseSecurityAlertPolicy

Se creó correctamente la directiva de alertas de seguridad de la base de datos.

Other Status Codes

Respuestas de error: ***

400 UpdateNotAllowedOnPausedDatabase: el usuario intentó realizar una actualización en una base de datos en pausa.
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions: permisos de lectura o escritura insuficientes en la cuenta de almacenamiento proporcionada.
400 SecurityAlertPoliciesStorageAccountIsDisabled: la cuenta de almacenamiento proporcionada en la directiva de detección de amenazas está deshabilitada.
400 SecurityAlertPoliciesInsufficientDiskSpace: espacio en disco insuficiente para ahorrar metadatos de directiva de alertas de seguridad en la base de datos
400 SecurityAlertPoliciesInvalidStorageAccountName: la cuenta de almacenamiento proporcionada no es válida o no existe.
400 SecurityAlertPoliciesInvalidStorageAccountCredentials: la clave de acceso de la cuenta de almacenamiento proporcionada no es válida.
400 InvalidDatabaseSecurityAlertPolicyCreateRequest: la solicitud de directiva de alerta de seguridad create database Threat Detection no existe o no tiene ningún objeto de propiedades.
400 DataSecurityInvalidUserSuppliedParameter: el cliente proporcionó un valor de parámetro no válido.
400 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde.
400 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde.
404 DatabaseDoesNotExist: el usuario ha especificado un nombre de base de datos que no existe en esta instancia del servidor.
404 SubscriptionDoesNotHaveServer: no se encontró el servidor solicitado
404 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde.
409 DatabaseSecurityAlertPolicyInProgress: el establecimiento de la directiva de alertas de seguridad de la base de datos ya está en curso
409 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde.
500 DatabaseIsUnavailable: error al cargar. Vuelva a intentarlo más tarde.
500 UpsertDatabaseSecurityAlertPolicyFailed: error al guardar la configuración de detección de amenazas, inténtelo de nuevo más tarde.
500 GetDatabaseSecurityAlertPolicyFailed: no se pudo obtener la configuración de detección de amenazas

Ejemplos

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/servers/securityalert-6440/databases/testdb/securityAlertPolicies/default?api-version=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.DatabaseSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyName;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;
import java.util.Arrays;

/** Samples for DatabaseSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseSecurityAlertCreateMax.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().getDatabaseSecurityAlertPolicies().createOrUpdateWithResponse(
            "securityalert-4799", "securityalert-6440", "testdb", SecurityAlertPolicyName.DEFAULT,
            new DatabaseSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED)
                .withDisabledAlerts(Arrays.asList("Sql_Injection", "Usage_Anomaly"))
                .withEmailAddresses(Arrays.asList("test@microsoft.com", "user@microsoft.com"))
                .withEmailAccountAdmins(true).withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withRetentionDays(6),
            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/servers/securityalert-6440/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@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Sql_Injection",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/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@microsoft.com",
      "user@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 6,
    "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/servers/securityalert-6440/databases/testdb/securityAlertPolicies/default?api-version=2021-11-01

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


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

/** Samples for DatabaseSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/DatabaseSecurityAlertCreateMin.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().getDatabaseSecurityAlertPolicies().createOrUpdateWithResponse(
            "securityalert-4799", "securityalert-6440", "testdb", SecurityAlertPolicyName.DEFAULT,
            new DatabaseSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED), 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/servers/securityalert-6440/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": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageEndpoint": ""
  }
}

Status code:: 201

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/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": [],
    "disabledAlerts": [],
    "retentionDays": 0,
    "storageEndpoint": ""
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
DatabaseSecurityAlertPolicy	Una directiva de alertas de seguridad de base de datos.
SecurityAlertPolicyName	Nombre de la directiva de alertas de seguridad.
SecurityAlertsPolicyState	Especifica el estado de la directiva, tanto si está habilitado como deshabilitado o si aún no se ha aplicado una directiva en la base de datos específica.
systemData	Metadatos relacionados con la creación y la última modificación del recurso.

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseSecurityAlertPolicy

Una directiva de alertas de seguridad de base de datos.

Nombre	Tipo	Description
id	string	Identificador del recurso.
name	string	Nombre del recurso.
properties.creationTime	string	Especifica la hora de creación UTC de la directiva.
properties.disabledAlerts	string[]	Especifica una matriz de alertas que están deshabilitadas. Los valores permitidos son: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
properties.emailAccountAdmins	boolean	Especifica que la alerta se envía a los administradores de la cuenta.
properties.emailAddresses	string[]	Especifica una matriz de direcciones de correo electrónico a las que se envía la alerta.
properties.retentionDays	integer	Especifica el número de días que se mantendrán en los registros de auditoría de detección de amenazas.
properties.state	SecurityAlertsPolicyState	Especifica el estado de la directiva, tanto si está habilitado como deshabilitado o si aún no se ha aplicado una directiva en la base de datos específica.
properties.storageAccountAccessKey	string	Especifica la clave de identificador de la cuenta de almacenamiento de auditoría de detección de amenazas.
properties.storageEndpoint	string	Especifica el punto de conexión de Blob Storage (por ejemplo, https://MyAccount.blob.core.windows.net). Este almacenamiento de blobs contendrá todos los registros de auditoría de detección de amenazas.
systemData	systemData	SystemData de SecurityAlertPolicyResource.
type	string	Tipo de recurso.

SecurityAlertPolicyName

Nombre de la directiva de alertas de seguridad.

Nombre	Tipo	Description
default	string

SecurityAlertsPolicyState

Especifica el estado de la directiva, tanto si está habilitado como deshabilitado o si aún no se ha aplicado una directiva en la base de datos específica.

Nombre	Tipo	Description
Disabled	string
Enabled	string

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

Database Security Alert Policies - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Ejemplos

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

Definiciones

createdByType

DatabaseSecurityAlertPolicy

SecurityAlertPolicyName

SecurityAlertsPolicyState

systemData

Recursos adicionales