Automations - Validate

參考

服務:: Defender for Cloud

API 版本:: 2023-12-01-preview

先驗證安全性自動化模型，再建立或更新。任何驗證錯誤會傳回給用戶端。

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

URI 參數

名稱	位於	必要	類型	Description
automationName	path	True	string	安全性自動化名稱。
resourceGroupName	path	True	string	用戶訂用帳戶內的資源組名。名稱不區分大小寫。 Regex 模式: `^[-\w\._]+$`
subscriptionId	path	True	string	Azure 訂用帳戶標識碼 Regex 模式: `^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$`
api-version	query	True	string	作業的 API 版本

要求本文

名稱	類型	Description
etag	string	實體標籤用於比較來自相同要求資源的兩個或多個實體。
kind	string	資源的種類
location	string	儲存資源的位置
properties.actions	AutomationAction[]: AutomationActionLogicApp[] AutomationActionEventHub[] AutomationActionWorkspace[]	如果所有已設定的規則評估至少在一個規則集中，就會觸發的動作集合為 true。
properties.description	string	安全性自動化描述。
properties.isEnabled	boolean	指出是否啟用安全性自動化。
properties.scopes	AutomationScope[]	套用安全性自動化邏輯的範圍集合。支援的範圍是訂用帳戶本身或該訂用帳戶下的資源群組。自動化只會套用至定義的範圍。
properties.sources	AutomationSource[]	評估規則安全性自動化集之來源事件類型的集合。
tags	object	描述資源的索引鍵值組清單。

回應

名稱	類型	Description
200 OK	AutomationValidationStatus	還行
Other Status Codes	CloudError	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Validate the security automation model before create or update

範例要求

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

{
  "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",
        "uri": "https://exampleTriggerUri1.com"
      }
    ]
  }
}


import com.azure.resourcemanager.security.fluent.models.AutomationInner;
import com.azure.resourcemanager.security.models.AutomationActionLogicApp;
import com.azure.resourcemanager.security.models.AutomationRuleSet;
import com.azure.resourcemanager.security.models.AutomationScope;
import com.azure.resourcemanager.security.models.AutomationSource;
import com.azure.resourcemanager.security.models.AutomationTriggeringRule;
import com.azure.resourcemanager.security.models.EventSource;
import com.azure.resourcemanager.security.models.Operator;
import com.azure.resourcemanager.security.models.PropertyType;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Automations Validate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/
     * ValidateAutomation_example.json
     */
    /**
     * Sample code: Validate the security automation model before create or update.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void validateTheSecurityAutomationModelBeforeCreateOrUpdate(
        com.azure.resourcemanager.security.SecurityManager manager) {
        manager.automations().validateWithResponse("exampleResourceGroup", "exampleAutomation", new AutomationInner()
            .withLocation("Central US").withTags(mapOf())
            .withDescription(
                "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment")
            .withIsEnabled(true)
            .withScopes(Arrays.asList(new AutomationScope().withDescription(
                "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")
                .withScopePath("/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup")))
            .withSources(Arrays.asList(new AutomationSource().withEventSource(EventSource.ASSESSMENTS).withRuleSets(
                Arrays.asList(new AutomationRuleSet().withRules(Arrays.asList(new AutomationTriggeringRule()
                    .withPropertyJPath("$.Entity.AssessmentType").withPropertyType(PropertyType.STRING)
                    .withExpectedValue("customAssessment").withOperator(Operator.EQUALS)))))))
            .withActions(Arrays.asList(new AutomationActionLogicApp().withLogicAppResourceId(
                "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1")
                .withUri("https://exampleTriggerUri1.com"))),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

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/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: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/ValidateAutomation_example.json
func ExampleAutomationsClient_Validate() {
	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().Validate(ctx, "exampleResourceGroup", "exampleAutomation", armsecurity.Automation{
		Location: to.Ptr("Central US"),
		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"),
					URI:                to.Ptr("https://exampleTriggerUri1.com"),
				}},
			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),
								}},
						}},
				}},
		},
	}, 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.AutomationValidationStatus = armsecurity.AutomationValidationStatus{
	// 	IsValid: to.Ptr(true),
	// 	Message: to.Ptr("Validation Successful"),
	// }
}

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 Validates the security automation model before create or update. Any validation errors are returned to the client.
 *
 * @summary Validates the security automation model before create or update. Any validation errors are returned to the client.
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/ValidateAutomation_example.json
 */
