Automations - Get

Referência

Serviço:: Defender for Cloud

Versão da API:: 2023-12-01-preview

Recupera informações sobre o modelo de uma automação de segurança.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
automationName	path	True	string	O nome da automação de segurança.
resourceGroupName	path	True	string	O nome do grupo de recursos na assinatura do usuário. O nome não diferencia maiúsculas de minúsculas. Padrão Regex: `^[-\w\._]+$`
subscriptionId	path	True	string	ID da assinatura do Azure Padrão Regex: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	Versão da API para a operação

Respostas

Nome	Tipo	Description
200 OK	Automation	OKEY
Other Status Codes	CloudError	Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

Retrieve a security automation

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
      }
    ]
  }
}

Definições

Nome	Description
Automation	O recurso de automação de segurança.
AutomationActionEventHub	O Hub de Eventos de destino para o qual os dados de evento serão exportados. Para saber mais sobre os recursos de exportação contínua do Microsoft Defender para Nuvem, visite https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	A ação do aplicativo lógico que deve ser disparada. Para saber mais sobre os recursos de Automação de Fluxo de Trabalho do Microsoft Defender para Nuvem, visite https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	O Workspace do Log Analytics para o qual os dados de evento serão exportados. Os dados de alertas de segurança residirão na tabela 'SecurityAlert' e os dados de avaliações residirão na tabela 'SecurityRecommendation' (nas soluções 'Security'/'SecurityCenterFree'). Observe que, para exibir os dados no workspace, a solução gratuita/padrão do Log Analytics da Central de Segurança precisa ser habilitada nesse workspace. Para saber mais sobre os recursos de exportação contínua do Microsoft Defender para Nuvem, visite https://aka.ms/ASCExportLearnMore
AutomationRuleSet	Um conjunto de regras que avalia todas as suas regras após uma interceptação de evento. Somente quando todas as regras incluídas no conjunto de regras forem avaliadas como 'true', o evento disparará as ações definidas.
AutomationScope	Um único escopo de automação.
AutomationSource	Os tipos de evento de origem que avaliam o conjunto de regras de automação de segurança. Por exemplo: alertas de segurança e avaliações de segurança. Para saber mais sobre os esquemas de modelos de dados de eventos de segurança com suporte, visite https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Uma regra que é avaliada após a interceptação de eventos. A regra é configurada comparando um valor específico do modelo de evento com um valor esperado. Essa comparação é feita usando um dos operadores com suporte definido.
CloudError	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
CloudErrorBody	O detalhe do erro.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
EventSource	Um tipo de origem de evento válido.
Operator	Um operador comparador válido a ser usado. Uma comparação que não diferencia maiúsculas de minúsculas será aplicada a String PropertyType.
PropertyType	O tipo de dados dos operandos comparados (cadeia de caracteres, inteiro, número de ponto flutuante ou um booliano [true/false]]

Automation

O recurso de automação de segurança.

Nome	Tipo	Description
etag	string	A marca de entidade é usada para comparar duas ou mais entidades do mesmo recurso solicitado.
id	string	ID do recurso
kind	string	Tipo de recurso
location	string	Local onde o recurso é armazenado
name	string	Nome do recurso
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Uma coleção das ações que são disparadas se todas as avaliações de regras configuradas, dentro de pelo menos um conjunto de regras, forem verdadeiras.
properties.description	string	A descrição da automação de segurança.
properties.isEnabled	boolean	Indica se a automação de segurança está habilitada.
properties.scopes	AutomationScope[]	Uma coleção de escopos nos quais a lógica de automações de segurança é aplicada. Os escopos com suporte são a própria assinatura ou um grupo de recursos nessa assinatura. A automação só será aplicada em escopos definidos.
properties.sources	AutomationSource[]	Uma coleção dos tipos de evento de origem que avaliam o conjunto de regras de automação de segurança.
tags	object	Uma lista de pares de valores de chave que descrevem o recurso.
type	string	Tipo de recurso

AutomationActionEventHub

O Hub de Eventos de destino para o qual os dados de evento serão exportados. Para saber mais sobre os recursos de exportação contínua do Microsoft Defender para Nuvem, visite https://aka.ms/ASCExportLearnMore

Nome	Tipo	Description
actionType	string: EventHub	O tipo da ação que será disparada pela Automação
connectionString	string	A cadeia de conexão do Hub de Eventos de destino (ela não será incluída em nenhuma resposta).
eventHubResourceId	string	A ID de Recurso do Azure do Hub de Eventos de destino.
isTrustedServiceEnabled	boolean	Indica se o serviço confiável está habilitado ou não.
sasPolicyName	string	O nome da política SAS do Hub de Eventos de destino.

AutomationActionLogicApp

A ação do aplicativo lógico que deve ser disparada. Para saber mais sobre os recursos de Automação de Fluxo de Trabalho do Microsoft Defender para Nuvem, visite https://aka.ms/ASCWorkflowAutomationLearnMore

