Database Security Alert Policies - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

Crée ou met à jour la stratégie d’alerte de sécurité d’une base de données.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
databaseName	path	True	string	Nom de la base de données pour laquelle la stratégie d’alerte de sécurité est définie.
resourceGroupName	path	True	string	Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
securityAlertPolicyName	path	True	SecurityAlertPolicyName	Nom de la stratégie d’alerte de sécurité.
serverName	path	True	string	Le nom du serveur
subscriptionId	path	True	string	L’ID d’abonnement d’un abonnement Azure.
api-version	query	True	string	Version de l’API à utiliser pour la requête.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.state	True	SecurityAlertsPolicyState	Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur la base de données spécifique.
properties.disabledAlerts		string[]	Spécifie un tableau d’alertes désactivées. Les valeurs autorisées sont : Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
properties.emailAccountAdmins		boolean	Spécifie que l’alerte est envoyée aux administrateurs de compte.
properties.emailAddresses		string[]	Spécifie un tableau d’adresses de messagerie auxquelles l’alerte est envoyée.
properties.retentionDays		integer	Spécifie le nombre de jours à conserver dans les journaux d’audit de détection des menaces.
properties.storageAccountAccessKey		string	Spécifie la clé d’identificateur du compte de stockage d’audit de détection des menaces.
properties.storageEndpoint		string	Spécifie le point de terminaison de stockage d’objets blob (par exemple https://MyAccount.blob.core.windows.net). Ce stockage d’objets blob contiendra tous les journaux d’audit de détection des menaces.

Réponses

Nom	Type	Description
200 OK	DatabaseSecurityAlertPolicy	Définissez correctement la stratégie d’alerte de sécurité de la base de données.
201 Created	DatabaseSecurityAlertPolicy	La stratégie d’alerte de sécurité de la base de données a été créée.
Other Status Codes		Réponses d’erreur : *** 400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause. 400 SecurityAlertPoliciesInsufficientStorageAccountPermissions : autorisations de lecture ou d’écriture insuffisantes sur le compte de stockage fourni. 400 SecurityAlertPoliciesStorageAccountIsDisabled : le compte de stockage fourni dans la stratégie de détection des menaces est désactivé. 400 SecurityAlertPoliciesInsufficientDiskSpace : espace disque insuffisant pour enregistrer les métadonnées de stratégie d’alerte de sécurité dans la base de données 400 SecurityAlertPoliciesInvalidStorageAccountName : le compte de stockage fourni n’est pas valide ou n’existe pas. 400 SecurityAlertPoliciesInvalidStorageAccountCredentials : la clé d’accès au compte de stockage fournie n’est pas valide. 400 InvalidDatabaseSecurityAlertPolicyCreateRequest : la demande de stratégie d’alerte de sécurité de la détection des menaces de la base de données de création n’existe pas ou n’a pas d’objet de propriétés. 400 DataSecurityInvalidUserSuppliedParameter : une valeur de paramètre non valide a été fournie par le client. 400 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 400 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance. 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 409 DatabaseSecurityAlertPolicyInProgress - Définir la stratégie d’alerte de sécurité de base de données est déjà en cours 409 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 500 DatabaseIsUnavailable - Échec du chargement. Veuillez réessayer plus tard. 500 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 500 GetDatabaseSecurityAlertPolicyFailed - Échec de l’obtention des paramètres de détection des menaces

Nom

Type

Description

200 OK

DatabaseSecurityAlertPolicy

Définissez correctement la stratégie d’alerte de sécurité de la base de données.

201 Created

DatabaseSecurityAlertPolicy

La stratégie d’alerte de sécurité de la base de données a été créée.

Other Status Codes

Réponses d’erreur : ***

400 UpdateNotAllowedOnPausedDatabase : l’utilisateur a tenté d’effectuer une mise à jour sur une base de données en pause.
400 SecurityAlertPoliciesInsufficientStorageAccountPermissions : autorisations de lecture ou d’écriture insuffisantes sur le compte de stockage fourni.
400 SecurityAlertPoliciesStorageAccountIsDisabled : le compte de stockage fourni dans la stratégie de détection des menaces est désactivé.
400 SecurityAlertPoliciesInsufficientDiskSpace : espace disque insuffisant pour enregistrer les métadonnées de stratégie d’alerte de sécurité dans la base de données
400 SecurityAlertPoliciesInvalidStorageAccountName : le compte de stockage fourni n’est pas valide ou n’existe pas.
400 SecurityAlertPoliciesInvalidStorageAccountCredentials : la clé d’accès au compte de stockage fournie n’est pas valide.
400 InvalidDatabaseSecurityAlertPolicyCreateRequest : la demande de stratégie d’alerte de sécurité de la détection des menaces de la base de données de création n’existe pas ou n’a pas d’objet de propriétés.
400 DataSecurityInvalidUserSuppliedParameter : une valeur de paramètre non valide a été fournie par le client.
400 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
400 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
404 DatabaseDoesNotExist : l’utilisateur a spécifié un nom de base de données qui n’existe pas sur ce serveur instance.
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement
409 DatabaseSecurityAlertPolicyInProgress - Définir la stratégie d’alerte de sécurité de base de données est déjà en cours
409 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement
500 DatabaseIsUnavailable - Échec du chargement. Veuillez réessayer plus tard.
500 UpsertDatabaseSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement
500 GetDatabaseSecurityAlertPolicyFailed - Échec de l’obtention des paramètres de détection des menaces

Exemples

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": ""
  }
}

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
DatabaseSecurityAlertPolicy	Une stratégie d’alerte de sécurité de base de données.
SecurityAlertPolicyName	Nom de la stratégie d’alerte de sécurité.
SecurityAlertsPolicyState	Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur la base de données spécifique.
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DatabaseSecurityAlertPolicy

Une stratégie d’alerte de sécurité de base de données.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource.
properties.creationTime	string	Spécifie l’heure de création UTC de la stratégie.
properties.disabledAlerts	string[]	Spécifie un tableau d’alertes désactivées. Les valeurs autorisées sont : Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly, Data_Exfiltration, Unsafe_Action, Brute_Force
properties.emailAccountAdmins	boolean	Spécifie que l’alerte est envoyée aux administrateurs de compte.
properties.emailAddresses	string[]	Spécifie un tableau d’adresses de messagerie auxquelles l’alerte est envoyée.
properties.retentionDays	integer	Spécifie le nombre de jours à conserver dans les journaux d’audit de détection des menaces.
properties.state	SecurityAlertsPolicyState	Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur la base de données spécifique.
properties.storageAccountAccessKey	string	Spécifie la clé d’identificateur du compte de stockage d’audit de détection des menaces.
properties.storageEndpoint	string	Spécifie le point de terminaison de stockage d’objets blob (par exemple https://MyAccount.blob.core.windows.net). Ce stockage d’objets blob contiendra tous les journaux d’audit de détection des menaces.
systemData	systemData	SystemData of SecurityAlertPolicyResource.
type	string	Type de ressource.

SecurityAlertPolicyName

Nom de la stratégie d’alerte de sécurité.

Nom	Type	Description
default	string

SecurityAlertsPolicyState

Spécifie l’état de la stratégie, si elle est activée ou désactivée ou si une stratégie n’a pas encore été appliquée sur la base de données spécifique.

Nom	Type	Description
Disabled	string
Enabled	string

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType	createdByType	Type d’identité qui a modifié la ressource pour la dernière fois.

Database Security Alert Policies - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

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

Définitions

createdByType

DatabaseSecurityAlertPolicy

SecurityAlertPolicyName

SecurityAlertsPolicyState

systemData

Ressources supplémentaires