Automations - Get

Odwołanie

Usługa:: Defender for Cloud

Wersja interfejsu API:: 2023-12-01-preview

Pobiera informacje o modelu automatyzacji zabezpieczeń.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
automationName	path	True	string	Nazwa automatyzacji zabezpieczeń.
resourceGroupName	path	True	string	Nazwa grupy zasobów w ramach subskrypcji użytkownika. Nazwa jest niewrażliwa na wielkość liter. Wzorzec wyrażenia regularnego: `^[-\w\._]+$`
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure Wzorzec wyrażenia regularnego: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Wersja interfejsu API dla operacji

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Automation	OK
Other Status Codes	CloudError	Odpowiedź na błąd, która opisuje, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Retrieve a security automation

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa	Opis
Automation	Zasób automatyzacji zabezpieczeń.
AutomationActionEventHub	Docelowe centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzenia. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Akcja aplikacji logiki, która powinna zostać wyzwolona. Aby dowiedzieć się więcej o możliwościach automatyzacji przepływu pracy usługi Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Obszar roboczy usługi Log Analytics, do którego zostaną wyeksportowane dane zdarzenia. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w obszarze rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że aby wyświetlić dane w obszarze roboczym, należy włączyć bezpłatne/standardowe rozwiązanie usługi Security Center Log Analytics w tym obszarze roboczym. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore
AutomationRuleSet	Zestaw reguł, który ocenia wszystkie jego reguły podczas przechwytywania zdarzeń. Tylko wtedy, gdy wszystkie dołączone reguły w zestawie reguł zostaną ocenione jako "true", zdarzenie wyzwoli zdefiniowane akcje.
AutomationScope	Pojedynczy zakres automatyzacji.
AutomationSource	Typy zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń. Na przykład — alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej o obsługiwanych schematach modeli danych zdarzeń zabezpieczeń — odwiedź https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.
CloudError	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
EventSource	Prawidłowy typ źródła zdarzeń.
Operator	Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.
PropertyType	Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

Automation

Zasób automatyzacji zabezpieczeń.

Nazwa	Typ	Opis
etag	string	Tag jednostki służy do porównywania co najmniej dwóch jednostek z tego samego żądanego zasobu.
id	string	Identyfikator zasobu
kind	string	Rodzaj zasobu
location	string	Lokalizacja, w której jest przechowywany zasób
name	string	Nazwa zasobu
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Kolekcja akcji, które są wyzwalane, jeśli wszystkie skonfigurowane reguły oceny, w co najmniej jednym zestawie reguł, są prawdziwe.
properties.description	string	Opis automatyzacji zabezpieczeń.
properties.isEnabled	boolean	Wskazuje, czy automatyzacja zabezpieczeń jest włączona.
properties.scopes	AutomationScope[]	Kolekcja zakresów, w których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie stosowana tylko w zdefiniowanych zakresach.
properties.sources	AutomationSource[]	Kolekcja typów zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń.
tags	object	Lista par klucz-wartość, które opisują zasób.
type	string	Typ zasobu

AutomationActionEventHub

Docelowe centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzenia. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore

Nazwa	Typ	Opis
actionType	string: EventHub	Typ akcji, która zostanie wyzwolona przez usługę Automation
connectionString	string	Docelowe parametry połączenia centrum zdarzeń (nie zostaną uwzględnione w żadnej odpowiedzi).
eventHubResourceId	string	Docelowy identyfikator zasobu platformy Azure centrum zdarzeń.
isTrustedServiceEnabled	boolean	Wskazuje, czy zaufana usługa jest włączona, czy nie.
sasPolicyName	string	Docelowa nazwa zasad sygnatury dostępu współdzielonego centrum zdarzeń.

AutomationActionLogicApp

Akcja aplikacji logiki, która powinna zostać wyzwolona. Aby dowiedzieć się więcej o możliwościach automatyzacji przepływu pracy usługi Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCWorkflowAutomationLearnMore

