Automations - List

Riferimento

Servizio:: Defender for Cloud

Versione API:: 2023-12-01-preview

Elenca tutte le automazione di sicurezza nella sottoscrizione specificata. Usare la proprietà 'nextLink' nella risposta per ottenere la pagina successiva di automazione della sicurezza per la sottoscrizione specificata.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione

Nome	In	Necessario	Tipo	Descrizione
subscriptionId	path	True	string	ID sottoscrizione di Azure Criterio di espressione regolare: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versione dell'API per l'operazione

subscriptionId

path

True

string

ID sottoscrizione di Azure

Criterio di espressione regolare: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version

query

True

string

Versione dell'API per l'operazione

Risposte

Nome	Tipo	Descrizione
200 OK	AutomationList	OK
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List all security automations of a specified subscription

Esempio di richiesta

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


/**
 * Samples for Automations List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/
     * GetAutomationsSubscription_example.json
     */
    /**
     * Sample code: List all security automations of a specified subscription.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listAllSecurityAutomationsOfASpecifiedSubscription(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.automations().list(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/GetAutomationsSubscription_example.json
func ExampleAutomationsClient_NewListPager() {
	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().NewListPager(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/a5caac9c-5c04-49af-b3d0-e204f40345d5/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 subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.
 *
 * @summary Lists all the security automations in the specified subscription. Use the 'nextLink' property in the response to get the next page of security automations for the specified subscription.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/GetAutomationsSubscription_example.json
 */
async function listAllSecurityAutomationsOfASpecifiedSubscription() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "a5caac9c-5c04-49af-b3d0-e204f40345d5";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.automations.list()) {
    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

Risposta di esempio

Codice di stato:: 200

{
  "value": [
    {
      "id": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/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"
          }
        ]
      }
    }
  ]
}

Definizioni

Nome	Descrizione
Automation	Risorsa di automazione della sicurezza.
AutomationActionEventHub	Hub eventi di destinazione in cui verranno esportati i dati dell'evento. Per altre informazioni sulle funzionalità di esportazione continua di Microsoft Defender for Cloud, visitare https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Azione dell'app per la logica che deve essere attivata. Per altre informazioni sulle funzionalità di automazione del flusso di lavoro di Microsoft Defender for Cloud, visitare https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Area di lavoro Log Analytics in cui verranno esportati i dati dell'evento. I dati degli avvisi di sicurezza si troveranno nella tabella "SecurityAlert" e i dati delle valutazioni si troveranno nella tabella "SecurityRecommendation" (nelle soluzioni "Security"/'SecurityCenterFree"). Si noti che per visualizzare i dati nell'area di lavoro, è necessario abilitare la soluzione gratuita/standard di Log Analytics del Centro sicurezza in tale area di lavoro. Per altre informazioni sulle funzionalità di esportazione continua di Microsoft Defender for Cloud, visitare https://aka.ms/ASCExportLearnMore
AutomationList	Elenco delle risposte alle automazione della sicurezza.
AutomationRuleSet	Set di regole che valuta tutte le relative regole in caso di intercettazione di un evento. Solo quando tutte le regole incluse nel set di regole verranno valutate come "true", l'evento attiverà le azioni definite.
AutomationScope	Ambito di automazione singolo.
AutomationSource	Tipi di evento di origine che valutano il set di regole di automazione della sicurezza. Ad esempio, avvisi di sicurezza e valutazioni della sicurezza. Per altre informazioni sugli schemi dei modelli di dati degli eventi di sicurezza supportati, vedere https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Regola che viene valutata in caso di intercettazione degli eventi. La regola viene configurata confrontando un valore specifico dal modello di evento a un valore previsto. Questo confronto viene eseguito usando uno degli operatori supportati impostati.
CloudError	Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.
CloudErrorBody	Dettagli dell'errore.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
EventSource	Tipo di origine evento valido.
Operator	Operatore di confronto valido da utilizzare. Verrà applicato un confronto senza distinzione tra maiuscole e minuscole per String PropertyType.
PropertyType	Tipo di dati degli operandi confrontati (string, integer, numero a virgola mobile o booleano [true/false]]

