Automations - Get

Reference

Služba:: Defender for Cloud

Verze rozhraní API:: 2023-12-01-preview

Načte informace o modelu automatizace zabezpečení.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
automationName	path	True	string	Název automatizace zabezpečení.
resourceGroupName	path	True	string	Název skupiny prostředků v rámci předplatného uživatele. Název nerozlišuje malá a velká písmena. Vzor regulárního výrazu: `^[-\w\._]+$`
subscriptionId	path	True	string	ID předplatného Azure Vzor regulárního výrazu: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Verze rozhraní API pro operaci

Odpovědi

Name	Typ	Description
200 OK	Automation	OK
Other Status Codes	CloudError	Chybová odpověď, která popisuje, proč operace selhala.

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

Retrieve a security automation

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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"
      }
    ]
  }
}

Definice

Name	Description
Automation	Prostředek automatizace zabezpečení.
AutomationActionEventHub	Cílové centrum událostí, do kterého se budou exportovat data událostí. Další informace o možnostech průběžného exportu v programu Microsoft Defender pro cloud najdete v https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Akce aplikace logiky, která by se měla aktivovat. Další informace o možnostech automatizace pracovních postupů v programu Microsoft Defender for Cloud najdete v https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Pracovní prostor služby Log Analytics, do kterého se budou exportovat data událostí. Data výstrah zabezpečení se budou nacházet v tabulce SecurityAlert a data posouzení se budou nacházet v tabulce SecurityRecommendation (v rámci řešení Security/SecurityCenterFree). Upozorňujeme, že aby bylo možné zobrazit data v pracovním prostoru, musí být v daném pracovním prostoru povolené bezplatné nebo standardní řešení služby Security Center Log Analytics. Další informace o možnostech průběžného exportu v programu Microsoft Defender pro cloud najdete v https://aka.ms/ASCExportLearnMore
AutomationRuleSet	Sada pravidel, která vyhodnocuje všechna pravidla při zachycení události. Pouze když se všechna zahrnutá pravidla v sadě pravidel vyhodnotí jako true, aktivuje událost definované akce.
AutomationScope	Jeden obor automatizace.
AutomationSource	Typy zdrojových událostí, které vyhodnocují sadu pravidel automatizace zabezpečení. Například výstrahy zabezpečení a posouzení zabezpečení. Další informace o schématech datových modelů podporovaných událostí zabezpečení najdete v tématu https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Pravidlo, které se vyhodnocuje při zachycení události. Pravidlo se konfiguruje porovnáním konkrétní hodnoty z modelu událostí s očekávanou hodnotou. Toto porovnání se provádí pomocí některé ze sady podporovaných operátorů.
CloudError	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)
CloudErrorBody	Podrobnosti o chybě.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
EventSource	Platný typ zdroje událostí.
Operator	Platný operátor porovnávače, který se má použít. Pro String PropertyType se použije porovnání bez rozlišování velkých a malých písmen.
PropertyType	Datový typ porovnávaných operandů (řetězec, celé číslo, číslo s plovoucí desetinnou čárkou nebo logická hodnota [true/false]]

Automation

Prostředek automatizace zabezpečení.

Name	Typ	Description
etag	string	Značka entity se používá k porovnání dvou nebo více entit ze stejného požadovaného prostředku.
id	string	ID prostředku
kind	string	Druh prostředku
location	string	Umístění, kde je prostředek uložený
name	string	Název prostředku
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Kolekce akcí, které se aktivují, pokud jsou splněná všechna nakonfigurovaná vyhodnocení pravidel v rámci alespoň jedné sady pravidel.
properties.description	string	Popis automatizace zabezpečení.
properties.isEnabled	boolean	Určuje, jestli je povolená automatizace zabezpečení.
properties.scopes	AutomationScope[]	Kolekce oborů, na kterých se používá logika automatizace zabezpečení. Podporované obory jsou samotné předplatné nebo skupina prostředků v rámci tohoto předplatného. Automatizace se použije jenom u definovaných oborů.
properties.sources	AutomationSource[]	Kolekce typů zdrojových událostí, které vyhodnocují sadu pravidel automatizace zabezpečení.
tags	object	Seznam párů klíč-hodnota, které popisují prostředek.
type	string	Typ prostředku

AutomationActionEventHub

Cílové centrum událostí, do kterého se budou exportovat data událostí. Další informace o možnostech průběžného exportu v programu Microsoft Defender pro cloud najdete v https://aka.ms/ASCExportLearnMore

Name	Typ	Description
actionType	string: EventHub	Typ akce, která se aktivuje službou Automation
connectionString	string	Připojovací řetězec cílového centra událostí (nebude zahrnut do žádné odpovědi).
eventHubResourceId	string	ID prostředku Azure cílového centra událostí.
isTrustedServiceEnabled	boolean	Určuje, jestli je důvěryhodná služba povolená nebo ne.
sasPolicyName	string	Název zásady SAS cílového centra událostí.

AutomationActionLogicApp

Akce aplikace logiky, která by se měla aktivovat. Další informace o možnostech automatizace pracovních postupů v programu Microsoft Defender for Cloud najdete v https://aka.ms/ASCWorkflowAutomationLearnMore

