Managed Server Security Alert Policies - Create Or Update

Référence

Service:: SQL Database

API Version:: 2021-11-01

Crée ou met à jour une stratégie de détection des menaces.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
managedInstanceName	path	True	string	Nom de l'instance managée.
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é.
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	ManagedServerSecurityAlertPolicy	Mise à jour réussie de la stratégie de détection des menaces.
202 Accepted		Demande créée pour définir la stratégie de détection des menaces du serveur.
Other Status Codes		Réponses d’erreur : *** 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 UpdateNotAllowedOnServerContainingPausedDWDatabase : la définition des paramètres de détection des menaces du serveur n’est pas autorisée sur un serveur avec une base de données Data Warehouse en pause 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 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 InvalidServerSecurityAlertPolicyCreateRequest : la demande de stratégie d’alerte de sécurité de la détection des menaces de serveur 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 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 400 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable 404 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 404 OperationIdNotFound : l’opération avec ID n’existe pas. 409 ServerSecurityAlertPolicyInProgress - Définir la stratégie d’alerte de sécurité du serveur est déjà en cours 409 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement 409 OperationCancelled : l’opération a été annulée par l’utilisateur. 409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource. 429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles. 500 DatabaseIsUnavailable - Échec du chargement. Veuillez réessayer plus tard. 500 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 500 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard 500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération. 503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Nom

Type

Description

200 OK

ManagedServerSecurityAlertPolicy

Mise à jour réussie de la stratégie de détection des menaces.

202 Accepted

Demande créée pour définir la stratégie de détection des menaces du serveur.

Other Status Codes

Réponses d’erreur : ***

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 UpdateNotAllowedOnServerContainingPausedDWDatabase : la définition des paramètres de détection des menaces du serveur n’est pas autorisée sur un serveur avec une base de données Data Warehouse en pause
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 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 InvalidServerSecurityAlertPolicyCreateRequest : la demande de stratégie d’alerte de sécurité de la détection des menaces de serveur 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 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
400 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
404 SubscriptionDoesNotHaveServer : le serveur demandé est introuvable
404 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement
404 OperationIdNotFound : l’opération avec ID n’existe pas.
409 ServerSecurityAlertPolicyInProgress - Définir la stratégie d’alerte de sécurité du serveur est déjà en cours
409 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez ultérieurement
409 OperationCancelled : l’opération a été annulée par l’utilisateur.
409 Opération interrompue : l’opération sur la ressource n’a pas pu être terminée, car elle a été interrompue par une autre opération sur la même ressource.
429 SubscriptionTooManyCreateUpdateRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
429 SubscriptionTooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.
500 DatabaseIsUnavailable - Échec du chargement. Veuillez réessayer plus tard.
500 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
500 UpsertServerSecurityAlertPolicyFailed : une erreur s’est produite lors de l’enregistrement des paramètres de détection des menaces. Réessayez plus tard
500 OperationTimedOut : l’opération a expiré et a été automatiquement restaurée. Réessayez l’opération.
503 TooManyRequests : demandes au-delà du nombre maximal de demandes pouvant être traitées par les ressources disponibles.

Exemples

Update a managed server's threat detection policy with all parameters

Update a managed server's threat detection policy with minimal parameters

Update a managed server'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/securityAlertPolicies/Default?api-version=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ManagedServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;
import java.util.Arrays;

/** Samples for ManagedServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedServerSecurityAlertCreateMax.
     * json
     */
    /**
     * Sample code: Update a managed server's threat detection policy with all parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAManagedServerSThreatDetectionPolicyWithAllParameters(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ManagedServerSecurityAlertPolicyInner().withState(SecurityAlertPolicyState.ENABLED)
                .withDisabledAlerts(Arrays.asList("Access_Anomaly", "Usage_Anomaly"))
                .withEmailAddresses(Arrays.asList("testSecurityAlert@microsoft.com")).withEmailAccountAdmins(true)
                .withStorageEndpoint("https://mystorage.blob.core.windows.net")
                .withStorageAccountAccessKey("fakeTokenPlaceholder").withRetentionDays(5),
            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",
  "name": "Default",
  "type": "Microsoft.Sql/managedInstances/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": [
      "testSecurityAlert@microsoft.com"
    ],
    "disabledAlerts": [
      "Access_Anomaly",
      "Usage_Anomaly"
    ],
    "retentionDays": 5,
    "storageAccountAccessKey": "",
    "storageEndpoint": "https://mystorage.blob.core.windows.net"
  }
}

Status code:: 202

Update a managed server'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/securityAlertPolicies/Default?api-version=2021-11-01

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


import com.azure.core.util.Context;
import com.azure.resourcemanager.sql.fluent.models.ManagedServerSecurityAlertPolicyInner;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyNameAutoGenerated;
import com.azure.resourcemanager.sql.models.SecurityAlertPolicyState;

/** Samples for ManagedServerSecurityAlertPolicies CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/ManagedServerSecurityAlertCreateMin.
     * json
     */
    /**
     * Sample code: Update a managed server's threat detection policy with minimal parameters.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAManagedServerSThreatDetectionPolicyWithMinimalParameters(
        com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getManagedServerSecurityAlertPolicies().createOrUpdate(
            "securityalert-4799", "securityalert-6440", SecurityAlertPolicyNameAutoGenerated.DEFAULT,
            new ManagedServerSecurityAlertPolicyInner().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/managedInstances/securityalert-6440",
  "name": "Default",
  "type": "Microsoft.Sql/managedInstances/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,
    "storageAccountAccessKey": "",
    "storageEndpoint": ""
  }
}

Status code:: 202

Définitions

Nom	Description
createdByType	Type d’identité qui a créé la ressource.
ManagedServerSecurityAlertPolicy	Une stratégie d’alerte de sécurité de serveur managé.
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

ManagedServerSecurityAlertPolicy

Une stratégie d’alerte de sécurité de serveur managé.

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.

Managed Server Security Alert Policies - Create Or Update

Paramètres URI

Corps de la demande

Réponses

Exemples

Update a managed server's threat detection policy with all parameters

Sample Request

Sample Response

Update a managed server's threat detection policy with minimal parameters

Sample Request

Sample Response

Définitions

createdByType

ManagedServerSecurityAlertPolicy

SecurityAlertPolicyName

SecurityAlertsPolicyState

systemData

Ressources supplémentaires