Automation Rules - Create Or Update
自動化規則を作成または更新します。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}?api-version=2024-09-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
automation
|
path | True |
string |
オートメーション ルール ID |
resource
|
path | True |
string minLength: 1maxLength: 90 |
リソース グループの名前。 名前では大文字と小文字が区別されません。 |
subscription
|
path | True |
string (uuid) |
ターゲット サブスクリプションの ID。 値は UUID である必要があります。 |
workspace
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$ |
ワークスペースの名前。 |
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.actions | True | AutomationRuleAction[]: |
自動化ルールがトリガーされたときに実行するアクション。 |
properties.displayName | True |
string maxLength: 500 |
自動化規則の表示名。 |
properties.order | True |
integer (int32) minimum: 1maximum: 1000 |
オートメーション ルールの実行順序。 |
properties.triggeringLogic | True |
ロジックをトリガーするオートメーション ルールについて説明します。 |
|
etag |
string |
Azure リソースの Etag |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
わかりました |
|
201 Created |
作成 |
|
Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントを偽装する |
例
AutomationRules_CreateOrUpdate
要求のサンプル
PUT https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5?api-version=2024-09-01
応答のサンプル
{
"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"
}
}
}
{
"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
オートメーション ルール アクションの種類。
値 | 説明 |
---|---|
AddIncidentTask |
インシデント オブジェクトにタスクを追加する |
ModifyProperties |
オブジェクトのプロパティを変更する |
RunPlaybook |
オブジェクトでプレイブックを実行する |
AddIncidentTaskActionProperties
インシデントにタスクを追加するオートメーション ルール アクションについて説明します。
名前 | 型 | 説明 |
---|---|---|
description |
string |
タスクの説明。 |
title |
string |
タスクのタイトル。 |
AutomationRule
名前 | 型 | 説明 |
---|---|---|
etag |
string |
Azure リソースの Etag |
id |
string (arm-id) |
リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
name |
string |
リソースの名前 |
properties.actions | AutomationRuleAction[]: |
自動化ルールがトリガーされたときに実行するアクション。 |
properties.createdBy |
何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報 |
|
properties.createdTimeUtc |
string (date-time) |
自動化ルールが作成された時刻。 |
properties.displayName |
string maxLength: 500 |
自動化規則の表示名。 |
properties.lastModifiedBy |
何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報 |
|
properties.lastModifiedTimeUtc |
string (date-time) |
オートメーション ルールが最後に更新された時刻。 |
properties.order |
integer (int32) minimum: 1maximum: 1000 |
オートメーション ルールの実行順序。 |
properties.triggeringLogic |
ロジックをトリガーするオートメーション ルールについて説明します。 |
|
systemData |
createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。 |
|
type |
string |
リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts" |
AutomationRuleAddIncidentTaskAction
インシデントにタスクを追加する自動化ルール アクションについて説明します
名前 | 型 | 説明 |
---|---|---|
actionConfiguration |
インシデントにタスクを追加するオートメーション ルール アクションについて説明します。 |
|
actionType |
string:
Add |
オートメーション ルール アクションの種類。 |
order |
integer (int32) |
AutomationRuleBooleanCondition
ブール演算子を使用したオートメーション ルールの条件について説明します。
名前 | 型 | 説明 |
---|---|---|
innerConditions | AutomationRuleCondition[]: |
自動化ルールの条件について説明します。 |
operator |
ブール条件演算子について説明します。 |
AutomationRuleBooleanConditionSupportedOperator
ブール条件演算子について説明します。
値 | 説明 |
---|---|
And |
すべての項目条件が true として評価される場合、true と評価されます。 |
Or |
項目の条件の少なくとも 1 つが true として評価される場合、true と評価されます |
AutomationRuleModifyPropertiesAction
オブジェクトのプロパティを変更するオートメーション ルール アクションについて説明します
名前 | 型 | 説明 |
---|---|---|
actionConfiguration | ||
actionType |
string:
Modify |
オートメーション ルール アクションの種類。 |
order |
integer (int32) |
AutomationRulePropertyArrayChangedConditionSupportedArrayType
値 | 説明 |
---|---|
Alerts |
アラートの条件を評価する |
Comments |
コメントの条件を評価する |
Labels |
ラベルの条件を評価する |
Tactics |
戦術の条件を評価する |
AutomationRulePropertyArrayChangedConditionSupportedChangeType
値 | 説明 |
---|---|
Added |
配列に追加された項目の条件を評価する |
AutomationRulePropertyArrayChangedValuesCondition
名前 | 型 | 説明 |
---|---|---|
arrayType |
Automation |
|
changeType |
Automation |
AutomationRulePropertyArrayConditionSupportedArrayConditionType
配列条件の評価型について説明します。
値 | 説明 |
---|---|
AnyItem |
いずれかの項目が条件を満たしている場合は、条件を true として評価します |
AutomationRulePropertyArrayConditionSupportedArrayType
配列条件で評価された配列型について説明します。
値 | 説明 |
---|---|
CustomDetailValues |
カスタム詳細の値に基づいて条件を評価する |
CustomDetails |
カスタム詳細キーの条件を評価する |
AutomationRulePropertyArrayValuesCondition
配列プロパティのオートメーション ルール条件について説明します。
名前 | 型 | 説明 |
---|---|---|
arrayConditionType |
Automation |
配列条件の評価型について説明します。 |
arrayType |
配列条件で評価された配列型について説明します。 |
|
itemConditions | AutomationRuleCondition[]: |
自動化ルールの条件について説明します。 |
AutomationRulePropertyChangedConditionSupportedChangedType
値 | 説明 |
---|---|
ChangedFrom |
プロパティの前の値で条件を評価する |
ChangedTo |
プロパティの更新された値の条件を評価する |
AutomationRulePropertyChangedConditionSupportedPropertyType
値 | 説明 |
---|---|
IncidentOwner |
インシデント所有者の条件を評価する |
IncidentSeverity |
インシデントの重大度の条件を評価する |
IncidentStatus |
インシデントの状態の条件を評価する |
AutomationRulePropertyConditionSupportedOperator
値 | 説明 |
---|---|
Contains |
プロパティに条件値の少なくとも 1 つが含まれているかどうかを評価します |
EndsWith |
プロパティがいずれかの条件値で終わるかどうかを評価します |
Equals |
プロパティが条件値の少なくとも 1 つと等しいかどうかを評価します |
NotContains |
プロパティに条件値が含まれていないかどうかを評価します |
NotEndsWith |
プロパティが条件値で終わらないかどうかを評価します |
NotEquals |
プロパティが条件値と等しくないかどうかを評価します |
NotStartsWith |
プロパティがいずれかの条件値で始まらないかどうかを評価します |
StartsWith |
プロパティがいずれかの条件値で始まるかどうかを評価します |
AutomationRulePropertyConditionSupportedProperty
オートメーション ルールのプロパティ条件で評価するプロパティ。
値 | 説明 |
---|---|
AccountAadTenantId |
アカウント Azure Active Directory テナント ID |
AccountAadUserId |
アカウント Azure Active Directory ユーザー ID |
AccountNTDomain |
アカウント NetBIOS ドメイン名 |
AccountName |
アカウント名 |
AccountObjectGuid |
アカウントの一意識別子 |
AccountPUID |
アカウント Azure Active Directory Passport ユーザー ID |
AccountSid |
アカウントのセキュリティ識別子 |
AccountUPNSuffix |
アカウント ユーザー プリンシパル名のサフィックス |
AlertAnalyticRuleIds |
アラートの分析ルール ID |
AlertProductNames |
アラートの製品の名前 |
AzureResourceResourceId |
Azure リソース ID |
AzureResourceSubscriptionId |
Azure リソース サブスクリプション ID |
CloudApplicationAppId |
クラウド アプリケーション識別子 |
CloudApplicationAppName |
クラウド アプリケーション名 |
DNSDomainName |
DNS レコードのドメイン名 |
FileDirectory |
ファイル ディレクトリの完全パス |
FileHashValue |
ファイル ハッシュ値 |
FileName |
パスのないファイル名 |
HostAzureID |
ホスト Azure リソース ID |
HostNTDomain |
ホスト NT ドメイン |
HostName |
ドメインのないホスト名 |
HostNetBiosName |
ホスト NetBIOS 名 |
HostOSVersion |
ホスト オペレーティング システム |
IPAddress |
IP アドレス |
IncidentCustomDetailsKey |
インシデント カスタム詳細キー |
IncidentCustomDetailsValue |
インシデントのカスタム詳細値 |
IncidentDescription |
インシデントの説明 |
IncidentLabel |
インシデントのラベル |
IncidentProviderName |
インシデントのプロバイダー名 |
IncidentRelatedAnalyticRuleIds |
インシデントの関連する分析ルール ID |
IncidentSeverity |
インシデントの重大度 |
IncidentStatus |
インシデントの状態 |
IncidentTactics |
インシデントの戦術 |
IncidentTitle |
インシデントのタイトル |
IncidentUpdatedBySource |
インシデントの更新元 |
IoTDeviceId |
"IoT デバイス ID |
IoTDeviceModel |
IoT デバイス モデル |
IoTDeviceName |
IoT デバイス名 |
IoTDeviceOperatingSystem |
IoT デバイスのオペレーティング システム |
IoTDeviceType |
IoT デバイスの種類 |
IoTDeviceVendor |
IoT デバイス ベンダー |
MailMessageDeliveryAction |
メール メッセージ配信アクション |
MailMessageDeliveryLocation |
メール メッセージの配信場所 |
MailMessageP1Sender |
メール メッセージ P1 送信者 |
MailMessageP2Sender |
メール メッセージ P2 送信者 |
MailMessageRecipient |
メール メッセージの受信者 |
MailMessageSenderIP |
メール メッセージ送信者の IP アドレス |
MailMessageSubject |
メール メッセージの件名 |
MailboxDisplayName |
メールボックスの表示名 |
MailboxPrimaryAddress |
メールボックスのプライマリ アドレス |
MailboxUPN |
メールボックス ユーザー プリンシパル名 |
MalwareCategory |
マルウェア カテゴリ |
MalwareName |
マルウェア名 |
ProcessCommandLine |
プロセス実行コマンド ライン |
ProcessId |
プロセス ID |
RegistryKey |
レジストリ キーのパス |
RegistryValueData |
文字列形式表現のレジストリ キー値 |
Url |
URL |
AutomationRulePropertyValuesChangedCondition
名前 | 型 | 説明 |
---|---|---|
changeType | ||
operator | ||
propertyName | ||
propertyValues |
string[] |
AutomationRulePropertyValuesCondition
名前 | 型 | 説明 |
---|---|---|
operator | ||
propertyName |
オートメーション ルールのプロパティ条件で評価するプロパティ。 |
|
propertyValues |
string[] |
AutomationRuleRunPlaybookAction
プレイブックを実行するオートメーション ルール アクションについて説明します
名前 | 型 | 説明 |
---|---|---|
actionConfiguration | ||
actionType |
string:
Run |
オートメーション ルール アクションの種類。 |
order |
integer (int32) |
AutomationRuleTriggeringLogic
ロジックをトリガーするオートメーション ルールについて説明します。
名前 | 型 | 説明 |
---|---|---|
conditions | AutomationRuleCondition[]: |
特定のオブジェクトに対してオートメーション ルールをトリガーする必要があるかどうかを判断するために評価する条件。 |
expirationTimeUtc |
string (date-time) |
自動化ルールの有効期限が自動的に切れ、無効になるタイミングを決定します。 |
isEnabled |
boolean |
自動化ルールが有効か無効かを決定します。 |
triggersOn | ||
triggersWhen |
BooleanConditionProperties
ブール演算子 (AND、OR など) を条件に適用するオートメーション ルールの条件について説明します
名前 | 型 | 説明 |
---|---|---|
conditionProperties |
ブール演算子を使用したオートメーション ルールの条件について説明します。 |
|
conditionType |
string:
Boolean |
ClientInfo
何らかのアクションを実行したクライアント (ユーザーまたはアプリケーション) に関する情報
名前 | 型 | 説明 |
---|---|---|
string |
クライアントの電子メール。 |
|
name |
string |
クライアントの名前。 |
objectId |
string (uuid) |
クライアントのオブジェクト ID。 |
userPrincipalName |
string |
クライアントのユーザー プリンシパル名。 |
CloudError
エラー応答の構造。
名前 | 型 | 説明 |
---|---|---|
error |
エラー データ |
CloudErrorBody
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。 |
message |
string |
ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。 |
ConditionType
値 | 説明 |
---|---|
Boolean |
条件にブール演算子 (AND、OR など) を適用する |
Property |
オブジェクト プロパティ値を評価する |
PropertyArray |
オブジェクト配列のプロパティ値を評価する |
PropertyArrayChanged |
オブジェクト配列プロパティの変更された値を評価する |
PropertyChanged |
オブジェクト プロパティの変更された値を評価する |
createdByType
リソースを作成した ID の種類。
値 | 説明 |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
IncidentClassification
インシデントが閉じられた理由
値 | 説明 |
---|---|
BenignPositive |
インシデントは良性陽性でした |
FalsePositive |
インシデントが誤検知 |
TruePositive |
インシデントは真陽性でした |
Undetermined |
インシデントの分類が未確定だった |
IncidentClassificationReason
インシデントが閉じられた分類の理由
値 | 説明 |
---|---|
InaccurateData |
分類の理由が不正確なデータ |
IncorrectAlertLogic |
分類の理由が正しくないアラート ロジックでした |
SuspiciousActivity |
分類の理由が疑わしいアクティビティだった |
SuspiciousButExpected |
分類の理由は疑わしいが予想される |
IncidentLabel
インシデント ラベルを表します
名前 | 型 | 説明 |
---|---|---|
labelName |
string |
ラベルの名前 |
labelType |
ラベルの種類 |
IncidentLabelType
ラベルの種類
値 | 説明 |
---|---|
AutoAssigned |
システムによって自動的に作成されるラベル |
User |
ユーザーが手動で作成したラベル |
IncidentOwnerInfo
インシデントが割り当てられているユーザーに関する情報
名前 | 型 | 説明 |
---|---|---|
assignedTo |
string |
インシデントが割り当てられているユーザーの名前。 |
string |
インシデントが割り当てられているユーザーの電子メール。 |
|
objectId |
string (uuid) |
インシデントが割り当てられているユーザーのオブジェクト ID。 |
ownerType |
インシデントが割り当てられている所有者の種類。 |
|
userPrincipalName |
string |
インシデントが割り当てられているユーザーのユーザー プリンシパル名。 |
IncidentPropertiesAction
名前 | 型 | 説明 |
---|---|---|
classification |
インシデントが閉じられた理由 |
|
classificationComment |
string |
インシデントが閉じられた理由について説明します。 |
classificationReason |
インシデントが閉じられた分類の理由 |
|
labels |
インシデントに追加するラベルの一覧。 |
|
owner |
インシデントが割り当てられているユーザーに関する情報 |
|
severity |
インシデントの重大度 |
|
status |
インシデントの状態 |
IncidentSeverity
インシデントの重大度
値 | 説明 |
---|---|
High |
重大度が高い |
Informational |
情報の重大度 |
Low |
重大度が低い |
Medium |
重大度が中程度 |
IncidentStatus
インシデントの状態
値 | 説明 |
---|---|
Active |
処理されているアクティブなインシデント |
Closed |
アクティブでないインシデント |
New |
現在処理されていないアクティブなインシデント |
OwnerType
インシデントが割り当てられている所有者の種類。
値 | 説明 |
---|---|
Group |
インシデント所有者の種類が AAD グループである |
Unknown |
インシデント所有者の種類が不明です |
User |
インシデント所有者の種類が AAD ユーザーである |
PlaybookActionProperties
名前 | 型 | 説明 |
---|---|---|
logicAppResourceId |
string (arm-id) |
プレイブック リソースのリソース ID。 |
tenantId |
string (uuid) |
プレイブック リソースのテナント ID。 |
PropertyArrayChangedConditionProperties
配列プロパティの値の変更を評価するオートメーション ルールの条件について説明します
名前 | 型 | 説明 |
---|---|---|
conditionProperties | ||
conditionType |
string:
Property |
PropertyArrayConditionProperties
配列プロパティの値を評価するオートメーション ルールの条件について説明します
名前 | 型 | 説明 |
---|---|---|
conditionProperties |
配列プロパティのオートメーション ルール条件について説明します。 |
|
conditionType |
string:
Property |
PropertyChangedConditionProperties
プロパティの値の変更を評価するオートメーション ルールの条件について説明します
名前 | 型 | 説明 |
---|---|---|
conditionProperties | ||
conditionType |
string:
Property |
PropertyConditionProperties
プロパティの値を評価するオートメーション ルールの条件について説明します
名前 | 型 | 説明 |
---|---|---|
conditionProperties | ||
conditionType |
string:
Property |
systemData
リソースの作成と最後の変更に関連するメタデータ。
名前 | 型 | 説明 |
---|---|---|
createdAt |
string (date-time) |
リソース作成のタイムスタンプ (UTC)。 |
createdBy |
string |
リソースを作成した ID。 |
createdByType |
リソースを作成した ID の種類。 |
|
lastModifiedAt |
string (date-time) |
リソースの最終変更のタイムスタンプ (UTC) |
lastModifiedBy |
string |
リソースを最後に変更した ID。 |
lastModifiedByType |
リソースを最後に変更した ID の種類。 |
triggersOn
値 | 説明 |
---|---|
Alerts |
アラートでトリガーする |
Incidents |
インシデントに対するトリガー |
triggersWhen
値 | 説明 |
---|---|
Created |
作成されたオブジェクトに対してトリガーする |
Updated |
更新されたオブジェクトに対してトリガーする |