Automation

Risorsa di automazione della sicurezza.

Nome	Tipo	Descrizione
etag	string	Il tag di entità viene usato per confrontare due o più entità dalla stessa risorsa richiesta.
id	string	ID risorsa
kind	string	Tipo di risorsa
location	string	Posizione in cui è archiviata la risorsa
name	string	Nome risorsa
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Una raccolta di azioni che vengono attivate se tutte le valutazioni delle regole configurate, all'interno di almeno un set di regole, sono vere.
properties.description	string	Descrizione dell'automazione della sicurezza.
properties.isEnabled	boolean	Indica se l'automazione della sicurezza è abilitata.
properties.scopes	AutomationScope[]	Raccolta di ambiti in cui viene applicata la logica di automazione della sicurezza. Gli ambiti supportati sono la sottoscrizione stessa o un gruppo di risorse nella sottoscrizione. L'automazione verrà applicata solo agli ambiti definiti.
properties.sources	AutomationSource[]	Raccolta dei tipi di evento di origine che valutano il set di regole di automazione della sicurezza.
tags	object	Elenco di coppie chiave-valore che descrivono la risorsa.
type	string	Tipo di risorsa

AutomationActionEventHub

Hub eventi di destinazione in cui verranno esportati i dati dell'evento. Per altre informazioni sulle funzionalità di esportazione continua di Microsoft Defender for Cloud, visitare https://aka.ms/ASCExportLearnMore

Nome	Tipo	Descrizione
actionType	string: EventHub	Tipo dell'azione che verrà attivata dall'automazione
connectionString	string	Stringa di connessione dell'hub eventi di destinazione (non verrà inclusa in alcuna risposta).
eventHubResourceId	string	ID risorsa di Azure dell'hub eventi di destinazione.
isTrustedServiceEnabled	boolean	Indica se il servizio attendibile è abilitato o meno.
sasPolicyName	string	Nome del criterio di firma di accesso condiviso dell'hub eventi di destinazione.

AutomationActionLogicApp

Azione dell'app per la logica che deve essere attivata. Per altre informazioni sulle funzionalità di automazione del flusso di lavoro di Microsoft Defender for Cloud, visitare https://aka.ms/ASCWorkflowAutomationLearnMore

Nome	Tipo	Descrizione
actionType	string: LogicApp	Tipo dell'azione che verrà attivata dall'automazione
logicAppResourceId	string	ID risorsa di Azure dell'app per la logica attivata. Questo può risiedere anche in altre sottoscrizioni, dato che si dispone delle autorizzazioni per attivare l'app per la logica
uri	string	L'endpoint dell'URI del trigger dell'app per la logica (non verrà incluso in alcuna risposta).

AutomationActionWorkspace

Area di lavoro Log Analytics in cui verranno esportati i dati dell'evento. I dati degli avvisi di sicurezza si troveranno nella tabella "SecurityAlert" e i dati delle valutazioni si troveranno nella tabella "SecurityRecommendation" (nelle soluzioni "Security"/'SecurityCenterFree"). Si noti che per visualizzare i dati nell'area di lavoro, è necessario abilitare la soluzione gratuita/standard di Log Analytics del Centro sicurezza in tale area di lavoro. Per altre informazioni sulle funzionalità di esportazione continua di Microsoft Defender for Cloud, visitare https://aka.ms/ASCExportLearnMore

Nome	Tipo	Descrizione
actionType	string: Workspace	Tipo dell'azione che verrà attivata dall'automazione
workspaceResourceId	string	ID risorsa di Azure completo dell'area di lavoro Log Analytics.

AutomationList

Elenco delle risposte alle automazione della sicurezza.

