Automations - Get

Referens

Tjänst:: Defender for Cloud

API-version:: 2023-12-01-preview

Hämtar information om modellen för en säkerhetsautomatisering.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
automationName	path	True	string	Namnet på säkerhetsautomatiseringen.
resourceGroupName	path	True	string	Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt. Reguljärt uttrycksmönster: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure-prenumerations-ID Reguljärt uttrycksmönster: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	API-version för åtgärden

Svar

Name	Typ	Description
200 OK	Automation	OKEJ
Other Status Codes	CloudError	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Retrieve a security automation

Exempelbegäran

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


/**
 * Samples for Automations GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/
     * GetAutomationResourceGroup_example.json
     */
    /**
     * Sample code: Retrieve a security automation.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void retrieveASecurityAutomation(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.automations().getByResourceGroupWithResponse("exampleResourceGroup", "exampleAutomation",
            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/GetAutomationResourceGroup_example.json
func ExampleAutomationsClient_Get() {
	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)
	}
	res, err := clientFactory.NewAutomationsClient().Get(ctx, "exampleResourceGroup", "exampleAutomation", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Automation = 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 Retrieves information about the model of a security automation.
 *
 * @summary Retrieves information about the model of a security automation.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/GetAutomationResourceGroup_example.json
 */
async function retrieveASecurityAutomation() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "a5caac9c-5c04-49af-b3d0-e204f40345d5";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const automationName = "exampleAutomation";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.automations.get(resourceGroupName, automationName);
  console.log(result);
}

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

Exempelsvar

Statuskod:: 200

{
  "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"
      }
    ]
  }
}

Definitioner

Name	Description
Automation	Resursen för säkerhetsautomatisering.
AutomationActionEventHub	Målhändelsehubben som händelsedata ska exporteras till. Mer information om kontinuerliga exportfunktioner i Microsoft Defender för molnet finns i https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Den logikappsåtgärd som ska utlösas. Mer information om funktionerna i Arbetsflödesautomatisering i Microsoft Defender för molnet finns i https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Log Analytics-arbetsytan som händelsedata ska exporteras till. Data om säkerhetsaviseringar finns i tabellen SecurityAlert och utvärderingsdata finns i tabellen SecurityRecommendation (under lösningarna Security/SecurityCenterFree). Observera att för att kunna visa data på arbetsytan måste den kostnadsfria lösningen i Security Center Log Analytics vara aktiverad på den arbetsytan. Mer information om kontinuerliga exportfunktioner i Microsoft Defender för molnet finns i https://aka.ms/ASCExportLearnMore
AutomationRuleSet	En regeluppsättning som utvärderar alla dess regler vid en händelseavlyssning. Först när alla inkluderade regler i regeluppsättningen utvärderas som "true" utlöser händelsen de definierade åtgärderna.
AutomationScope	Ett enda automatiseringsomfång.
AutomationSource	Källhändelsetyperna som utvärderar säkerhetsautomatiseringsuppsättningen med regler. Till exempel – säkerhetsaviseringar och säkerhetsutvärderingar. Mer information om datamodellscheman för säkerhetshändelser som stöds finns i https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	En regel som utvärderas vid händelseavlyssning. Regeln konfigureras genom att jämföra ett specifikt värde från händelsemodellen med ett förväntat värde. Den här jämförelsen görs med hjälp av en av de operatorer som stöds.
CloudError	Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
CloudErrorBody	Felinformationen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
EventSource	En giltig typ av händelsekälla.
Operator	En giltig jämförelseoperator att använda. En skiftlägeskänslig jämförelse tillämpas för String PropertyType.
PropertyType	Datatypen för de jämförde operanderna (sträng, heltal, flyttalnummer eller ett booleskt [sant/falskt]]

Automation

Resursen för säkerhetsautomatisering.

Name	Typ	Description
etag	string	Entitetstagg används för att jämföra två eller flera entiteter från samma begärda resurs.
id	string	Resurs-ID
kind	string	Typ av resurs
location	string	Plats där resursen lagras
name	string	Resursnamn
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	En samling av de åtgärder som utlöses om alla konfigurerade regelutvärderingar inom minst en regeluppsättning är sanna.
properties.description	string	Beskrivning av säkerhetsautomatisering.
properties.isEnabled	boolean	Anger om säkerhetsautomationen är aktiverad.
properties.scopes	AutomationScope[]	En samling omfång som logiken för säkerhetsautomatiseringar tillämpas på. Omfång som stöds är själva prenumerationen eller en resursgrupp under den prenumerationen. Automatiseringen gäller endast för definierade omfång.
properties.sources	AutomationSource[]	En samling av källhändelsetyperna som utvärderar säkerhetsautomatiseringsuppsättningen med regler.
tags	object	En lista över nyckelvärdepar som beskriver resursen.
type	string	Resurstyp

AutomationActionEventHub

Målhändelsehubben som händelsedata ska exporteras till. Mer information om kontinuerliga exportfunktioner i Microsoft Defender för molnet finns i https://aka.ms/ASCExportLearnMore

