Automations - List By Resource Group

Référence

Service:: Defender for Cloud

Version d'API:: 2023-12-01-preview

Répertorie toutes les automatisations de sécurité dans le groupe de ressources spécifié. Utilisez la propriété « nextLink » dans la réponse pour obtenir la page suivante des automatisations de sécurité pour le groupe de ressources spécifié.

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

Paramètres URI

Nom Dans Obligatoire Type Description

Nom	Dans	Obligatoire	Type	Description
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse. Modèle d’expression régulière: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	ID d’abonnement Azure Modèle d’expression régulière: `^[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

resourceGroupName

path

True

string

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

Modèle d’expression régulière: ^[-\w\._]+$

subscriptionId

path

True

string

ID d’abonnement Azure

Modèle d’expression régulière: ^[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

Réponses

Nom	Type	Description
200 OK	AutomationList	D’ACCORD
Other Status Codes	CloudError	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

List all security automations of a specified resource group

Exemple de requête

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


/**
 * Samples for Automations ListByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/
     * GetAutomationsResourceGroup_example.json
     */
    /**
     * Sample code: List all security automations of a specified resource group.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void listAllSecurityAutomationsOfASpecifiedResourceGroup(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.automations().listByResourceGroup("exampleResourceGroup", com.azure.core.util.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

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/GetAutomationsResourceGroup_example.json
func ExampleAutomationsClient_NewListByResourceGroupPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewAutomationsClient().NewListByResourceGroupPager("exampleResourceGroup", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.AutomationList = armsecurity.AutomationList{
		// 	Value: []*armsecurity.Automation{
		// 		{
		// 			Location: to.Ptr("Central US"),
		// 			Etag: to.Ptr("etag value"),
		// 			Name: to.Ptr("exampleAutomation"),
		// 			Type: to.Ptr("Microsoft.Security/automations"),
		// 			ID: to.Ptr("/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation"),
		// 			Tags: map[string]*string{
		// 			},
		// 			Properties: &armsecurity.AutomationProperties{
		// 				Description: to.Ptr("An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment"),
		// 				Actions: []armsecurity.AutomationActionClassification{
		// 					&armsecurity.AutomationActionLogicApp{
		// 						ActionType: to.Ptr(armsecurity.ActionTypeLogicApp),
		// 						LogicAppResourceID: to.Ptr("/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1"),
		// 				}},
		// 				IsEnabled: to.Ptr(true),
		// 				Scopes: []*armsecurity.AutomationScope{
		// 					{
		// 						Description: to.Ptr("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: to.Ptr("/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"),
		// 				}},
		// 				Sources: []*armsecurity.AutomationSource{
		// 					{
		// 						EventSource: to.Ptr(armsecurity.EventSourceAssessments),
		// 						RuleSets: []*armsecurity.AutomationRuleSet{
		// 							{
		// 								Rules: []*armsecurity.AutomationTriggeringRule{
		// 									{
		// 										ExpectedValue: to.Ptr("customAssessment"),
		// 										Operator: to.Ptr(armsecurity.OperatorEquals),
		// 										PropertyJPath: to.Ptr("$.Entity.AssessmentType"),
		// 										PropertyType: to.Ptr(armsecurity.PropertyTypeString),
		// 								}},
		// 						}},
		// 				}},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.
 *
 * @summary Lists all the security automations in the specified resource group. Use the 'nextLink' property in the response to get the next page of security automations for the specified resource group.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/GetAutomationsResourceGroup_example.json
 */
async function listAllSecurityAutomationsOfASpecifiedResourceGroup() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "a5caac9c-5c04-49af-b3d0-e204f40345d5";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.automations.listByResourceGroup(resourceGroupName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "id": "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation",
      "name": "exampleAutomation",
      "type": "Microsoft.Security/automations",
      "etag": "etag value",
      "location": "Central US",
      "tags": {},
      "properties": {
        "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment",
        "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": [
              {
                "rules": [
                  {
                    "propertyJPath": "$.Entity.AssessmentType",
                    "propertyType": "String",
                    "expectedValue": "customAssessment",
                    "operator": "Equals"
                  }
                ]
              }
            ]
          }
        ],
        "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 de Microsoft Defender pour cloud, visitez https://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 cloud, consultez https://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ésident dans la table « SecurityAlert » et les données d’évaluation résident dans la table « SecurityRecommendation » (sous les solutions « Security » /« SecurityCenterFree »). Notez que pour afficher les données dans l’espace de travail, la solution Gratuite/standard 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 de Microsoft Defender pour cloud, visitez https://aka.ms/ASCExportLearnMore
AutomationList	Liste des réponses aux automatisations de la sécurité.
AutomationRuleSet	Ensemble de règles qui évalue toutes ses règles en cas d’interception d’événement. Uniquement lorsque toutes les règles incluses dans l’ensemble de règles sont évaluées comme « true », 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 d’événements de sécurité pris en charge, consultez https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Règle évaluée lors de l’interception des é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 définis.
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.).
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 comparateur valide à utiliser. Une comparaison sans respect de la casse est appliquée à 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 deux entités ou plus à partir 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[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Collection des actions 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 des paires clé-valeur qui décrivent 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 de Microsoft Defender pour cloud, visitez https://aka.ms/ASCExportLearnMore

Nom	Type	Description
actionType	string: EventHub	Type de l’action qui sera déclenchée par l’automatisation
connectionString	string	Chaîne de connexion Event Hub cible (elle ne sera incluse 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 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 cloud, consultez https://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 de l’application logique déclenchée. Cela peut également résider sur d’autres abonnements, étant donné que vous disposez des autorisations nécessaires pour déclencher l’application logique
uri	string	Le 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ésident dans la table « SecurityAlert » et les données d’évaluation résident dans la table « SecurityRecommendation » (sous les solutions « Security » /« SecurityCenterFree »). Notez que pour afficher les données dans l’espace de travail, la solution Gratuite/standard 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 de Microsoft Defender pour cloud, visitez https://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 de l’espace de travail Log Analytics complet.

AutomationList

Liste des réponses aux automatisations de la sécurité.

Nom	Type	Description
nextLink	string	URI permettant d’extraire la page suivante.
value	Automation[]	Liste des automatisations de sécurité sous l’étendue donnée.

AutomationRuleSet

Ensemble de règles qui évalue toutes ses règles en cas d’interception d’événement. Uniquement lorsque toutes les règles incluses dans l’ensemble de règles sont évaluées comme « true », l’événement déclenche les actions définies.

Nom	Type	Description
rules	AutomationTriggeringRule[]	Règle évaluée lors de l’interception des é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 définis.

AutomationScope

Étendue d’automatisation unique.

Nom	Type	Description
description	string	Description de l’étendue des ressources.
scopePath	string	Chemin d’é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 complets).

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 d’é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 évaluent l’interception des événements. Une disjonction logique est appliquée entre les ensembles de règles définis (logique 'or').

AutomationTriggeringRule

Règle évaluée lors de l’interception des é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 définis.

Nom	Type	Description
expectedValue	string	Valeur attendue.
operator	Operator	Opérateur de comparateur valide à utiliser. Une comparaison sans respect de la casse est appliquée à String PropertyType.
propertyJPath	string	JPath de la propriété du 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]]

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.).

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émentaire.

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 comparateur valide à utiliser. Une comparaison sans respect de la casse est appliquée à 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

Partager via

Automations - List By Resource Group

Paramètres URI

Réponses

Sécurité

azure_auth

Étendues

Exemples

List all security automations of a specified resource group

Exemple de requête

Exemple de réponse

Définitions

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationList

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Ressources supplémentaires