Automation Rules - List

リファレンス

サービス:: Sentinel

API バージョン:: 2024-03-01

すべての自動化規則を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules?api-version=2024-03-01

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソースグループの名前。名前の大文字と小文字は区別されます。
subscriptionId	path	True	string uuid	ターゲットサブスクリプションの ID。値は UUID である必要があります。
workspaceName	path	True	string	ワークスペースの名前。正規表現パターン: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	AutomationRulesList	[OK]
Other Status Codes	CloudError	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

スコープ

名前	説明
user_impersonation	ユーザーアカウントの借用

例

AutomationRules_List

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules?api-version=2024-03-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5",
      "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5",
      "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
      "type": "Microsoft.SecurityInsights/automationRules",
      "properties": {
        "displayName": "Suspicious user sign-in events",
        "order": 1,
        "triggeringLogic": {
          "isEnabled": true,
          "triggersOn": "Incidents",
          "triggersWhen": "Created",
          "conditions": [
            {
              "conditionType": "Property",
              "conditionProperties": {
                "propertyName": "IncidentRelatedAnalyticRuleIds",
                "operator": "Contains",
                "propertyValues": [
                  "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7",
                  "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a"
                ]
              }
            }
          ]
        },
        "actions": [
          {
            "order": 1,
            "actionType": "AddIncidentTask",
            "actionConfiguration": {
              "title": "Reset user passwords",
              "description": "Reset passwords for compromised users."
            }
          }
        ],
        "lastModifiedTimeUtc": "2019-01-01T13:00:30Z",
        "createdTimeUtc": "2019-01-01T13:00:00Z",
        "lastModifiedBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john.doe@contoso.com",
          "name": "john doe",
          "userPrincipalName": "john@contoso.com"
        },
        "createdBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john.doe@contoso.com",
          "name": "john doe",
          "userPrincipalName": "john@contoso.com"
        }
      }
    }
  ]
}

定義

名前	説明
ActionType	オートメーションルールアクションの種類。
AddIncidentTaskActionProperties	インシデントにタスクを追加する自動化ルールアクションについて説明します。
AutomationRule
AutomationRuleAddIncidentTaskAction	インシデントにタスクを追加する自動化ルールアクションについて説明します
AutomationRuleBooleanCondition	ブール演算子を使用したオートメーションルールの条件について説明します。
AutomationRuleBooleanConditionSupportedOperator	ブール条件演算子について説明します。
AutomationRuleModifyPropertiesAction	オブジェクトのプロパティを変更するオートメーションルールアクションについて説明します
AutomationRulePropertyArrayChangedConditionSupportedArrayType
AutomationRulePropertyArrayChangedConditionSupportedChangeType
AutomationRulePropertyArrayChangedValuesCondition
AutomationRulePropertyArrayConditionSupportedArrayConditionType	配列条件の評価型について説明します。
AutomationRulePropertyArrayConditionSupportedArrayType	配列条件で評価された配列型について説明します。
AutomationRulePropertyArrayValuesCondition	配列プロパティのオートメーションルールの条件について説明します。
AutomationRulePropertyChangedConditionSupportedChangedType
AutomationRulePropertyChangedConditionSupportedPropertyType
AutomationRulePropertyConditionSupportedOperator
AutomationRulePropertyConditionSupportedProperty	オートメーションルールのプロパティ条件で評価するプロパティ。
AutomationRulePropertyValuesChangedCondition
AutomationRulePropertyValuesCondition
AutomationRuleRunPlaybookAction	プレイブックを実行するオートメーションルールアクションについて説明します
AutomationRulesList
AutomationRuleTriggeringLogic	ロジックをトリガーする自動化ルールについて説明します。
BooleanConditionProperties	ブール演算子 (AND、OR など) を条件に適用するオートメーションルールの条件について説明します
ClientInfo	何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報
CloudError	エラー応答の構造。
CloudErrorBody	エラーの詳細。
ConditionType
createdByType	リソースを作成した ID の種類。
IncidentClassification	インシデントが閉じられた理由
IncidentClassificationReason	インシデントが閉じられた分類の理由
IncidentLabel	インシデントラベルを表します
IncidentLabelType	ラベルの種類
IncidentOwnerInfo	インシデントが割り当てられているユーザーに関する情報
IncidentPropertiesAction
IncidentSeverity	インシデントの重大度
IncidentStatus	インシデントの状態
OwnerType	インシデントが割り当てられている所有者の種類。
PlaybookActionProperties
PropertyArrayChangedConditionProperties	配列プロパティの値の変更を評価するオートメーションルールの条件について説明します
PropertyArrayConditionProperties	配列プロパティの値を評価するオートメーションルールの条件について説明します
PropertyChangedConditionProperties	プロパティの値の変更を評価するオートメーションルールの条件について説明します
PropertyConditionProperties	プロパティの値を評価するオートメーションルールの条件について説明します
systemData	リソースの作成と最後の変更に関連するメタデータ。
triggersOn
triggersWhen

