Automations - List By Resource Group

Referentie

Service:: Defender for Cloud

API-versie:: 2023-12-01-preview

Een lijst met alle beveiligingsautomatiseringen in de opgegeven resourcegroep. Gebruik de eigenschap nextLink in het antwoord om de volgende pagina met beveiligingsautomatiseringen voor de opgegeven resourcegroep op te halen.

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

URI-parameters

Name In Vereist Type Description

Name	In	Vereist	Type	Description
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig. Regex-patroon: `^[-\w\._\(\)]+$`
subscriptionId	path	True	string	Azure-abonnements-id Regex-patroon: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API-versie voor de bewerking

resourceGroupName

path

True

string

De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.

Regex-patroon: ^[-\w\._]+$

subscriptionId

path

True

string

Azure-abonnements-id

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

api-version

query

True

string

API-versie voor de bewerking

Antwoorden

Name	Type	Description
200 OK	AutomationList	OK
Other Status Codes	CloudError	Foutreactie die beschrijft waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

List all security automations of a specified resource group

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 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"
          }
        ]
      }
    }
  ]
}

Definities

Name	Description
Automation	De resource voor beveiligingsautomatisering.
AutomationActionEventHub	De doel-Event Hub waarnaar gebeurtenisgegevens worden geëxporteerd. Ga naar https://aka.ms/ASCExportLearnMore voor meer informatie over de mogelijkheden voor continue export van Microsoft Defender for Cloud
AutomationActionLogicApp	De actie van de logische app die moet worden geactiveerd. Ga naar https://aka.ms/ASCWorkflowAutomationLearnMore voor meer informatie over de mogelijkheden van Werkstroomautomatisering van Microsoft Defender for Cloud
AutomationActionWorkspace	De Log Analytics-werkruimte waarnaar gebeurtenisgegevens worden geëxporteerd. Gegevens van beveiligingswaarschuwingen bevinden zich in de tabel SecurityAlert en de evaluatiesgegevens bevinden zich in de tabel SecurityRecommendation (onder de oplossingen 'Security'/'SecurityCenterFree'). Als u de gegevens in de werkruimte wilt weergeven, moet de gratis/standaardoplossing van Security Center Log Analytics zijn ingeschakeld voor die werkruimte. Ga naar https://aka.ms/ASCExportLearnMore voor meer informatie over de mogelijkheden voor continue export van Microsoft Defender for Cloud
AutomationList	Lijst met reactie op beveiligingsautomatiseringen.
AutomationRuleSet	Een regelset die alle regels evalueert op een onderschepping van gebeurtenissen. Alleen wanneer alle opgenomen regels in de regelset worden geëvalueerd als 'true', wordt de gebeurtenis de gedefinieerde acties geactiveerd.
AutomationScope	Eén automatiseringsbereik.
AutomationSource	De bron gebeurtenistypen die de set beveiligingsautomatiseringsregels evalueren. Bijvoorbeeld: beveiligingswaarschuwingen en beveiligingsevaluaties. Ga naar https://aka.ms/ASCAutomationSchemasvoor meer informatie over de ondersteunde schema's voor gegevensmodellen voor beveiligingsgebeurtenissen.
AutomationTriggeringRule	Een regel die wordt geëvalueerd bij het onderscheppen van gebeurtenissen. De regel wordt geconfigureerd door een specifieke waarde van het gebeurtenismodel te vergelijken met een verwachte waarde. Deze vergelijking wordt uitgevoerd met behulp van een van de ondersteunde operatorset.
CloudError	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
CloudErrorBody	De foutdetails.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
EventSource	Een geldig gebeurtenisbrontype.
Operator	Een geldige vergelijkingsoperator die moet worden gebruikt. Er wordt een niet-hoofdlettergevoelige vergelijking toegepast op String PropertyType.
PropertyType	Het gegevenstype van de vergeleken operanden (tekenreeks, geheel getal, drijvendekommanummer of een booleaanse waarde [true/false]]

