Automations - Get

Referensi

Service:: Defender for Cloud

API Version:: 2023-12-01-preview

Mengambil informasi tentang model otomatisasi keamanan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
automationName	path	True	string	Nama otomatisasi keamanan.
resourceGroupName	path	True	string	Nama grup sumber daya dalam langganan pengguna. Nama tidak peka huruf besar/kecil. Regex pattern: `^[-\w\._]+$`
subscriptionId	path	True	string	ID langganan Azure Regex pattern: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versi API untuk operasi

Respons

Nama	Jenis	Deskripsi
200 OK	Automation	OK
Other Status Codes	CloudError	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

Retrieve a security automation

Sample Request

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

Sample Response

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

Definisi

Nama	Deskripsi
Automation	Sumber daya otomatisasi keamanan.
AutomationActionEventHub	Pusat Aktivitas target tempat data peristiwa akan diekspor. Untuk mempelajari selengkapnya tentang Microsoft Defender untuk kemampuan ekspor berkelanjutan Cloud, kunjungihttps://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Tindakan aplikasi logika yang harus dipicu. Untuk mempelajari selengkapnya tentang Microsoft Defender kemampuan Automasi Alur Kerja Cloud, kunjungihttps://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Ruang Kerja Analitik Log tempat data peristiwa akan diekspor. Data pemberitahuan keamanan akan berada di tabel 'SecurityAlert' dan data penilaian akan berada di tabel 'SecurityRecommendation' (di bawah solusi 'Security'/'SecurityCenterFree'). Perhatikan bahwa untuk melihat data di ruang kerja, solusi gratis/standar Security Center Log Analytics perlu diaktifkan di ruang kerja tersebut. Untuk mempelajari selengkapnya tentang Microsoft Defender untuk kemampuan ekspor berkelanjutan Cloud, kunjungihttps://aka.ms/ASCExportLearnMore
AutomationRuleSet	Seperangkat aturan yang mengevaluasi semua aturannya pada penyadapan peristiwa. Hanya ketika semua aturan yang disertakan dalam seperangkat aturan akan dievaluasi sebagai 'true', peristiwa akan memicu tindakan yang ditentukan.
AutomationScope	Cakupan otomatisasi tunggal.
AutomationSource	Jenis peristiwa sumber yang mengevaluasi kumpulan aturan otomatisasi keamanan. Misalnya - pemberitahuan keamanan dan penilaian keamanan. Untuk mempelajari selengkapnya tentang skema model data peristiwa keamanan yang didukung - silakan kunjungi https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Aturan yang dievaluasi setelah intersepsi peristiwa. Aturan dikonfigurasi dengan membandingkan nilai tertentu dari model peristiwa dengan nilai yang diharapkan. Perbandingan ini dilakukan dengan menggunakan salah satu operator yang didukung.
CloudError	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
CloudErrorBody	Detail kesalahan.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
EventSource	Jenis sumber peristiwa yang valid.
Operator	Operator pembanding yang valid untuk digunakan. Perbandingan yang tidak peka huruf besar/kecil akan diterapkan untuk String PropertyType.
PropertyType	Jenis data dari operand yang dibandingkan (string, bilangan bulat, angka titik mengambang atau boolean [true/false]]

Automation

Sumber daya otomatisasi keamanan.

Nama	Jenis	Deskripsi
etag	string	Tag entitas digunakan untuk membandingkan dua entitas atau lebih dari sumber daya yang diminta yang sama.
id	string	ID sumber daya
kind	string	Jenis sumber daya
location	string	Lokasi tempat sumber daya disimpan
name	string	Nama sumber daya
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Kumpulan tindakan yang dipicu jika semua evaluasi aturan yang dikonfigurasi, dalam setidaknya satu kumpulan aturan, adalah benar.
properties.description	string	Deskripsi otomatisasi keamanan.
properties.isEnabled	boolean	Menunjukkan apakah otomatisasi keamanan diaktifkan.
properties.scopes	AutomationScope[]	Kumpulan cakupan tempat logika otomatisasi keamanan diterapkan. Cakupan yang didukung adalah langganan itu sendiri atau grup sumber daya di bawah langganan tersebut. Otomatisasi hanya akan berlaku pada cakupan yang ditentukan.
properties.sources	AutomationSource[]	Kumpulan jenis peristiwa sumber yang mengevaluasi kumpulan aturan otomatisasi keamanan.
tags	object	Daftar pasangan nilai kunci yang menjelaskan sumber daya.
type	string	Jenis Sumber Daya

AutomationActionEventHub

Pusat Aktivitas target tempat data peristiwa akan diekspor. Untuk mempelajari selengkapnya tentang Microsoft Defender untuk kemampuan ekspor berkelanjutan Cloud, kunjungihttps://aka.ms/ASCExportLearnMore

Nama	Jenis	Deskripsi
actionType	string: EventHub	Jenis tindakan yang akan dipicu oleh Automation
connectionString	string	Pusat Aktivitas target string koneksi (tidak akan disertakan dalam respons apa pun).
eventHubResourceId	string	Id Sumber Daya Azure Pusat Aktivitas target.
isTrustedServiceEnabled	boolean	Menunjukkan apakah layanan tepercaya diaktifkan atau tidak.
sasPolicyName	string	Nama kebijakan SAS Pusat Aktivitas target.

AutomationActionLogicApp

Tindakan aplikasi logika yang harus dipicu. Untuk mempelajari selengkapnya tentang Microsoft Defender kemampuan Automasi Alur Kerja Cloud, kunjungihttps://aka.ms/ASCWorkflowAutomationLearnMore