ActionType

オートメーションルールアクションの種類。

名前	型	説明
AddIncidentTask	string	インシデントオブジェクトにタスクを追加する
ModifyProperties	string	オブジェクトのプロパティを変更する
RunPlaybook	string	オブジェクトでプレイブックを実行する

AddIncidentTaskActionProperties

インシデントにタスクを追加する自動化ルールアクションについて説明します。

名前	型	説明
description	string	タスクの説明です。
title	string	タスクのタイトル。

AutomationRule

名前	型	説明
etag	string	Azure リソースの Etag
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.actions	AutomationRuleAction[]: AutomationRuleAddIncidentTaskAction[] AutomationRuleModifyPropertiesAction[] AutomationRuleRunPlaybookAction[]	オートメーションルールがトリガーされたときに実行するアクション。
properties.createdBy	ClientInfo	何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報
properties.createdTimeUtc	string	オートメーションルールが作成された時刻。
properties.displayName	string	オートメーションルールの表示名。
properties.lastModifiedBy	ClientInfo	何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報
properties.lastModifiedTimeUtc	string	オートメーションルールが最後に更新された時刻。
properties.order	integer	自動化ルールの実行順序。
properties.triggeringLogic	AutomationRuleTriggeringLogic	ロジックをトリガーする自動化ルールについて説明します。
systemData	systemData	createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。
type	string	リソースの型。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

AutomationRuleAddIncidentTaskAction

インシデントにタスクを追加する自動化ルールアクションについて説明します

名前	型	説明
actionConfiguration	AddIncidentTaskActionProperties	インシデントにタスクを追加する自動化ルールアクションについて説明します。
actionType	string: AddIncidentTask	オートメーションルールアクションの種類。
order	integer

AutomationRuleBooleanCondition

ブール演算子を使用したオートメーションルールの条件について説明します。

名前	型	説明
innerConditions	AutomationRuleCondition[]: BooleanConditionProperties[] PropertyArrayChangedConditionProperties[] PropertyArrayConditionProperties[] PropertyChangedConditionProperties[] PropertyConditionProperties[]	オートメーションルールの条件について説明します。
operator	AutomationRuleBooleanConditionSupportedOperator	ブール条件演算子について説明します。

AutomationRuleBooleanConditionSupportedOperator

ブール条件演算子について説明します。

名前	型	説明
And	string	すべての項目条件が true として評価される場合、true と評価されます
Or	string	アイテムの条件の少なくとも 1 つが true と評価される場合、true と評価されます

AutomationRuleModifyPropertiesAction

オブジェクトのプロパティを変更するオートメーションルールアクションについて説明します

名前	型	説明
actionConfiguration	IncidentPropertiesAction
actionType	string: ModifyProperties	オートメーションルールアクションの種類。
order	integer

AutomationRulePropertyArrayChangedConditionSupportedArrayType

名前	型	説明
Alerts	string	アラートの条件を評価する
Comments	string	コメントの条件を評価する
Labels	string	ラベルの条件を評価する
Tactics	string	戦術の条件を評価する

AutomationRulePropertyArrayChangedConditionSupportedChangeType

名前	型	説明
Added	string	配列に追加された項目の条件を評価する

AutomationRulePropertyArrayChangedValuesCondition

名前	型	説明
arrayType	AutomationRulePropertyArrayChangedConditionSupportedArrayType
changeType	AutomationRulePropertyArrayChangedConditionSupportedChangeType

AutomationRulePropertyArrayConditionSupportedArrayConditionType

配列条件の評価型について説明します。

名前	型	説明
AnyItem	string	いずれかの項目が満たす場合に条件を true として評価する