Nazwa	Typ	Opis
actionType	string: LogicApp	Typ akcji, która zostanie wyzwolona przez usługę Automation
logicAppResourceId	string	Wyzwolony identyfikator zasobu platformy Azure aplikacji logiki. Może to również znajdować się w innych subskrypcjach, ponieważ masz uprawnienia do wyzwalania aplikacji logiki
uri	string	Punkt końcowy identyfikatora URI wyzwalacza aplikacji logiki (nie zostanie on uwzględniony w żadnej odpowiedzi).

AutomationActionWorkspace

Obszar roboczy usługi Log Analytics, do którego zostaną wyeksportowane dane zdarzenia. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w obszarze rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że aby wyświetlić dane w obszarze roboczym, należy włączyć bezpłatne/standardowe rozwiązanie usługi Security Center Log Analytics w tym obszarze roboczym. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore

Nazwa	Typ	Opis
actionType	string: Workspace	Typ akcji, która zostanie wyzwolona przez usługę Automation
workspaceResourceId	string	W pełni kwalifikowany identyfikator zasobu platformy Azure obszaru roboczego usługi Log Analytics.

AutomationRuleSet

Zestaw reguł, który ocenia wszystkie jego reguły podczas przechwytywania zdarzeń. Tylko wtedy, gdy wszystkie dołączone reguły w zestawie reguł zostaną ocenione jako "true", zdarzenie wyzwoli zdefiniowane akcje.

Nazwa	Typ	Opis
rules	AutomationTriggeringRule[]	Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.

AutomationScope

Pojedynczy zakres automatyzacji.

Nazwa	Typ	Opis
description	string	Opis zakresu zasobów.
scopePath	string	Ścieżka zakresu zasobów. Może to być subskrypcja, w której zdefiniowano automatyzację w ramach tej subskrypcji lub grupę zasobów (w pełni kwalifikowane identyfikatory zasobów platformy Azure).

AutomationSource

Typy zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń. Na przykład — alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej o obsługiwanych schematach modeli danych zdarzeń zabezpieczeń — odwiedź https://aka.ms/ASCAutomationSchemas.

Nazwa	Typ	Opis
eventSource	EventSource	Prawidłowy typ źródła zdarzeń.
ruleSets	AutomationRuleSet[]	Zestaw reguł, które oceniają przechwycenie zdarzeń. Logiczny podział jest stosowany między zdefiniowanymi zestawami reguł (logicznymi "lub").

AutomationTriggeringRule

Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.

Nazwa	Typ	Opis
expectedValue	string	Oczekiwana wartość.
operator	Operator	Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.
propertyJPath	string	Ścieżka JPath właściwości modelu jednostki, która powinna być zaznaczona.
propertyType	PropertyType	Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

CloudError

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

EventSource

Prawidłowy typ źródła zdarzeń.

Nazwa	Typ	Opis
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

Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.

Nazwa	Typ	Opis
Contains	string	Dotyczy tylko operandów innych niż dziesiętne
EndsWith	string	Dotyczy tylko operandów innych niż dziesiętne
Equals	string	Dotyczy operandów dziesiętnych i innych niż dziesiętne
GreaterThan	string	Dotyczy tylko operandów dziesiętnych
GreaterThanOrEqualTo	string	Dotyczy tylko operandów dziesiętnych
LesserThan	string	Dotyczy tylko operandów dziesiętnych
LesserThanOrEqualTo	string	Dotyczy tylko operandów dziesiętnych
NotEquals	string	Dotyczy operandów dziesiętnych i innych niż dziesiętne
StartsWith	string	Dotyczy tylko operandów innych niż dziesiętne

PropertyType

Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

Nazwa	Typ	Opis
Boolean	string
Integer	string
Number	string
String	string

Udostępnij za pośrednictwem

Automations - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

Retrieve a security automation

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Dodatkowe zasoby