Automations - Validate

作成または更新する前に、セキュリティオートメーションモデルを検証します。 検証エラーがクライアントに返されます。

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

URI パラメーター

Name In Required Type Description
automationName
path True
  • string

セキュリティオートメーション名。

resourceGroupName
path True
  • string

ユーザーのサブスクリプション内のリソースグループの名前。 名前の大文字と小文字は区別されます。

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Azure サブスクリプション ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True
  • string

操作の API バージョン

要求本文

Name Type Description
etag
  • string

エンティティタグは、要求された同じリソースの2つ以上のエンティティを比較するために使用されます。

kind
  • string

リソースの種類

location
  • string

リソースが格納されている場所

properties.actions AutomationAction[]:

少なくとも1つの規則セット内で、構成されているすべての規則の評価が true である場合にトリガーされるアクションのコレクション。

properties.description
  • string

セキュリティオートメーションの説明。

properties.isEnabled
  • boolean

セキュリティオートメーションが有効になっているかどうかを示します。

properties.scopes

セキュリティ自動化ロジックが適用されるスコープのコレクション。 サポートされるスコープは、サブスクリプション自体またはそのサブスクリプションのリソースグループです。 オートメーションは、定義されたスコープにのみ適用されます。

properties.sources

規則のセキュリティオートメーションセットを評価するソースイベントの種類のコレクション。

tags
  • object

リソースを説明するキーと値のペアの一覧。

応答

Name Type Description
200 OK

[OK]

Other Status Codes

操作に失敗した理由を説明するエラー応答

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザーアカウントの権限を借用する

Validate the security automation model before create or update

Sample Request

POST https://management.azure.com/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation/validate?api-version=2019-01-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"
      }
    ]
  }
}

Sample Response

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

定義

Automation

セキュリティオートメーションリソース。

AutomationActionEventHub

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

AutomationActionLogicApp

トリガーするロジックアプリのアクション。 Security Center のワークフローの自動化機能の詳細については、「」を参照してください。 https://aka.ms/ASCWorkflowAutomationLearnMore

AutomationActionWorkspace

イベントデータがエクスポートされる Log Analytics ワークスペース。 セキュリティ警告データは ' SecurityAlert ' テーブルに格納され、評価データは ' Securityalert ' テーブル (' Security '/' Securityalert 無料 ' ソリューションの下) に存在します。 ワークスペースのデータを表示するには、そのワークスペースで Security Center Log Analytics free/standard ソリューションを有効にする必要があることに注意してください。 Security Center 連続エクスポート機能の詳細については、 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

セキュリティオートメーションリソース。

Name Type Description
etag
  • string

エンティティタグは、要求された同じリソースの2つ以上のエンティティを比較するために使用されます。

id
  • string

リソース ID

kind
  • string

リソースの種類

location
  • string

リソースが格納されている場所

name
  • string

リソース名

properties.actions AutomationAction[]:

少なくとも1つの規則セット内で、構成されているすべての規則の評価が true である場合にトリガーされるアクションのコレクション。

properties.description
  • string

セキュリティオートメーションの説明。

properties.isEnabled
  • boolean

セキュリティオートメーションが有効になっているかどうかを示します。

properties.scopes

セキュリティ自動化ロジックが適用されるスコープのコレクション。 サポートされるスコープは、サブスクリプション自体またはそのサブスクリプションのリソースグループです。 オートメーションは、定義されたスコープにのみ適用されます。

properties.sources

規則のセキュリティオートメーションセットを評価するソースイベントの種類のコレクション。

tags
  • object

リソースを説明するキーと値のペアの一覧。

type
  • string

リソースの種類

AutomationActionEventHub

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

Name Type Description
actionType string:
  • EventHub

オートメーションによってトリガーされるアクションの型。

connectionString
  • string

ターゲットイベントハブの接続文字列 (応答には含まれません)。

eventHubResourceId
  • string

ターゲットイベントハブの Azure リソース ID。

sasPolicyName
  • string

ターゲットイベントハブの SAS ポリシー名。

AutomationActionLogicApp

トリガーするロジックアプリのアクション。 Security Center のワークフローの自動化機能の詳細については、「」を参照してください。 https://aka.ms/ASCWorkflowAutomationLearnMore

