Partager via


Automations - Update

Mises à jour une automatisation de la sécurité

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}?api-version=2023-12-01-preview

Paramètres URI

Nom Dans Obligatoire Type Description
automationName
path True

string

Nom de l’automatisation de la sécurité.

resourceGroupName
path True

string

Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

ID d’abonnement Azure

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

Version de l’API pour l’opération

Corps de la demande

Nom Type Description
properties.actions AutomationAction[]:

Collection des actions qui sont déclenchées si toutes les évaluations de règles configurées, dans au moins un ensemble de règles, sont vraies.

properties.description

string

Description de l’automatisation de la sécurité.

properties.isEnabled

boolean

Indique si l’automatisation de la sécurité est activée.

properties.scopes

AutomationScope[]

Collection d’étendues sur lesquelles la logique d’automatisation de la sécurité est appliquée. Les étendues prises en charge sont l’abonnement lui-même ou un groupe de ressources sous cet abonnement. L’automatisation s’applique uniquement aux étendues définies.

properties.sources

AutomationSource[]

Collection des types d’événements sources qui évaluent l’ensemble de règles d’automatisation de la sécurité.

tags

object

Liste de paires clé/valeur décrivant la ressource.

Réponses

Nom Type Description
200 OK

Automation

Ok

Other Status Codes

CloudError

Réponse d’erreur décrivant la raison de l’échec de l’opération

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

Update a security automation

Sample Request

PATCH https://management.azure.com/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation?api-version=2023-12-01-preview

{
  "tags": {
    "Example": "exampleTag"
  },
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "scopes": [
      {
        "description": "A description that helps to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5",
        "scopePath": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"
      }
    ],
    "sources": [
      {
        "eventSource": "Assessments"
      }
    ],
    "actions": [
      {
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "actionType": "LogicApp",
        "uri": "https://exampleTriggerUri1.com"
      }
    ]
  }
}

Sample Response

{
  "id": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation",
  "name": "exampleAutomation",
  "type": "Microsoft.Security/automations",
  "location": "Central US",
  "etag": "new etag value",
  "tags": {},
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "isEnabled": true,
    "scopes": [
      {
        "description": "A description that helps to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5",
        "scopePath": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"
      }
    ],
    "sources": [
      {
        "eventSource": "Assessments",
        "ruleSets": []
      }
    ],
    "actions": [
      {
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "actionType": "LogicApp"
      }
    ]
  }
}

Définitions

Nom Description
Automation

Ressource d’automatisation de la sécurité.

AutomationActionEventHub

Hub d’événements cible vers lequel les données d’événement seront exportées. Pour en savoir plus sur les fonctionnalités d’exportation continue Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCExportLearnMore

AutomationActionLogicApp

Action d’application logique qui doit être déclenchée. Pour en savoir plus sur les fonctionnalités d’automatisation des flux de travail de Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCWorkflowAutomationLearnMore

AutomationActionWorkspace

Espace de travail Log Analytics vers lequel les données d’événement seront exportées. Les données des alertes de sécurité résideront dans la table « SecurityAlert » et les données d’évaluation se trouveront dans la table « SecurityRecommendation » (sous les solutions « Security »/« SecurityCenterFree »). Notez que pour afficher les données dans l’espace de travail, la solution standard/gratuite De Security Center Log Analytics doit être activée sur cet espace de travail. Pour en savoir plus sur les fonctionnalités d’exportation continue Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCExportLearnMore

AutomationRuleSet

Ensemble de règles qui évalue toutes ses règles lors d’une interception d’événement. Ce n’est que lorsque toutes les règles incluses dans l’ensemble de règles sont évaluées comme « true » que l’événement déclenche les actions définies.

AutomationScope

Étendue d’automatisation unique.

AutomationSource

Types d’événements sources qui évaluent l’ensemble de règles d’automatisation de la sécurité. Par exemple , alertes de sécurité et évaluations de sécurité. Pour en savoir plus sur les schémas de modèles de données des événements de sécurité pris en charge, consultez https://aka.ms/ASCAutomationSchemas.

AutomationTriggeringRule

Règle qui est évaluée lors de l’interception d’événements. La règle est configurée en comparant une valeur spécifique du modèle d’événement à une valeur attendue. Cette comparaison est effectuée à l’aide de l’un des opérateurs pris en charge.

AutomationUpdateModel

Modèle de mise à jour de la ressource d’automatisation de la sécurité.

CloudError

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

