Automations - Update

サービス:

Defender for Cloud

API バージョン:

2023-12-01-preview

セキュリティの自動化を更新します

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

URI パラメーター

名前	/	必須	型	説明
automationName	path	True	string	セキュリティオートメーション名。
resourceGroupName	path	True	string	ユーザーのサブスクリプション内のリソース グループの名前。 名前では大文字と小文字が区別されません。 正規表現パターン: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure サブスクリプション ID 正規表現パターン: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$
api-version	query	True	string	操作の API バージョン

要求本文

名前	型	説明
properties.actions	AutomationAction[]: AutomationActionLogicApp[] AutomationActionEventHub[] AutomationActionWorkspace[]	少なくとも 1 つのルール セット内のすべての構成済みルール評価が true の場合にトリガーされるアクションのコレクション。
properties.description	string	セキュリティ自動化の説明。
properties.isEnabled	boolean	セキュリティ自動化が有効になっているかどうかを示します。
properties.scopes	AutomationScope[]	セキュリティ自動化ロジックが適用されるスコープのコレクション。 サポートされているスコープは、サブスクリプション自体、またはそのサブスクリプションのリソース グループです。 自動化は、定義されたスコープにのみ適用されます。
properties.sources	AutomationSource[]	セキュリティ自動化規則のセットを評価するソース イベントの種類のコレクション。
tags	object	リソースを記述するキー値ペアの一覧。

応答

名前	型	説明
200 OK	Automation	わかりました
Other Status Codes	CloudError	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Update a security automation

要求のサンプル

HTTP

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

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

Java

import com.azure.resourcemanager.security.models.Automation;
import com.azure.resourcemanager.security.models.AutomationActionLogicApp;
import com.azure.resourcemanager.security.models.AutomationScope;
import com.azure.resourcemanager.security.models.AutomationSource;
import com.azure.resourcemanager.security.models.EventSource;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for Automations Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/
     * PatchAutomation_example.json
     */
    /**
     * Sample code: Update a security automation.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void updateASecurityAutomation(com.azure.resourcemanager.security.SecurityManager manager) {
        Automation resource = manager.automations().getByResourceGroupWithResponse("exampleResourceGroup",
            "exampleAutomation", com.azure.core.util.Context.NONE).getValue();
        resource.update().withTags(mapOf("Example", "exampleTag")).withDescription(
            "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment")
            .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)))
            .withActions(Arrays.asList(new AutomationActionLogicApp().withLogicAppResourceId(
                "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1")
                .withUri("https://exampleTriggerUri1.com")))
            .apply();
    }

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

Go

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/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("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAutomationsClient().Update(ctx, "exampleResourceGroup", "exampleAutomation", armsecurity.AutomationUpdateModel{
		Tags: map[string]*string{
			"Example": to.Ptr("exampleTag"),
		},
		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),
				}},
		},
	}, 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("new 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"),
	// 		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{
	// 				},
	// 		}},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

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: specification/security/resource-manager/Microsoft.Security/preview/2023-12-01-preview/examples/Automations/PatchAutomation_example.json
 */