Name	Typ	Description
actionType	string: EventHub	Typen av åtgärd som utlöses av Automation
connectionString	string	Händelsehubbens målanslutningssträng (den inkluderas inte i något svar).
eventHubResourceId	string	Målhändelsehubbens Azure-resurs-ID.
isTrustedServiceEnabled	boolean	Anger om den betrodda tjänsten är aktiverad eller inte.
sasPolicyName	string	Sas-principnamnet för målhändelsehubben.

AutomationActionLogicApp

Den logikappsåtgärd som ska utlösas. Mer information om funktionerna i Arbetsflödesautomatisering i Microsoft Defender för molnet finns i https://aka.ms/ASCWorkflowAutomationLearnMore

Name	Typ	Description
actionType	string: LogicApp	Typen av åtgärd som utlöses av Automation
logicAppResourceId	string	Det utlösta Azure-resurs-ID:t för Logic App. Detta kan också finnas i andra prenumerationer, eftersom du har behörighet att utlösa logikappen
uri	string	URI-slutpunkten för Logic App-utlösaren (den inkluderas inte i något svar).

AutomationActionWorkspace

Log Analytics-arbetsytan som händelsedata ska exporteras till. Data om säkerhetsaviseringar finns i tabellen SecurityAlert och utvärderingsdata finns i tabellen SecurityRecommendation (under lösningarna Security/SecurityCenterFree). Observera att för att kunna visa data på arbetsytan måste den kostnadsfria lösningen i Security Center Log Analytics vara aktiverad på den arbetsytan. Mer information om kontinuerliga exportfunktioner i Microsoft Defender för molnet finns i https://aka.ms/ASCExportLearnMore

Name	Typ	Description
actionType	string: Workspace	Typen av åtgärd som utlöses av Automation
workspaceResourceId	string	Det fullständigt kvalificerade Azure-resurs-ID:t för Log Analytics-arbetsytan.

AutomationRuleSet

En regeluppsättning som utvärderar alla dess regler vid en händelseavlyssning. Först när alla inkluderade regler i regeluppsättningen utvärderas som "true" utlöser händelsen de definierade åtgärderna.

Name	Typ	Description
rules	AutomationTriggeringRule[]	En regel som utvärderas vid händelseavlyssning. Regeln konfigureras genom att jämföra ett specifikt värde från händelsemodellen med ett förväntat värde. Den här jämförelsen görs med hjälp av en av de operatorer som stöds.

AutomationScope

Ett enda automatiseringsomfång.

Name	Typ	Description
description	string	Beskrivning av resursomfång.
scopePath	string	Resursomfångssökvägen. Kan vara den prenumeration som automatiseringen definieras på eller en resursgrupp under den prenumerationen (fullständigt kvalificerade Azure-resurs-ID:t).

AutomationSource

Källhändelsetyperna som utvärderar säkerhetsautomatiseringsuppsättningen med regler. Till exempel – säkerhetsaviseringar och säkerhetsutvärderingar. Mer information om datamodellscheman för säkerhetshändelser som stöds finns i https://aka.ms/ASCAutomationSchemas.

Name	Typ	Description
eventSource	EventSource	En giltig typ av händelsekälla.
ruleSets	AutomationRuleSet[]	En uppsättning regler som utvärderas vid händelseavlyssning. En logisk disjunction tillämpas mellan definierade regeluppsättningar (logiska "eller").

AutomationTriggeringRule

En regel som utvärderas vid händelseavlyssning. Regeln konfigureras genom att jämföra ett specifikt värde från händelsemodellen med ett förväntat värde. Den här jämförelsen görs med hjälp av en av de operatorer som stöds.

Name	Typ	Description
expectedValue	string	Det förväntade värdet.
operator	Operator	En giltig jämförelseoperator att använda. En skiftlägeskänslig jämförelse tillämpas för String PropertyType.
propertyJPath	string	JPath för egenskapen entitetsmodell som ska kontrolleras.
propertyType	PropertyType	Datatypen för de jämförde operanderna (sträng, heltal, flyttalnummer eller ett booleskt [sant/falskt]]

CloudError

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
error.code	string	Felkoden.
error.details	CloudErrorBody[]	Felinformationen.
error.message	string	Felmeddelandet.
error.target	string	Felmålet.

CloudErrorBody

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	CloudErrorBody[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

EventSource

En giltig typ av händelsekälla.

Name	Typ	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

En giltig jämförelseoperator att använda. En skiftlägeskänslig jämförelse tillämpas för String PropertyType.

Name	Typ	Description
Contains	string	Gäller endast för operander som inte är decimaler
EndsWith	string	Gäller endast för operander som inte är decimaler
Equals	string	Gäller för decimal- och icke-decimaloperander
GreaterThan	string	Gäller endast för decimaloperor
GreaterThanOrEqualTo	string	Gäller endast för decimaloperor
LesserThan	string	Gäller endast för decimaloperor
LesserThanOrEqualTo	string	Gäller endast för decimaloperor
NotEquals	string	Gäller för decimal- och icke-decimaloperander
StartsWith	string	Gäller endast för operander som inte är decimaler

PropertyType

Datatypen för de jämförde operanderna (sträng, heltal, flyttalnummer eller ett booleskt [sant/falskt]]

Name	Typ	Description
Boolean	string
Integer	string
Number	string
String	string

Dela via

Automations - Get

URI-parametrar

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

Retrieve a security automation

Exempelbegäran

Exempelsvar

Definitioner

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Ytterligare resurser