CloudErrorBody

Détail de l’erreur.

ErrorAdditionalInfo

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

EventSource

Type de source d’événement valide.

Operator

Opérateur de comparaison valide à utiliser. Une comparaison qui ne respecte pas la casse sera appliquée pour String PropertyType.

PropertyType

Type de données des opérandes comparés (chaîne, entier, nombre à virgule flottante ou booléen [true/false]]

Automation

Ressource d’automatisation de la sécurité.

Nom Type Description
etag

string

La balise d’entité est utilisée pour comparer au moins deux entités de la même ressource demandée.

id

string

ID de ressource

kind

string

Type de ressource

location

string

Emplacement où la ressource est stockée

name

string

Nom de la ressource

properties.actions AutomationAction[]:

Collection des actions qui sont déclenchées si toutes les évaluations de règles configurées, au sein d’au moins un ensemble de règles, sont true.

properties.description

string

Description de l’automatisation de la sécurité.

properties.isEnabled

boolean

Indique si l’automatisation de la sécurité est activée.

properties.scopes

AutomationScope[]

Collection d’étendues sur lesquelles la logique d’automatisation de la sécurité est appliquée. Les étendues prises en charge sont l’abonnement lui-même ou un groupe de ressources sous cet abonnement. L’automatisation s’applique uniquement aux étendues définies.

properties.sources

AutomationSource[]

Collection des types d’événements sources qui évaluent l’ensemble de règles d’automatisation de la sécurité.

tags

object

Liste de paires clé/valeur décrivant la ressource.

type

string

Type de ressource

AutomationActionEventHub

Hub d’événements cible vers lequel les données d’événement seront exportées. Pour en savoir plus sur les fonctionnalités d’exportation continue Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCExportLearnMore

Nom Type Description
actionType string:

EventHub

Type de l’action qui sera déclenchée par l’automatisation

connectionString

string

Le hub d’événements cible chaîne de connexion (il ne sera inclus dans aucune réponse).

eventHubResourceId

string

ID de ressource Azure Event Hub cible.

isTrustedServiceEnabled

boolean

Indique si le service approuvé est activé ou non.

sasPolicyName

string

Nom de la stratégie SAS d’Event Hub cible.

AutomationActionLogicApp

Action d’application logique qui doit être déclenchée. Pour en savoir plus sur les fonctionnalités d’automatisation des flux de travail de Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCWorkflowAutomationLearnMore

Nom Type Description
actionType string:

LogicApp

Type de l’action qui sera déclenchée par l’automatisation

logicAppResourceId

string

ID de ressource Azure d’application logique déclenchée. Cela peut également résider sur d’autres abonnements, étant donné que vous avez les autorisations nécessaires pour déclencher l’application logique

uri

string

Point de terminaison d’URI du déclencheur d’application logique (il ne sera inclus dans aucune réponse).

AutomationActionWorkspace

Espace de travail Log Analytics vers lequel les données d’événement seront exportées. Les données des alertes de sécurité résideront dans la table « SecurityAlert » et les données d’évaluation se trouveront dans la table « SecurityRecommendation » (sous les solutions « Security »/« SecurityCenterFree »). Notez que pour afficher les données dans l’espace de travail, la solution standard/gratuite De Security Center Log Analytics doit être activée sur cet espace de travail. Pour en savoir plus sur les fonctionnalités d’exportation continue Microsoft Defender pour le cloud, consultezhttps://aka.ms/ASCExportLearnMore

Nom Type Description
actionType string:

Workspace

Type de l’action qui sera déclenchée par l’automatisation

workspaceResourceId

string

ID de ressource Azure complet de l’espace de travail Log Analytics.

AutomationRuleSet

Ensemble de règles qui évalue toutes ses règles lors d’une interception d’événement. Ce n’est que lorsque toutes les règles incluses dans l’ensemble de règles sont évaluées comme « true » que l’événement déclenche les actions définies.

Nom Type Description
rules

AutomationTriggeringRule[]

Règle qui est évaluée lors de l’interception d’événements. La règle est configurée en comparant une valeur spécifique du modèle d’événement à une valeur attendue. Cette comparaison est effectuée à l’aide de l’un des opérateurs pris en charge.

AutomationScope

Étendue d’automatisation unique.

Nom Type Description
description

string

Description de l’étendue des ressources.

scopePath

string

Chemin d’accès de l’étendue des ressources. Il peut s’agir de l’abonnement sur lequel l’automatisation est définie ou d’un groupe de ressources sous cet abonnement (ID de ressource Azure complet).