Nama	Jenis	Deskripsi
actionType	string: LogicApp	Jenis tindakan yang akan dipicu oleh Automation
logicAppResourceId	string	ID Sumber Daya Azure Logic App yang dipicu. Ini juga dapat berada di langganan lain, mengingat Anda memiliki izin untuk memicu Aplikasi Logika
uri	string	Titik akhir URI pemicu Aplikasi Logika (tidak akan disertakan dalam respons apa pun).

AutomationActionWorkspace

Ruang Kerja Analitik Log tempat data peristiwa akan diekspor. Data pemberitahuan keamanan akan berada di tabel 'SecurityAlert' dan data penilaian akan berada di tabel 'SecurityRecommendation' (di bawah solusi 'Security'/'SecurityCenterFree'). Perhatikan bahwa untuk melihat data di ruang kerja, solusi gratis/standar Security Center Log Analytics perlu diaktifkan di ruang kerja tersebut. Untuk mempelajari selengkapnya tentang Microsoft Defender untuk kemampuan ekspor berkelanjutan Cloud, kunjungihttps://aka.ms/ASCExportLearnMore

Nama	Jenis	Deskripsi
actionType	string: Workspace	Jenis tindakan yang akan dipicu oleh Automation
workspaceResourceId	string	ID Sumber Daya Azure Ruang Kerja Analitik Log yang sepenuhnya memenuhi syarat.

AutomationRuleSet

Seperangkat aturan yang mengevaluasi semua aturannya pada penyadapan peristiwa. Hanya ketika semua aturan yang disertakan dalam seperangkat aturan akan dievaluasi sebagai 'true', peristiwa akan memicu tindakan yang ditentukan.

Nama	Jenis	Deskripsi
rules	AutomationTriggeringRule[]	Aturan yang dievaluasi setelah intersepsi peristiwa. Aturan dikonfigurasi dengan membandingkan nilai tertentu dari model peristiwa dengan nilai yang diharapkan. Perbandingan ini dilakukan dengan menggunakan salah satu operator yang didukung.

AutomationScope

Cakupan otomatisasi tunggal.

Nama	Jenis	Deskripsi
description	string	Deskripsi cakupan sumber daya.
scopePath	string	Jalur cakupan sumber daya. Dapat menjadi langganan tempat otomatisasi ditentukan pada atau grup sumber daya di bawah langganan tersebut (ID sumber daya Azure yang sepenuhnya memenuhi syarat).

AutomationSource

Jenis peristiwa sumber yang mengevaluasi kumpulan aturan otomatisasi keamanan. Misalnya - pemberitahuan keamanan dan penilaian keamanan. Untuk mempelajari selengkapnya tentang skema model data peristiwa keamanan yang didukung - silakan kunjungi https://aka.ms/ASCAutomationSchemas.

Nama	Jenis	Deskripsi
eventSource	EventSource	Jenis sumber peristiwa yang valid.
ruleSets	AutomationRuleSet[]	Seperangkat aturan yang mengevaluasi pada penyadapan peristiwa. Disjunction logis diterapkan antara seperangkat aturan yang ditentukan (logis 'atau').

AutomationTriggeringRule

Aturan yang dievaluasi setelah intersepsi peristiwa. Aturan dikonfigurasi dengan membandingkan nilai tertentu dari model peristiwa dengan nilai yang diharapkan. Perbandingan ini dilakukan dengan menggunakan salah satu operator yang didukung.

Nama	Jenis	Deskripsi
expectedValue	string	Nilai yang diharapkan.
operator	Operator	Operator pembanding yang valid untuk digunakan. Perbandingan yang tidak peka huruf besar/kecil akan diterapkan untuk String PropertyType.
propertyJPath	string	JPath properti model entitas yang harus diperiksa.
propertyType	PropertyType	Jenis data dari operand yang dibandingkan (string, bilangan bulat, angka titik mengambang atau boolean [true/false]]

CloudError

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error.additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
error.code	string	Kode kesalahan.
error.details	CloudErrorBody[]	Detail kesalahan.
error.message	string	Pesan kesalahan.
error.target	string	Target kesalahan.

CloudErrorBody

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	CloudErrorBody[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorAdditionalInfo

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

EventSource

Jenis sumber peristiwa yang valid.

Nama	Jenis	Deskripsi
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

Operator pembanding yang valid untuk digunakan. Perbandingan yang tidak peka huruf besar/kecil akan diterapkan untuk String PropertyType.

Nama	Jenis	Deskripsi
Contains	string	Hanya berlaku untuk operand non-desimal
EndsWith	string	Hanya berlaku untuk operand non-desimal
Equals	string	Berlaku untuk operand desimal dan non-desimal
GreaterThan	string	Hanya berlaku untuk operand desimal
GreaterThanOrEqualTo	string	Hanya berlaku untuk operand desimal
LesserThan	string	Hanya berlaku untuk operand desimal
LesserThanOrEqualTo	string	Hanya berlaku untuk operand desimal
NotEquals	string	Berlaku untuk operand desimal dan non-desimal
StartsWith	string	Hanya berlaku untuk operand non-desimal

PropertyType

Jenis data dari operand yang dibandingkan (string, bilangan bulat, angka titik mengambang atau boolean [true/false]]

Nama	Jenis	Deskripsi
Boolean	string
Integer	string
Number	string
String	string

Bagikan melalui

Automations - Get

Parameter URI

Respons

Keamanan

azure_auth

Scopes

Contoh

Retrieve a security automation

Sample Request

Sample Response

Definisi

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Sumber Daya Tambahan: