Automations - Update

Serviço:: Defender for Cloud

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

Atualiza uma automação de segurança

PATCH 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 minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

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

Respostas

Nome	Tipo	Description
200 OK	Automation	A operação do Azure foi concluída com êxito.
Other Status Codes	Common.CloudError	Uma resposta de erro inesperada.

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

Update a security automation

Solicitação de exemplo

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

{
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "actions": [
      {
        "actionType": "LogicApp",
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "uri": "https://exampleTriggerUri1.com"
      }
    ],
    "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"
      }
    ]
  },
  "tags": {
    "Example": "exampleTag"
  }
}

package armsecurity_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)

// Generated from example definition: 2023-12-01-preview/Automations/PatchAutomation_example.json
func ExampleAutomationsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armsecurity.NewClientFactory("a5caac9c-5c04-49af-b3d0-e204f40345d5", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAutomationsClient().Update(ctx, "exampleResourceGroup", "exampleAutomation", armsecurity.AutomationUpdateModel{
		Properties: &armsecurity.AutomationProperties{
			Description: to.Ptr("An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment"),
			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"),
					URI:                to.Ptr("https://exampleTriggerUri1.com"),
				},
			},
			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),
				},
			},
		},
		Tags: map[string]*string{
			"Example": to.Ptr("exampleTag"),
		},
	}, 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 = armsecurity.AutomationsClientUpdateResponse{
	// 	Automation: armsecurity.Automation{
	// 		Name: to.Ptr("exampleAutomation"),
	// 		Type: to.Ptr("Microsoft.Security/automations"),
	// 		Etag: to.Ptr("new etag value"),
	// 		ID: to.Ptr("/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation"),
	// 		Location: to.Ptr("Central US"),
	// 		Properties: &armsecurity.AutomationProperties{
	// 			Description: to.Ptr("An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment"),
	// 			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{
	// 					},
	// 				},
	// 			},
	// 		},
	// 		Tags: map[string]*string{
	// 		},
	// 	},
	// }
}

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 updates a security automation
 *
 * @summary updates a security automation
 * x-ms-original-file: 2023-12-01-preview/Automations/PatchAutomation_example.json
 */
async function updateASecurityAutomation() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "a5caac9c-5c04-49af-b3d0-e204f40345d5";
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.automations.update("exampleResourceGroup", "exampleAutomation", {
    description:
      "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    actions: [
      {
        actionType: "LogicApp",
        logicAppResourceId:
          "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        uri: "https://exampleTriggerUri1.com",
      },
    ],
    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" }],
    tags: { Example: "exampleTag" },
  });
  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

{
  "name": "exampleAutomation",
  "type": "Microsoft.Security/automations",
  "etag": "new etag value",
  "id": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation",
  "location": "Central US",
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "actions": [
      {
        "actionType": "LogicApp",
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1"
      }
    ],
    "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": []
      }
    ]
  },
  "tags": {}
}

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.
AutomationUpdateModel	O modelo de atualização do recurso de automação de segurança.
Common.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.).
Common.CloudErrorBody	O detalhe do erro.
createdByType	O tipo de identidade que criou o recurso.
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]]
systemData	Metadados relativos à criação e última modificação do recurso.

Automation

Objeto

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 (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kind	string	Tipo de recurso
location	string	A localização geográfica onde o recurso reside
name	string	O 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.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
tags	object	Tags de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AutomationActionEventHub

Objeto

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

Objeto

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 (uri)	O ponto de extremidade URI do gatilho do Aplicativo Lógico (ele não será incluído em nenhuma resposta).

AutomationActionWorkspace

Objeto

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

Objeto

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

Objeto

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

Objeto

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

Objeto

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]]

AutomationUpdateModel

Objeto

O modelo de atualização do recurso de automação de segurança.

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

Common.CloudError

Objeto

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	Common.CloudErrorBody[]	Os detalhes do erro.
error.message	string	A mensagem de erro.
error.target	string	O destino do erro.

Common.CloudErrorBody

Objeto

O detalhe do erro.

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

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorAdditionalInfo

Objeto

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

Enumeração

Um tipo de origem de evento válido.

Valor	Description
Assessments	Assessments
AssessmentsSnapshot	AvaliaçõesSnapshot
SubAssessments	Subavaliações
SubAssessmentsSnapshot	SubAvaliaçõesSnapshot
Alerts	Alerts
SecureScores	SecureScores
SecureScoresSnapshot	SecureScoresSnapshot
SecureScoreControls	SecureScoreControls
SecureScoreControlsSnapshot	SecureScoreControlsSnapshot
RegulatoryComplianceAssessment	Avaliação de Conformidade Regulatória
RegulatoryComplianceAssessmentSnapshot	Avaliação de Conformidade RegulatóriaPanorâmico
AttackPaths	CaminhosDeAtaque
AttackPathsSnapshot	SnapshotCaminhosAtaqueInstantâneo

Operator

Enumeração

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.

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

PropertyType

Enumeração

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

Valor	Description
String	String
Integer	Número inteiro
Number	Número
Boolean	booleano

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.