Automation

De resource voor beveiligingsautomatisering.

Name	Type	Description
etag	string	Entiteitstag wordt gebruikt voor het vergelijken van twee of meer entiteiten uit dezelfde aangevraagde resource.
id	string	Resource-id
kind	string	Soort resource
location	string	Locatie waar de resource is opgeslagen
name	string	Resourcenaam
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Een verzameling acties die worden geactiveerd als alle geconfigureerde regels worden geëvalueerd, binnen ten minste één regelset, waar zijn.
properties.description	string	De beschrijving van beveiligingsautomatisering.
properties.isEnabled	boolean	Geeft aan of de beveiligingsautomatisering is ingeschakeld.
properties.scopes	AutomationScope[]	Een verzameling bereiken waarop de logica voor beveiligingsautomatisering wordt toegepast. Ondersteunde bereiken zijn het abonnement zelf of een resourcegroep onder dat abonnement. De automatisering is alleen van toepassing op gedefinieerde bereiken.
properties.sources	AutomationSource[]	Een verzameling van de bron gebeurtenistypen die de set beveiligingsautomatiseringsregels evalueren.
tags	object	Een lijst met sleutel-waardeparen die de resource beschrijven.
type	string	Resourcetype

AutomationActionEventHub

De doel-Event Hub waarnaar gebeurtenisgegevens worden geëxporteerd. Ga naar https://aka.ms/ASCExportLearnMore voor meer informatie over de mogelijkheden voor continue export van Microsoft Defender for Cloud

Name	Type	Description
actionType	string: EventHub	Het type actie dat wordt geactiveerd door automation
connectionString	string	De Event Hub-doelverbindingsreeks (deze wordt niet opgenomen in een antwoord).
eventHubResourceId	string	De Azure-resource-id van de doel-Event Hub.
isTrustedServiceEnabled	boolean	Geeft aan of de vertrouwde service is ingeschakeld of niet.
sasPolicyName	string	De naam van het SAS-doelbeleid van Event Hub.

AutomationActionLogicApp

De actie van de logische app die moet worden geactiveerd. Ga naar https://aka.ms/ASCWorkflowAutomationLearnMore voor meer informatie over de mogelijkheden van Werkstroomautomatisering van Microsoft Defender for Cloud

Name	Type	Description
actionType	string: LogicApp	Het type actie dat wordt geactiveerd door automation
logicAppResourceId	string	De geactiveerde Azure-resource-id van de logische app. Dit kan zich ook in andere abonnementen bevinden, aangezien u gemachtigd bent om de logische app te activeren
uri	string	Het URI-eindpunt van de logische app-trigger (het wordt niet opgenomen in een antwoord).

AutomationActionWorkspace

De Log Analytics-werkruimte waarnaar gebeurtenisgegevens worden geëxporteerd. Gegevens van beveiligingswaarschuwingen bevinden zich in de tabel SecurityAlert en de evaluatiesgegevens bevinden zich in de tabel SecurityRecommendation (onder de oplossingen 'Security'/'SecurityCenterFree'). Als u de gegevens in de werkruimte wilt weergeven, moet de gratis/standaardoplossing van Security Center Log Analytics zijn ingeschakeld voor die werkruimte. Ga naar https://aka.ms/ASCExportLearnMore voor meer informatie over de mogelijkheden voor continue export van Microsoft Defender for Cloud

Name	Type	Description
actionType	string: Workspace	Het type actie dat wordt geactiveerd door automation
workspaceResourceId	string	De volledig gekwalificeerde Azure-resource-id van de Log Analytics-werkruimte.

AutomationList

Lijst met reactie op beveiligingsautomatiseringen.

Name	Type	Description
nextLink	string	De URI voor het ophalen van de volgende pagina.
value	Automation[]	De lijst met beveiligingsautomatiseringen onder het opgegeven bereik.

AutomationRuleSet