Name Type Description
actionType string:
  • LogicApp

オートメーションによってトリガーされるアクションの型。

logicAppResourceId
  • string

トリガーされたロジックアプリの Azure リソース ID。 ロジックアプリをトリガーするアクセス許可がある場合は、他のサブスクリプションにも存在する可能性があります。

uri
  • string

ロジックアプリのトリガー URI エンドポイント (応答には含まれません)。

AutomationActionWorkspace

イベントデータがエクスポートされる Log Analytics ワークスペース。 セキュリティ警告データは ' SecurityAlert ' テーブルに格納され、評価データは ' Securityalert ' テーブル (' Security '/' Securityalert 無料 ' ソリューションの下) に存在します。 ワークスペースのデータを表示するには、そのワークスペースで Security Center Log Analytics free/standard ソリューションを有効にする必要があることに注意してください。 Security Center 連続エクスポート機能の詳細については、 https://aka.ms/ASCExportLearnMore

Name Type Description
actionType string:
  • Workspace

オートメーションによってトリガーされるアクションの型。

workspaceResourceId
  • string

完全修飾 Log Analytics ワークスペースの Azure リソース ID です。

AutomationRuleSet

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

Name Type Description
rules

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

AutomationScope

単一のオートメーションスコープ。

Name Type Description
description
  • string

リソーススコープの説明。

scopePath
  • string

リソーススコープパス。 には、automation が定義されているサブスクリプション、またはそのサブスクリプションのリソースグループ (完全修飾された Azure リソース Id) を指定できます。

AutomationSource

セキュリティオートメーションによるルールのセットを評価するソースイベントの種類。 例: セキュリティの警告とセキュリティの評価。 サポートされているセキュリティイベントのデータモデルスキーマの詳細については、「」を参照してください https://aka.ms/ASCAutomationSchemas

Name Type Description
eventSource

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

ruleSets

イベントのインターセプト時に評価するルールのセット。 定義されたルールセット (論理 ' or ') の間に論理和が適用されます。

AutomationTriggeringRule

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

Name Type Description
expectedValue
  • string

予期される値。

operator

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

propertyJPath
  • string

確認する必要があるエンティティモデルプロパティの JPath。

propertyType

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

AutomationValidationStatus

セキュリティオートメーションモデルの状態プロパティバッグ。

Name Type Description
isValid
  • boolean

モデルが有効かどうかを示します。

message
  • string

検証メッセージ。

CloudError

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

Name Type Description
error.additionalInfo

エラーの追加情報。

error.code
  • string

エラー コード。

error.details

エラーの詳細です。

error.message
  • string

エラー メッセージ。

error.target
  • string

エラーターゲット。

CloudErrorBody

エラーの詳細。

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ErrorAdditionalInfo

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

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

EventSource

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

Name Type Description
Alerts
  • string
Assessments
  • string
AssessmentsSnapshot
  • string
RegulatoryComplianceAssessment
  • string
RegulatoryComplianceAssessmentSnapshot
  • string
SecureScoreControls
  • string
SecureScoreControlsSnapshot
  • string
SecureScores
  • string
SecureScoresSnapshot
  • string
SubAssessments
  • string
SubAssessmentsSnapshot
  • string

Operator

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

Name Type Description
Contains
  • string

Decimal 以外のオペランドに対してのみ適用されます。

EndsWith
  • string

Decimal 以外のオペランドに対してのみ適用されます。

Equals
  • string

Decimal および decimal 以外のオペランドに適用されます

GreaterThan
  • string

Decimal オペランドにのみ適用されます

GreaterThanOrEqualTo
  • string

Decimal オペランドにのみ適用されます

LesserThan
  • string

Decimal オペランドにのみ適用されます

LesserThanOrEqualTo
  • string

Decimal オペランドにのみ適用されます

NotEquals
  • string

Decimal および decimal 以外のオペランドに適用されます

StartsWith
  • string

Decimal 以外のオペランドに対してのみ適用されます。

PropertyType

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

Name Type Description
Boolean
  • string
Integer
  • string
Number
  • string
String
  • string