AutomationSource

Types d’événements sources qui évaluent l’ensemble de règles d’automatisation de la sécurité. Par exemple , alertes de sécurité et évaluations de sécurité. Pour en savoir plus sur les schémas de modèles de données des événements de sécurité pris en charge, consultez https://aka.ms/ASCAutomationSchemas.

Nom Type Description
eventSource

EventSource

Type de source d’événement valide.

ruleSets

AutomationRuleSet[]

Ensemble de règles qui sont évaluées lors de l’interception d’événements. Une disjonction logique est appliquée entre les ensembles de règles définis (logique 'ou').

AutomationTriggeringRule

Règle qui est évaluée lors de l’interception d’événements. La règle est configurée en comparant une valeur spécifique du modèle d’événement à une valeur attendue. Cette comparaison est effectuée à l’aide de l’un des opérateurs pris en charge.

Nom Type Description
expectedValue

string

Valeur attendue.

operator

Operator

Opérateur de comparaison valide à utiliser. Une comparaison qui ne respecte pas la casse sera appliquée pour String PropertyType.

propertyJPath

string

JPath de la propriété de modèle d’entité qui doit être vérifiée.

propertyType

PropertyType

Type de données des opérandes comparés (chaîne, entier, nombre à virgule flottante ou booléen [true/false]]

AutomationUpdateModel

Modèle de mise à jour de la ressource d’automatisation de la sécurité.

Nom Type Description
properties.actions AutomationAction[]:

Collection des actions qui sont déclenchées si toutes les évaluations de règles configurées, au sein d’au moins un ensemble de règles, sont true.

properties.description

string

Description de l’automatisation de la sécurité.

properties.isEnabled

boolean

Indique si l’automatisation de la sécurité est activée.

properties.scopes

AutomationScope[]

Collection d’étendues sur lesquelles la logique d’automatisation de la sécurité est appliquée. Les étendues prises en charge sont l’abonnement lui-même ou un groupe de ressources sous cet abonnement. L’automatisation s’applique uniquement aux étendues définies.

properties.sources

AutomationSource[]

Collection des types d’événements sources qui évaluent l’ensemble de règles d’automatisation de la sécurité.

tags

object

Liste de paires clé/valeur décrivant la ressource.

CloudError

Réponse d’erreur courante pour toutes les API Azure Resource Manager pour retourner les détails de l’erreur concernant 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

CloudErrorBody[]

Détails de l’erreur.

error.message

string

Message d’erreur.

error.target

string

Cible d’erreur.

CloudErrorBody

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.

code

string

Code d'erreur.

details

CloudErrorBody[]

Détails de l’erreur.

message

string

Message d’erreur.

target

string

Cible d’erreur.

ErrorAdditionalInfo

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

Nom Type Description
info

object

Informations supplémentaires

type

string

Type d’informations supplémentaires.

EventSource

Type de source d’événement valide.

Nom Type Description
Alerts

string

Assessments

string

AssessmentsSnapshot

string

AttackPaths

string

AttackPathsSnapshot

string

RegulatoryComplianceAssessment

string

RegulatoryComplianceAssessmentSnapshot

string

SecureScoreControls

string

SecureScoreControlsSnapshot

string

SecureScores

string

SecureScoresSnapshot

string

SubAssessments

string

SubAssessmentsSnapshot

string

Operator

Opérateur de comparaison valide à utiliser. Une comparaison qui ne respecte pas la casse sera appliquée pour String PropertyType.

Nom Type Description
Contains

string

S’applique uniquement aux opérandes non décimaux

EndsWith

string

S’applique uniquement aux opérandes non décimaux

Equals

string

S’applique aux opérandes décimaux et non décimaux

GreaterThan

string

S’applique uniquement aux opérandes décimaux

GreaterThanOrEqualTo

string

S’applique uniquement aux opérandes décimaux

LesserThan

string

S’applique uniquement aux opérandes décimaux

LesserThanOrEqualTo

string

S’applique uniquement aux opérandes décimaux

NotEquals

string

S’applique aux opérandes décimaux et non décimaux

StartsWith

string

S’applique uniquement aux opérandes non décimaux

PropertyType

Type de données des opérandes comparés (chaîne, entier, nombre à virgule flottante ou booléen [true/false]]

Nom Type Description
Boolean

string

Integer

string

Number

string

String

string