async function updateASecurityAutomation() {
  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",
    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" },
  };
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential, subscriptionId);
  const result = await client.automations.update(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

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

定義

名前	説明
Automation	セキュリティ自動化リソース。
AutomationActionEventHub	イベント データのエクスポート先となるターゲット イベント ハブ。 Microsoft Defender for Cloud の継続的エクスポート機能の詳細については、https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	トリガーする必要があるロジック アプリのアクション。 Microsoft Defender for Cloud のワークフロー自動化機能の詳細については、https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	イベント データのエクスポート先となる Log Analytics ワークスペース。 セキュリティ アラート データは 'SecurityAlert' テーブルに存在し、評価データは "SecurityRecommendation" テーブル ("Security"/"SecurityCenterFree" ソリューションの下) に配置されます。 ワークスペース内のデータを表示するには、そのワークスペースで Security Center Log Analytics の無料/標準ソリューションを有効にする必要があることに注意してください。 Microsoft Defender for Cloud の継続的エクスポート機能の詳細については、https://aka.ms/ASCExportLearnMore
AutomationRuleSet	イベントのインターセプト時にすべてのルールを評価するルール セット。 ルール セットに含まれるすべてのルールが "true" として評価される場合にのみ、イベントによって定義されたアクションがトリガーされます。
AutomationScope	1 つのオートメーション スコープ。
AutomationSource	セキュリティ自動化規則のセットを評価するソース イベントの種類。 たとえば、セキュリティ アラートとセキュリティ評価などです。 サポートされているセキュリティ イベント データ モデルスキーマの詳細については、https://aka.ms/ASCAutomationSchemasを参照してください。
AutomationTriggeringRule	イベントのインターセプト時に評価されるルール。 ルールは、イベント モデルの特定の値と期待される値を比較することによって構成されます。 この比較は、サポートされている演算子セットのいずれかを使用して行われます。
AutomationUpdateModel	セキュリティ オートメーション リソースの更新モデル。
CloudError	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
CloudErrorBody	エラーの詳細。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
EventSource	有効なイベント ソースの種類。
Operator	使用する有効な比較演算子。 String PropertyType には、大文字と小文字を区別しない比較が適用されます。
PropertyType	比較されたオペランドのデータ型 (文字列、整数、浮動小数点数、またはブール値 [true/false]]

Automation

セキュリティ自動化リソース。

名前	型	説明
etag	string	エンティティ タグは、同じ要求されたリソースから 2 つ以上のエンティティを比較するために使用されます。
id	string	リソース ID
kind	string	リソースの種類
location	string	リソースが格納されている場所
name	string	リソース名
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	少なくとも 1 つのルール セット内のすべての構成済みルール評価が true の場合にトリガーされるアクションのコレクション。
properties.description	string	セキュリティ自動化の説明。
properties.isEnabled	boolean	セキュリティ自動化が有効になっているかどうかを示します。
properties.scopes	AutomationScope[]	セキュリティ自動化ロジックが適用されるスコープのコレクション。 サポートされているスコープは、サブスクリプション自体、またはそのサブスクリプションのリソース グループです。 自動化は、定義されたスコープにのみ適用されます。
properties.sources	AutomationSource[]	セキュリティ自動化規則のセットを評価するソース イベントの種類のコレクション。
tags	object	リソースを記述するキー値ペアの一覧。
type	string	リソースの種類

AutomationActionEventHub

イベント データのエクスポート先となるターゲット イベント ハブ。 Microsoft Defender for Cloud の継続的エクスポート機能の詳細については、https://aka.ms/ASCExportLearnMore

名前	型	説明
actionType	string: EventHub	Automation によってトリガーされるアクションの種類
connectionString	string	ターゲット Event Hub 接続文字列 (応答には含まれません)。
eventHubResourceId	string	ターゲット Event Hub Azure リソース ID。
isTrustedServiceEnabled	boolean	信頼されたサービスが有効かどうかを示します。
sasPolicyName	string	ターゲットのイベント ハブ SAS ポリシー名。

AutomationActionLogicApp

トリガーする必要があるロジック アプリのアクション。 Microsoft Defender for Cloud のワークフロー自動化機能の詳細については、https://aka.ms/ASCWorkflowAutomationLearnMore

名前	型	説明
actionType	string: LogicApp	Automation によってトリガーされるアクションの種類
logicAppResourceId	string	トリガーされたロジック アプリの Azure リソース ID。 ロジック アプリをトリガーするアクセス許可がある場合は、他のサブスクリプションにも存在できます。
uri	string	ロジック アプリトリガー URI エンドポイント (応答には含まれません)。

AutomationActionWorkspace

イベント データのエクスポート先となる Log Analytics ワークスペース。 セキュリティ アラート データは 'SecurityAlert' テーブルに存在し、評価データは "SecurityRecommendation" テーブル ("Security"/"SecurityCenterFree" ソリューションの下) に配置されます。 ワークスペース内のデータを表示するには、そのワークスペースで Security Center Log Analytics の無料/標準ソリューションを有効にする必要があることに注意してください。 Microsoft Defender for Cloud の継続的エクスポート機能の詳細については、https://aka.ms/ASCExportLearnMore

名前	型	説明
actionType	string: Workspace	Automation によってトリガーされるアクションの種類
workspaceResourceId	string	完全修飾 Log Analytics ワークスペースの Azure リソース ID。

AutomationRuleSet

イベントのインターセプト時にすべてのルールを評価するルール セット。 ルール セットに含まれるすべてのルールが "true" として評価される場合にのみ、イベントによって定義されたアクションがトリガーされます。

名前	型	説明
rules	AutomationTriggeringRule[]	イベントのインターセプト時に評価されるルール。 ルールは、イベント モデルの特定の値と期待される値を比較することによって構成されます。 この比較は、サポートされている演算子セットのいずれかを使用して行われます。

AutomationScope

1 つのオートメーション スコープ。

名前	型	説明
description	string	リソース スコープの説明。
scopePath	string	リソース スコープ パス。 自動化が定義されているサブスクリプション、またはそのサブスクリプションの下のリソース グループ (完全修飾 Azure リソース ID) を指定できます。

AutomationSource

セキュリティ自動化規則のセットを評価するソース イベントの種類。 たとえば、セキュリティ アラートとセキュリティ評価などです。 サポートされているセキュリティ イベント データ モデルスキーマの詳細については、https://aka.ms/ASCAutomationSchemasを参照してください。

名前	型	説明
eventSource	EventSource	有効なイベント ソースの種類。
ruleSets	AutomationRuleSet[]	イベントのインターセプト時に評価される一連のルール。 論理和演算は、定義された規則セット (論理 'or') の間で適用されます。

AutomationTriggeringRule

イベントのインターセプト時に評価されるルール。 ルールは、イベント モデルの特定の値と期待される値を比較することによって構成されます。 この比較は、サポートされている演算子セットのいずれかを使用して行われます。

名前	型	説明
expectedValue	string	予期される値。
operator	Operator	使用する有効な比較演算子。 String PropertyType には、大文字と小文字を区別しない比較が適用されます。
propertyJPath	string	チェックする必要があるエンティティ モデル プロパティの JPath。
propertyType	PropertyType	比較されたオペランドのデータ型 (文字列、整数、浮動小数点数、またはブール値 [true/false]]

AutomationUpdateModel

セキュリティ オートメーション リソースの更新モデル。

名前	型	説明
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	少なくとも 1 つのルール セット内のすべての構成済みルール評価が true の場合にトリガーされるアクションのコレクション。
properties.description	string	セキュリティ自動化の説明。
properties.isEnabled	boolean	セキュリティ自動化が有効になっているかどうかを示します。
properties.scopes	AutomationScope[]	セキュリティ自動化ロジックが適用されるスコープのコレクション。 サポートされているスコープは、サブスクリプション自体、またはそのサブスクリプションのリソース グループです。 自動化は、定義されたスコープにのみ適用されます。
properties.sources	AutomationSource[]	セキュリティ自動化規則のセットを評価するソース イベントの種類のコレクション。
tags	object	リソースを記述するキー値ペアの一覧。

CloudError

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error.additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
error.code	string	エラー コード。
error.details	CloudErrorBody[]	エラーの詳細。
error.message	string	エラー メッセージ。
error.target	string	エラーターゲット。

CloudErrorBody

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	CloudErrorBody[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

EventSource

有効なイベント ソースの種類。

名前	型	説明
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

使用する有効な比較演算子。 String PropertyType には、大文字と小文字を区別しない比較が適用されます。

名前	型	説明
Contains	string	10 進数以外のオペランドにのみ適用されます
EndsWith	string	10 進数以外のオペランドにのみ適用されます
Equals	string	10 進数オペランドと非 10 進数オペランドに適用されます
GreaterThan	string	10 進オペランドにのみ適用されます
GreaterThanOrEqualTo	string	10 進オペランドにのみ適用されます
LesserThan	string	10 進オペランドにのみ適用されます
LesserThanOrEqualTo	string	10 進オペランドにのみ適用されます
NotEquals	string	10 進数オペランドと非 10 進数オペランドに適用されます
StartsWith	string	10 進数以外のオペランドにのみ適用されます

PropertyType

比較されたオペランドのデータ型 (文字列、整数、浮動小数点数、またはブール値 [true/false]]

名前	型	説明
Boolean	string
Integer	string
Number	string
String	string