Een regelset die alle regels evalueert op een onderschepping van gebeurtenissen. Alleen wanneer alle opgenomen regels in de regelset worden geëvalueerd als 'true', wordt de gebeurtenis de gedefinieerde acties geactiveerd.

Name	Type	Description
rules	AutomationTriggeringRule[]	Een regel die wordt geëvalueerd bij het onderscheppen van gebeurtenissen. De regel wordt geconfigureerd door een specifieke waarde van het gebeurtenismodel te vergelijken met een verwachte waarde. Deze vergelijking wordt uitgevoerd met behulp van een van de ondersteunde operatorset.

AutomationScope

Eén automatiseringsbereik.

Name	Type	Description
description	string	De beschrijving van het bereik van resources.
scopePath	string	Het pad naar het bereik van resources. Dit kan het abonnement zijn waarop de automatisering is gedefinieerd of een resourcegroep onder dat abonnement (volledig gekwalificeerde Azure-resource-id's).

AutomationSource

De bron gebeurtenistypen die de set beveiligingsautomatiseringsregels evalueren. Bijvoorbeeld: beveiligingswaarschuwingen en beveiligingsevaluaties. Ga naar https://aka.ms/ASCAutomationSchemasvoor meer informatie over de ondersteunde schema's voor gegevensmodellen voor beveiligingsgebeurtenissen.

Name	Type	Description
eventSource	EventSource	Een geldig gebeurtenisbrontype.
ruleSets	AutomationRuleSet[]	Een set regels die evalueren bij het onderscheppen van gebeurtenissen. Er wordt een logische disjunction toegepast tussen gedefinieerde regelsets (logisch 'of').

AutomationTriggeringRule

Een regel die wordt geëvalueerd bij het onderscheppen van gebeurtenissen. De regel wordt geconfigureerd door een specifieke waarde van het gebeurtenismodel te vergelijken met een verwachte waarde. Deze vergelijking wordt uitgevoerd met behulp van een van de ondersteunde operatorset.

Name	Type	Description
expectedValue	string	De verwachte waarde.
operator	Operator	Een geldige vergelijkingsoperator die moet worden gebruikt. Er wordt een niet-hoofdlettergevoelige vergelijking toegepast op String PropertyType.
propertyJPath	string	Het JPath van de eigenschap entiteitsmodel die moet worden gecontroleerd.
propertyType	PropertyType	Het gegevenstype van de vergeleken operanden (tekenreeks, geheel getal, drijvendekommanummer of een booleaanse waarde [true/false]]

CloudError

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name	Type	Description
error.additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
error.code	string	De foutcode.
error.details	CloudErrorBody[]	De foutdetails.
error.message	string	Het foutbericht.
error.target	string	Het foutdoel.

CloudErrorBody

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	CloudErrorBody[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

EventSource

Een geldig gebeurtenisbrontype.

Name	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

Een geldige vergelijkingsoperator die moet worden gebruikt. Er wordt een niet-hoofdlettergevoelige vergelijking toegepast op String PropertyType.

Name	Type	Description
Contains	string	Alleen van toepassing op niet-decimale operanden
EndsWith	string	Alleen van toepassing op niet-decimale operanden
Equals	string	Van toepassing op decimale en niet-decimale operanden
GreaterThan	string	Alleen van toepassing op decimale operanden
GreaterThanOrEqualTo	string	Alleen van toepassing op decimale operanden
LesserThan	string	Alleen van toepassing op decimale operanden
LesserThanOrEqualTo	string	Alleen van toepassing op decimale operanden
NotEquals	string	Van toepassing op decimale en niet-decimale operanden
StartsWith	string	Alleen van toepassing op niet-decimale operanden

PropertyType

Het gegevenstype van de vergeleken operanden (tekenreeks, geheel getal, drijvendekommanummer of een booleaanse waarde [true/false]]

Name	Type	Description
Boolean	string
Integer	string
Number	string
String	string

Delen via

Automations - List By Resource Group

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

List all security automations of a specified resource group

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationList

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Aanvullende resources