Alerts Suppression Rules - Update

Service:

Defender for Cloud

Version d'API:

2019-01-01-preview

Mettre à jour une règle existante ou créer une règle s’il n’existe pas

PUT https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Security/alertsSuppressionRules/{alertsSuppressionRuleName}?api-version=2019-01-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
alertsSuppressionRuleName	path	True	string	Nom unique de la règle d’alerte de suppression
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
properties.alertType	True	string	Type de l’alerte à supprimer automatiquement. Pour tous les types d’alertes, utilisez « * »
properties.reason	True	string	Motif de l’abandon de l’alerte
properties.state	True	RuleState	États possibles de la règle
properties.comment		string	Tout commentaire concernant la règle
properties.expirationDateUtc		string (date-time)	Date d’expiration de la règle, si la valeur n’est pas fournie ou fournie comme null, il n’y aura aucune expiration du tout
properties.suppressionAlertsScope		SuppressionAlertsScope	Conditions de suppression

Réponses

Nom	Type	Description
200 OK	AlertsSuppressionRule	Opération de mise à jour de la ressource 'AlertsSuppressionRule' réussie
Other Status Codes	Common.CloudError	Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

Update or create suppression rule for subscription

Exemple de requête

HTTP

PUT https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts?api-version=2019-01-01-preview

{
  "properties": {
    "alertType": "IpAnomaly",
    "comment": "Test VM",
    "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
    "reason": "FalsePositive",
    "state": "Enabled",
    "suppressionAlertsScope": {
      "allOf": [
        {
          "field": "entities.ip.address",
          "in": [
            "104.215.95.187",
            "52.164.206.56"
          ]
        },
        {
          "contains": "POWERSHELL.EXE",
          "field": "entities.process.commandline"
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:

200

{
  "name": "dismissIpAnomalyAlerts",
  "type": "Microsoft.Security/alertsSuppressionRules",
  "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/alertsSuppressionRules/dismissIpAnomalyAlerts",
  "properties": {
    "alertType": "IpAnomaly",
    "comment": "Test VM",
    "expirationDateUtc": "2019-12-01T19:50:47.083633Z",
    "lastModifiedUtc": "2019-07-31T19:50:47.083633Z",
    "reason": "FalsePositive",
    "state": "Enabled",
    "suppressionAlertsScope": {
      "allOf": [
        {
          "field": "entities.ip.address",
          "in": [
            "104.215.95.187",
            "52.164.206.56"
          ]
        },
        {
          "contains": "POWERSHELL.EXE",
          "field": "entities.process.commandline"
        }
      ]
    }
  }
}

Définitions

Nom	Description
AlertsSuppressionRule	Décrit la règle de suppression
Common.CloudError	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
Common.CloudErrorBody	Détail de l’erreur.
createdByType	Type d’identité qui a créé la ressource.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
RuleState	États possibles de la règle
ScopeElement	Étendue plus spécifique utilisée pour identifier les alertes à supprimer.
SuppressionAlertsScope
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.

AlertsSuppressionRule

Objet

Décrit la règle de suppression

Nom	Type	Description
id	string (arm-id)	ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
name	string	Nom de la ressource
properties.alertType	string	Type de l’alerte à supprimer automatiquement. Pour tous les types d’alertes, utilisez « * »
properties.comment	string	Tout commentaire concernant la règle
properties.expirationDateUtc	string (date-time)	Date d’expiration de la règle, si la valeur n’est pas fournie ou fournie comme null, il n’y aura aucune expiration du tout
properties.lastModifiedUtc	string (date-time)	La dernière fois que cette règle a été modifiée
properties.reason	string	Motif de l’abandon de l’alerte
properties.state	RuleState	États possibles de la règle
properties.suppressionAlertsScope	SuppressionAlertsScope	Conditions de suppression
systemData	systemData	Métadonnées Azure Resource Manager contenant les informations createdBy et modifiedBy.
type	string	Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

Common.CloudError

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
error.code	string	Code d’erreur.
error.details	Common.CloudErrorBody[]	Détails de l’erreur.
error.message	string	Message d’erreur.
error.target	string	Cible d’erreur.

Common.CloudErrorBody

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	Common.CloudErrorBody[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

createdByType

Énumération

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

Valeur	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

RuleState

Énumération

États possibles de la règle

Valeur	Description
Enabled	Enabled
Disabled	Disabled
Expired	Expiré

ScopeElement

Objet

Étendue plus spécifique utilisée pour identifier les alertes à supprimer.

Nom	Type	Description
field	string	Type d’entité d’alerte à supprimer.

SuppressionAlertsScope

Objet

Nom	Type	Description
allOf	ScopeElement[]	Toutes les conditions à l’intérieur doivent être vraies pour supprimer l’alerte

systemData

Objet

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

Nom	Type	Description
createdAt	string (date-time)	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 (date-time)	Horodatage de la dernière modification de 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.