Nome	Tipo	Descrizione
nextLink	string	URI da recuperare la pagina successiva.
value	Automation[]	Elenco di automazione della sicurezza nell'ambito specificato.

AutomationRuleSet

Set di regole che valuta tutte le relative regole in caso di intercettazione di un evento. Solo quando tutte le regole incluse nel set di regole verranno valutate come "true", l'evento attiverà le azioni definite.

Nome	Tipo	Descrizione
rules	AutomationTriggeringRule[]	Regola che viene valutata in caso di intercettazione degli eventi. La regola viene configurata confrontando un valore specifico dal modello di evento a un valore previsto. Questo confronto viene eseguito usando uno degli operatori supportati impostati.

AutomationScope

Ambito di automazione singolo.

Nome	Tipo	Descrizione
description	string	Descrizione dell'ambito delle risorse.
scopePath	string	Percorso dell'ambito delle risorse. Può essere la sottoscrizione in cui è definita l'automazione in o un gruppo di risorse nella sottoscrizione (ID risorsa di Azure completi).

AutomationSource

Tipi di evento di origine che valutano il set di regole di automazione della sicurezza. Ad esempio, avvisi di sicurezza e valutazioni della sicurezza. Per altre informazioni sugli schemi dei modelli di dati degli eventi di sicurezza supportati, vedere https://aka.ms/ASCAutomationSchemas.

Nome	Tipo	Descrizione
eventSource	EventSource	Tipo di origine evento valido.
ruleSets	AutomationRuleSet[]	Set di regole che valutano in caso di intercettazione degli eventi. Viene applicata una disgiunzione logica tra set di regole definiti ('or').

AutomationTriggeringRule

Regola che viene valutata in caso di intercettazione degli eventi. La regola viene configurata confrontando un valore specifico dal modello di evento a un valore previsto. Questo confronto viene eseguito usando uno degli operatori supportati impostati.

Nome	Tipo	Descrizione
expectedValue	string	Valore previsto.
operator	Operator	Operatore di confronto valido da utilizzare. Verrà applicato un confronto senza distinzione tra maiuscole e minuscole per String PropertyType.
propertyJPath	string	JPath della proprietà del modello di entità da controllare.
propertyType	PropertyType	Tipo di dati degli operandi confrontati (string, integer, numero a virgola mobile o booleano [true/false]]

CloudError

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome	Tipo	Descrizione
error.additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
error.code	string	Codice di errore.
error.details	CloudErrorBody[]	Dettagli dell'errore.
error.message	string	Messaggio di errore.
error.target	string	Destinazione dell'errore.

CloudErrorBody

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	CloudErrorBody[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

EventSource

Tipo di origine evento valido.

Nome	Tipo	Descrizione
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

Operatore di confronto valido da utilizzare. Verrà applicato un confronto senza distinzione tra maiuscole e minuscole per String PropertyType.

Nome	Tipo	Descrizione
Contains	string	Si applica solo per gli operandi non decimali
EndsWith	string	Si applica solo per gli operandi non decimali
Equals	string	Si applica per gli operandi decimali e non decimali
GreaterThan	string	Si applica solo per gli operandi decimali
GreaterThanOrEqualTo	string	Si applica solo per gli operandi decimali
LesserThan	string	Si applica solo per gli operandi decimali
LesserThanOrEqualTo	string	Si applica solo per gli operandi decimali
NotEquals	string	Si applica per gli operandi decimali e non decimali
StartsWith	string	Si applica solo per gli operandi non decimali

PropertyType

Tipo di dati degli operandi confrontati (string, integer, numero a virgola mobile o booleano [true/false]]

Nome	Tipo	Descrizione
Boolean	string
Integer	string
Number	string
String	string

Condividi tramite

Automations - List

Parametri dell'URI

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

List all security automations of a specified subscription

Esempio di richiesta

Risposta di esempio

Definizioni

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationList

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Risorse aggiuntive