async function validateTheSecurityAutomationModelBeforeCreateOrUpdate() {
  const subscriptionId =
    process.env["SECURITY_SUBSCRIPTION_ID"] || "a5caac9c-5c04-49af-b3d0-e204f40345d5";
  const resourceGroupName = process.env["SECURITY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const automationName = "exampleAutomation";
  const automation = {
    description:
      "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment",
    actions: [
      {
        actionType: "LogicApp",
        logicAppResourceId:
          "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        uri: "https://exampleTriggerUri1.com",
      },
    ],
    isEnabled: true,
    location: "Central US",
    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: [
              {
                expectedValue: "customAssessment",
                operator: "Equals",
                propertyJPath: "$.Entity.AssessmentType",
                propertyType: "String",
              },
            ],
          },
        ],
      },
    ],
    tags: {},
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.automations.validate(resourceGroupName, automationName, automation);
  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

範例回覆

狀態碼:: 200

{
  "isValid": true,
  "message": "Validation Successful"
}

定義

名稱	Description
Automation	安全性自動化資源。
AutomationActionEventHub	將匯出事件數據的目標事件中樞。若要深入瞭解適用於雲端的Defender持續匯出功能Microsoft，請流覽 https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	應該觸發的邏輯應用程式動作。若要深入瞭解適用於雲端的Defender工作流程自動化功能Microsoft，請流覽 https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	將匯出事件數據的Log Analytics工作區。安全性警示數據會位於『SecurityAlert』資料表中，而評量數據會位於『SecurityRecommendation』資料表中（在 'Security'/'SecurityCenterFree' 解決方案下）。請注意，若要檢視工作區中的數據，必須在該工作區上啟用資訊安全中心 Log Analytics 免費/標準解決方案。若要深入瞭解適用於雲端的Defender持續匯出功能Microsoft，請流覽 https://aka.ms/ASCExportLearnMore
AutomationRuleSet	在事件攔截時評估其所有規則的規則集。只有當規則集中的所有包含規則都會評估為『true』時，事件才會觸發已定義的動作。
AutomationScope	單一自動化範圍。
AutomationSource	評估規則安全性自動化集合的來源事件類型。例如 - 安全性警示和安全性評定。若要深入瞭解支援的安全性事件資料模型架構 - 請瀏覽 https://aka.ms/ASCAutomationSchemas。
AutomationTriggeringRule	在事件攔截時評估的規則。規則是藉由將事件模型的特定值與預期的值進行比較來設定。這項比較是使用其中一個支援的運算符集來完成。
AutomationValidationStatus	安全性自動化模型狀態屬性包。
CloudError	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。
CloudErrorBody	錯誤詳細數據。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
EventSource	有效的事件來源類型。
Operator	要使用的有效比較子運算符。字串 PropertyType 將套用不區分大小寫的比較。
PropertyType	比較操作數的數據類型（字串、整數、浮點數或布爾值 [true/false]]

Automation

安全性自動化資源。

名稱	類型	Description
etag	string	實體標籤用於比較來自相同要求資源的兩個或多個實體。
id	string	資源標識碼
kind	string	資源的種類
location	string	儲存資源的位置
name	string	資源名稱
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	如果所有已設定的規則評估至少在一個規則集中，就會觸發的動作集合為 true。
properties.description	string	安全性自動化描述。
properties.isEnabled	boolean	指出是否啟用安全性自動化。
properties.scopes	AutomationScope[]	套用安全性自動化邏輯的範圍集合。支援的範圍是訂用帳戶本身或該訂用帳戶下的資源群組。自動化只會套用至定義的範圍。
properties.sources	AutomationSource[]	評估規則安全性自動化集之來源事件類型的集合。
tags	object	描述資源的索引鍵值組清單。
type	string	資源類型

AutomationActionEventHub

將匯出事件數據的目標事件中樞。若要深入瞭解適用於雲端的Defender持續匯出功能Microsoft，請流覽 https://aka.ms/ASCExportLearnMore

名稱	類型	Description
actionType	string: EventHub	自動化將觸發的動作類型
connectionString	string	目標事件中樞連接字串（不會包含在任何回應中）。
eventHubResourceId	string	目標事件中樞 Azure 資源識別碼。
isTrustedServiceEnabled	boolean	指出是否啟用信任的服務。
sasPolicyName	string	目標事件中樞 SAS 原則名稱。

AutomationActionLogicApp