Name	Typ	Description
actionType	string: LogicApp	Typ akce, která se aktivuje službou Automation
logicAppResourceId	string	ID aktivované aplikace logiky Azure Resource ID. Může se také nacházet v jiných předplatných, protože máte oprávnění k aktivaci aplikace logiky.
uri	string	Koncový bod URI triggeru aplikace logiky (nezahrne se do žádné odpovědi).

AutomationActionWorkspace

Pracovní prostor služby Log Analytics, do kterého se budou exportovat data událostí. Data výstrah zabezpečení se budou nacházet v tabulce SecurityAlert a data posouzení se budou nacházet v tabulce SecurityRecommendation (v rámci řešení Security/SecurityCenterFree). Upozorňujeme, že aby bylo možné zobrazit data v pracovním prostoru, musí být v daném pracovním prostoru povolené bezplatné nebo standardní řešení služby Security Center Log Analytics. Další informace o možnostech průběžného exportu v programu Microsoft Defender pro cloud najdete v https://aka.ms/ASCExportLearnMore

Name	Typ	Description
actionType	string: Workspace	Typ akce, která se aktivuje službou Automation
workspaceResourceId	string	Plně kvalifikované ID prostředku Azure pracovního prostoru služby Log Analytics.

AutomationRuleSet

Sada pravidel, která vyhodnocuje všechna pravidla při zachycení události. Pouze když se všechna zahrnutá pravidla v sadě pravidel vyhodnotí jako true, aktivuje událost definované akce.

Name	Typ	Description
rules	AutomationTriggeringRule[]	Pravidlo, které se vyhodnocuje při zachycení události. Pravidlo se konfiguruje porovnáním konkrétní hodnoty z modelu událostí s očekávanou hodnotou. Toto porovnání se provádí pomocí některé ze sady podporovaných operátorů.

AutomationScope

Jeden obor automatizace.

Name	Typ	Description
description	string	Popis oboru prostředků.
scopePath	string	Cesta oboru prostředků. Může to být předplatné, ve kterém je automatizace definovaná, nebo skupinu prostředků v rámci daného předplatného (plně kvalifikované ID prostředků Azure).

AutomationSource

Typy zdrojových událostí, které vyhodnocují sadu pravidel automatizace zabezpečení. Například výstrahy zabezpečení a posouzení zabezpečení. Další informace o schématech datových modelů podporovaných událostí zabezpečení najdete v tématu https://aka.ms/ASCAutomationSchemas.

Name	Typ	Description
eventSource	EventSource	Platný typ zdroje událostí.
ruleSets	AutomationRuleSet[]	Sada pravidel, která se vyhodnocují při zachycení události. Logická disjunkce se použije mezi definovanými sadami pravidel (logická "nebo").

AutomationTriggeringRule

Pravidlo, které se vyhodnocuje při zachycení události. Pravidlo se konfiguruje porovnáním konkrétní hodnoty z modelu událostí s očekávanou hodnotou. Toto porovnání se provádí pomocí některé ze sady podporovaných operátorů.

Name	Typ	Description
expectedValue	string	Očekávaná hodnota.
operator	Operator	Platný operátor porovnávače, který se má použít. Pro String PropertyType se použije porovnání bez rozlišování velkých a malých písmen.
propertyJPath	string	JPath vlastnosti modelu entity, která by měla být kontrolována.
propertyType	PropertyType	Datový typ porovnávaných operandů (řetězec, celé číslo, číslo s plovoucí desetinnou čárkou nebo logická hodnota [true/false]]

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name	Typ	Description
error.additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
error.code	string	Kód chyby.
error.details	CloudErrorBody[]	Podrobnosti o chybě.
error.message	string	Chybová zpráva.
error.target	string	Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	CloudErrorBody[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

EventSource

Platný typ zdroje událostí.

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

Platný operátor porovnávače, který se má použít. Pro String PropertyType se použije porovnání bez rozlišování velkých a malých písmen.

Name	Typ	Description
Contains	string	Platí pouze pro operandy bez desetinných míst.
EndsWith	string	Platí pouze pro operandy bez desetinných míst.
Equals	string	Platí pro desetinné a ne desetinné operandy.
GreaterThan	string	Platí pouze pro desetinné operandy.
GreaterThanOrEqualTo	string	Platí pouze pro desetinné operandy.
LesserThan	string	Platí pouze pro desetinné operandy.
LesserThanOrEqualTo	string	Platí pouze pro desetinné operandy.
NotEquals	string	Platí pro desetinné a ne desetinné operandy.
StartsWith	string	Platí pouze pro operandy bez desetinných míst.

PropertyType

Datový typ porovnávaných operandů (řetězec, celé číslo, číslo s plovoucí desetinnou čárkou nebo logická hodnota [true/false]]

Name	Typ	Description
Boolean	string
Integer	string
Number	string
String	string

Sdílet prostřednictvím

Automations - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

Retrieve a security automation

Ukázkový požadavek

Ukázková odpověď

Definice

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Další materiály