AutomationRulePropertyArrayConditionSupportedArrayType

配列条件で評価された配列型について説明します。

名前	型	説明
CustomDetailValues	string	カスタム詳細の値に基づいて条件を評価する
CustomDetails	string	カスタム詳細キーの条件を評価する

AutomationRulePropertyArrayValuesCondition

配列プロパティのオートメーションルールの条件について説明します。

名前	型	説明
arrayConditionType	AutomationRulePropertyArrayConditionSupportedArrayConditionType	配列条件の評価型について説明します。
arrayType	AutomationRulePropertyArrayConditionSupportedArrayType	配列条件で評価された配列型について説明します。
itemConditions	AutomationRuleCondition[]: BooleanConditionProperties[] PropertyArrayChangedConditionProperties[] PropertyArrayConditionProperties[] PropertyChangedConditionProperties[] PropertyConditionProperties[]	オートメーションルールの条件について説明します。

AutomationRulePropertyChangedConditionSupportedChangedType

名前	型	説明
ChangedFrom	string	プロパティの前の値で条件を評価する
ChangedTo	string	プロパティの更新された値に基づいて条件を評価する

AutomationRulePropertyChangedConditionSupportedPropertyType

名前	型	説明
IncidentOwner	string	インシデント所有者の条件を評価する
IncidentSeverity	string	インシデントの重大度に関する条件を評価する
IncidentStatus	string	インシデントの状態に関する条件を評価する

AutomationRulePropertyConditionSupportedOperator

名前	型	説明
Contains	string	プロパティに条件値の少なくとも 1 つが含まれているかどうかを評価します
EndsWith	string	プロパティがいずれかの条件値で終わるかどうかを評価します
Equals	string	プロパティが条件値の少なくとも 1 つと等しいかどうかを評価します
NotContains	string	プロパティに条件値が含まれていないかどうかを評価します
NotEndsWith	string	プロパティがいずれかの条件値で終わらないかどうかを評価します
NotEquals	string	プロパティがいずれかの条件値と等しくないかどうかを評価します
NotStartsWith	string	プロパティがいずれかの条件値で始まらないかどうかを評価します
StartsWith	string	プロパティがいずれかの条件値で始まるかどうかを評価します

AutomationRulePropertyConditionSupportedProperty

オートメーションルールのプロパティ条件で評価するプロパティ。

名前	型	説明
AccountAadTenantId	string	アカウント Azure Active Directory テナント ID
AccountAadUserId	string	アカウント Azure Active Directory ユーザー ID
AccountNTDomain	string	アカウント NetBIOS ドメイン名
AccountName	string	アカウント名。
AccountObjectGuid	string	アカウントの一意識別子
AccountPUID	string	アカウント Azure Active Directory Passport ユーザー ID
AccountSid	string	アカウントのセキュリティ識別子
AccountUPNSuffix	string	アカウントユーザープリンシパル名サフィックス
AlertAnalyticRuleIds	string	アラートの分析ルール ID
AlertProductNames	string	アラートの製品の名前
AzureResourceResourceId	string	Azure リソース ID
AzureResourceSubscriptionId	string	Azure リソースサブスクリプション ID
CloudApplicationAppId	string	クラウドアプリケーション識別子
CloudApplicationAppName	string	クラウドアプリケーション名
DNSDomainName	string	DNS レコードのドメイン名
FileDirectory	string	ファイルディレクトリの完全パス
FileHashValue	string	ファイルハッシュ値
FileName	string	パスのないファイル名
HostAzureID	string	ホスト Azure リソース ID
HostNTDomain	string	ホスト NT ドメイン
HostName	string	ドメインのないホスト名
HostNetBiosName	string	ホスト NetBIOS 名
HostOSVersion	string	ホストオペレーティングシステム
IPAddress	string	IP アドレス
IncidentCustomDetailsKey	string	インシデントカスタム詳細キー
IncidentCustomDetailsValue	string	インシデントのカスタム詳細値
IncidentDescription	string	インシデントの説明
IncidentLabel	string	インシデントのラベル
IncidentProviderName	string	インシデントのプロバイダー名
IncidentRelatedAnalyticRuleIds	string	インシデントの関連する分析ルール ID
IncidentSeverity	string	インシデントの重大度
IncidentStatus	string	インシデントの状態
IncidentTactics	string	インシデントの戦術
IncidentTitle	string	インシデントのタイトル
IncidentUpdatedBySource	string	インシデントの更新ソース
IoTDeviceId	string	"IoT デバイス ID
IoTDeviceModel	string	IoT デバイスモデル
IoTDeviceName	string	IoT デバイス名
IoTDeviceOperatingSystem	string	IoT デバイスのオペレーティングシステム
IoTDeviceType	string	IoT デバイスの種類
IoTDeviceVendor	string	IoT デバイスベンダー
MailMessageDeliveryAction	string	メールメッセージ配信アクション
MailMessageDeliveryLocation	string	メールメッセージの配信場所
MailMessageP1Sender	string	メールメッセージ P1 送信者
MailMessageP2Sender	string	メールメッセージ P2 送信者
MailMessageRecipient	string	メールメッセージの受信者
MailMessageSenderIP	string	メールメッセージ送信者の IP アドレス
MailMessageSubject	string	メールメッセージの件名
MailboxDisplayName	string	メールボックスの表示名
MailboxPrimaryAddress	string	メールボックスのプライマリアドレス
MailboxUPN	string	メールボックスユーザープリンシパル名
MalwareCategory	string	マルウェアカテゴリ
MalwareName	string	マルウェア名
ProcessCommandLine	string	プロセス実行コマンドライン
ProcessId	string	プロセス ID
RegistryKey	string	レジストリキーのパス
RegistryValueData	string	文字列形式の表現のレジストリキー値
Url	string	URL