Nome	Tipo	Description
actionType	string: LogicApp	O tipo da ação que será disparada pela Automação
logicAppResourceId	string	A ID de Recurso do Azure do Aplicativo Lógico disparada. Isso também pode residir em outras assinaturas, considerando que você tem permissões para disparar o Aplicativo Lógico
uri	string	O ponto de extremidade URI do gatilho do Aplicativo Lógico (ele não será incluído em nenhuma resposta).

AutomationActionWorkspace

O Workspace do Log Analytics para o qual os dados de evento serão exportados. Os dados de alertas de segurança residirão na tabela 'SecurityAlert' e os dados de avaliações residirão na tabela 'SecurityRecommendation' (nas soluções 'Security'/'SecurityCenterFree'). Observe que, para exibir os dados no workspace, a solução gratuita/padrão do Log Analytics da Central de Segurança precisa ser habilitada nesse workspace. Para saber mais sobre os recursos de exportação contínua do Microsoft Defender para Nuvem, visite https://aka.ms/ASCExportLearnMore

Nome	Tipo	Description
actionType	string: Workspace	O tipo da ação que será disparada pela Automação
workspaceResourceId	string	A ID de Recurso do Azure do Workspace do Log Analytics totalmente qualificada.

AutomationRuleSet

Um conjunto de regras que avalia todas as suas regras após uma interceptação de evento. Somente quando todas as regras incluídas no conjunto de regras forem avaliadas como 'true', o evento disparará as ações definidas.

Nome	Tipo	Description
rules	AutomationTriggeringRule[]	Uma regra que é avaliada após a interceptação de eventos. A regra é configurada comparando um valor específico do modelo de evento com um valor esperado. Essa comparação é feita usando um dos operadores com suporte definido.

AutomationScope

Um único escopo de automação.

Nome	Tipo	Description
description	string	A descrição do escopo de recursos.
scopePath	string	O caminho do escopo de recursos. Pode ser a assinatura na qual a automação é definida ou um grupo de recursos nessa assinatura (IDs de recurso do Azure totalmente qualificadas).

AutomationSource

Os tipos de evento de origem que avaliam o conjunto de regras de automação de segurança. Por exemplo: alertas de segurança e avaliações de segurança. Para saber mais sobre os esquemas de modelos de dados de eventos de segurança com suporte, visite https://aka.ms/ASCAutomationSchemas.

Nome	Tipo	Description
eventSource	EventSource	Um tipo de origem de evento válido.
ruleSets	AutomationRuleSet[]	Um conjunto de regras que são avaliadas após a interceptação de eventos. Uma disjunção lógica é aplicada entre conjuntos de regras definidos (lógico 'ou').

AutomationTriggeringRule

Uma regra que é avaliada após a interceptação de eventos. A regra é configurada comparando um valor específico do modelo de evento com um valor esperado. Essa comparação é feita usando um dos operadores com suporte definido.

Nome	Tipo	Description
expectedValue	string	O valor esperado.
operator	Operator	Um operador comparador válido a ser usado. Uma comparação que não diferencia maiúsculas de minúsculas será aplicada a String PropertyType.
propertyJPath	string	O JPath da propriedade do modelo de entidade que deve ser verificada.
propertyType	PropertyType	O tipo de dados dos operandos comparados (cadeia de caracteres, inteiro, número de ponto flutuante ou um booliano [true/false]]

CloudError

Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).

Nome	Tipo	Description
error.additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
error.code	string	O código de erro.
error.details	CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

CloudErrorBody

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	CloudErrorBody[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

EventSource

Um tipo de origem de evento válido.

Nome	Tipo	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

Um operador comparador válido a ser usado. Uma comparação que não diferencia maiúsculas de minúsculas será aplicada a String PropertyType.

Nome	Tipo	Description
Contains	string	Aplica-se somente a operandos não decimais
EndsWith	string	Aplica-se somente a operandos não decimais
Equals	string	Aplica-se a operandos decimal e não decimais
GreaterThan	string	Aplica-se somente a operandos decimais
GreaterThanOrEqualTo	string	Aplica-se somente a operandos decimais
LesserThan	string	Aplica-se somente a operandos decimais
LesserThanOrEqualTo	string	Aplica-se somente a operandos decimais
NotEquals	string	Aplica-se a operandos decimal e não decimais
StartsWith	string	Aplica-se somente a operandos não decimais

PropertyType

O tipo de dados dos operandos comparados (cadeia de caracteres, inteiro, número de ponto flutuante ou um booliano [true/false]]

Nome	Tipo	Description
Boolean	string
Integer	string
Number	string
String	string

Compartilhar via

Automations - Get

Parâmetros de URI

Respostas

Segurança

azure_auth

Escopos

Exemplos

Retrieve a security automation

Solicitação de exemplo

Resposta de exemplo

Definições

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

Recursos adicionais