應該觸發的邏輯應用程式動作。若要深入瞭解適用於雲端的Defender工作流程自動化功能Microsoft，請流覽 https://aka.ms/ASCWorkflowAutomationLearnMore

名稱	類型	Description
actionType	string: LogicApp	自動化將觸發的動作類型
logicAppResourceId	string	觸發的邏輯應用程式 Azure 資源識別碼。這也可以位於其他訂用帳戶上，因為您有權觸發邏輯應用程式
uri	string	邏輯應用程式觸發 URI 端點（不會包含在任何回應中）。

AutomationActionWorkspace

將匯出事件數據的Log Analytics工作區。安全性警示數據會位於『SecurityAlert』資料表中，而評量數據會位於『SecurityRecommendation』資料表中（在 'Security'/'SecurityCenterFree' 解決方案下）。請注意，若要檢視工作區中的數據，必須在該工作區上啟用資訊安全中心 Log Analytics 免費/標準解決方案。若要深入瞭解適用於雲端的Defender持續匯出功能Microsoft，請流覽 https://aka.ms/ASCExportLearnMore

名稱	類型	Description
actionType	string: Workspace	自動化將觸發的動作類型
workspaceResourceId	string	完整 Log Analytics 工作區 Azure 資源識別碼。

AutomationRuleSet

在事件攔截時評估其所有規則的規則集。只有當規則集中的所有包含規則都會評估為『true』時，事件才會觸發已定義的動作。

名稱	類型	Description
rules	AutomationTriggeringRule[]	在事件攔截時評估的規則。規則是藉由將事件模型的特定值與預期的值進行比較來設定。這項比較是使用其中一個支援的運算符集來完成。

AutomationScope

單一自動化範圍。

名稱	類型	Description
description	string	資源範圍描述。
scopePath	string	資源範圍路徑。可以是在上定義自動化的訂用帳戶，或是該訂用帳戶下的資源群組（完整 Azure 資源識別符）。

AutomationSource

評估規則安全性自動化集合的來源事件類型。例如 - 安全性警示和安全性評定。若要深入瞭解支援的安全性事件資料模型架構 - 請瀏覽 https://aka.ms/ASCAutomationSchemas。

名稱	類型	Description
eventSource	EventSource	有效的事件來源類型。
ruleSets	AutomationRuleSet[]	一組規則，會在事件攔截時進行評估。定義的規則集之間會套用邏輯分離（邏輯』or'）。

AutomationTriggeringRule

在事件攔截時評估的規則。規則是藉由將事件模型的特定值與預期的值進行比較來設定。這項比較是使用其中一個支援的運算符集來完成。

名稱	類型	Description
expectedValue	string	預期的值。
operator	Operator	要使用的有效比較子運算符。字串 PropertyType 將套用不區分大小寫的比較。
propertyJPath	string	應檢查之實體模型屬性的 JPath。
propertyType	PropertyType	比較操作數的數據類型（字串、整數、浮點數或布爾值 [true/false]]

AutomationValidationStatus

安全性自動化模型狀態屬性包。

名稱	類型	Description
isValid	boolean	指出模型是否有效。
message	string	驗證訊息。

CloudError

所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。（這也遵循 OData 錯誤回應格式。）。

名稱	類型	Description
error.additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
error.code	string	錯誤碼。
error.details	CloudErrorBody[]	錯誤詳細數據。
error.message	string	錯誤訊息。
error.target	string	錯誤目標。

CloudErrorBody

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	CloudErrorBody[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorAdditionalInfo

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

EventSource

有效的事件來源類型。

名稱	類型	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

要使用的有效比較子運算符。字串 PropertyType 將套用不區分大小寫的比較。

名稱	類型	Description
Contains	string	僅適用於非十進位操作數
EndsWith	string	僅適用於非十進位操作數
Equals	string	適用於十進位和非十進位操作數
GreaterThan	string	僅適用於小數操作數
GreaterThanOrEqualTo	string	僅適用於小數操作數
LesserThan	string	僅適用於小數操作數
LesserThanOrEqualTo	string	僅適用於小數操作數
NotEquals	string	適用於十進位和非十進位操作數
StartsWith	string	僅適用於非十進位操作數

PropertyType

比較操作數的數據類型（字串、整數、浮點數或布爾值 [true/false]]

名稱	類型	Description
Boolean	string
Integer	string
Number	string
String	string

共用方式為

Automations - Validate

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

Validate the security automation model before create or update

範例要求

範例回覆

定義

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

AutomationValidationStatus

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType

其他資源