AutomationRulePropertyValuesChangedCondition

名前	型	説明
changeType	AutomationRulePropertyChangedConditionSupportedChangedType
operator	AutomationRulePropertyConditionSupportedOperator
propertyName	AutomationRulePropertyChangedConditionSupportedPropertyType
propertyValues	string[]

AutomationRulePropertyValuesCondition

名前	型	説明
operator	AutomationRulePropertyConditionSupportedOperator
propertyName	AutomationRulePropertyConditionSupportedProperty	オートメーションルールのプロパティ条件で評価するプロパティ。
propertyValues	string[]

AutomationRuleRunPlaybookAction

プレイブックを実行するオートメーションルールアクションについて説明します

名前	型	説明
actionConfiguration	PlaybookActionProperties
actionType	string: RunPlaybook	オートメーションルールアクションの種類。
order	integer

AutomationRulesList

名前	型	説明
nextLink	string
value	AutomationRule[]

AutomationRuleTriggeringLogic

ロジックをトリガーする自動化ルールについて説明します。

名前	型	説明
conditions	AutomationRuleCondition[]: BooleanConditionProperties[] PropertyArrayChangedConditionProperties[] PropertyArrayConditionProperties[] PropertyChangedConditionProperties[] PropertyConditionProperties[]	特定のオブジェクトに対してオートメーションルールをトリガーする必要があるかどうかを判断するために評価する条件。
expirationTimeUtc	string	自動化ルールの有効期限が自動的に切れ、無効になるタイミングを決定します。
isEnabled	boolean	自動化ルールを有効にするか無効にするかを決定します。
triggersOn	triggersOn
triggersWhen	triggersWhen

BooleanConditionProperties

ブール演算子 (AND、OR など) を条件に適用するオートメーションルールの条件について説明します

名前	型	説明
conditionProperties	AutomationRuleBooleanCondition	ブール演算子を使用したオートメーションルールの条件について説明します。
conditionType	string: Boolean

ClientInfo

何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報

名前	型	説明
email	string	クライアントの電子メール。
name	string	クライアントの名前。
objectId	string	クライアントのオブジェクト ID。
userPrincipalName	string	クライアントのユーザープリンシパル名。

CloudError

エラー応答の構造。

名前	型	説明
error	CloudErrorBody	エラーデータ

CloudErrorBody

エラーの詳細。

名前	型	説明
code	string	エラーの識別子。コードは不変であり、プログラムによって使用されることを意図しています。
message	string	ユーザーインターフェイスでの表示に適したエラーを説明するメッセージ。

ConditionType

名前	型	説明
Boolean	string	条件にブール演算子 (AND、OR など) を適用する
Property	string	オブジェクトのプロパティ値を評価する
PropertyArray	string	オブジェクト配列プロパティ値を評価する
PropertyArrayChanged	string	オブジェクト配列プロパティの変更された値を評価する
PropertyChanged	string	オブジェクトプロパティの変更された値を評価する

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

IncidentClassification

インシデントが閉じられた理由

名前	型	説明
BenignPositive	string	インシデントは無害な陽性でした
FalsePositive	string	インシデントが誤検知
TruePositive	string	インシデントは真陽性でした
Undetermined	string	インシデント分類が未確定

IncidentClassificationReason

インシデントが閉じられた分類の理由

名前	型	説明
InaccurateData	string	分類の理由が不正確なデータでした
IncorrectAlertLogic	string	分類の理由が正しくないアラートロジックでした
SuspiciousActivity	string	分類の理由が疑わしいアクティビティでした
SuspiciousButExpected	string	分類の理由は疑わしいが、予想される

IncidentLabel

インシデントラベルを表します

名前	型	説明
labelName	string	ラベルの名前
labelType	IncidentLabelType	ラベルの種類

IncidentLabelType

ラベルの種類

名前	型	説明
AutoAssigned	string	システムによって自動的に作成されるラベル
User	string	ユーザーが手動で作成したラベル

IncidentOwnerInfo

インシデントが割り当てられているユーザーに関する情報

名前	型	説明
assignedTo	string	インシデントが割り当てられているユーザーの名前。
email	string	インシデントが割り当てられているユーザーのメール。
objectId	string	インシデントが割り当てられているユーザーのオブジェクト ID。
ownerType	OwnerType	インシデントが割り当てられている所有者の種類。
userPrincipalName	string	インシデントが割り当てられているユーザーのユーザープリンシパル名。

IncidentPropertiesAction

名前	型	説明
classification	IncidentClassification	インシデントが閉じられた理由
classificationComment	string	インシデントが閉じられた理由について説明します。
classificationReason	IncidentClassificationReason	インシデントが閉じられた分類の理由
labels	IncidentLabel[]	インシデントに追加するラベルの一覧。
owner	IncidentOwnerInfo	インシデントが割り当てられているユーザーに関する情報
severity	IncidentSeverity	インシデントの重大度
status	IncidentStatus	インシデントの状態

IncidentSeverity

インシデントの重大度

名前	型	説明
High	string	重要度レベル高
Informational	string	情報の重要度
Low	string	重大度: 低
Medium	string	重要度レベル中

IncidentStatus

インシデントの状態

名前	型	説明
Active	string	処理されているアクティブなインシデント
Closed	string	アクティブでないインシデント
New	string	現在処理されていないアクティブなインシデント

OwnerType

インシデントが割り当てられている所有者の種類。

名前	型	説明
Group	string	インシデント所有者の種類は AAD グループです
Unknown	string	インシデント所有者の種類が不明です
User	string	インシデント所有者の種類は AAD ユーザーです

PlaybookActionProperties

名前	型	説明
logicAppResourceId	string	プレイブックリソースのリソース ID。
tenantId	string	プレイブックリソースのテナント ID。

PropertyArrayChangedConditionProperties

配列プロパティの値の変更を評価するオートメーションルールの条件について説明します

名前	型	説明
conditionProperties	AutomationRulePropertyArrayChangedValuesCondition
conditionType	string: PropertyArrayChanged

PropertyArrayConditionProperties

配列プロパティの値を評価するオートメーションルールの条件について説明します

名前	型	説明
conditionProperties	AutomationRulePropertyArrayValuesCondition	配列プロパティのオートメーションルールの条件について説明します。
conditionType	string: PropertyArray

PropertyChangedConditionProperties

プロパティの値の変更を評価するオートメーションルールの条件について説明します

名前	型	説明
conditionProperties	AutomationRulePropertyValuesChangedCondition
conditionType	string: PropertyChanged

PropertyConditionProperties

プロパティの値を評価するオートメーションルールの条件について説明します

名前	型	説明
conditionProperties	AutomationRulePropertyValuesCondition
conditionType	string: Property

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

triggersOn

名前	型	説明
Alerts	string	アラートのトリガー
Incidents	string	インシデントでのトリガー

triggersWhen

名前	型	説明
Created	string	作成されたオブジェクトに対してトリガーする
Updated	string	更新されたオブジェクトに対してトリガーする

次の方法で共有