共用方式為

Activity Log Alerts - Get

  • 參考
服務:
Monitor
API 版本:
2020-10-01

取得活動記錄警示規則。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/activityLogAlerts/{activityLogAlertName}?api-version=2020-10-01

URI 參數

名稱 位於 必要 類型 Description
activityLogAlertName
 path True

string

活動記錄警示規則的名稱。
resourceGroupName
 path True

string

資源群組的名稱。 名稱不區分大小寫。
subscriptionId
 path True

string

目標訂用帳戶的標識碼。
api-version
 query True

string

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

ActivityLogAlertResource

要求成功。
Other Status Codes

ErrorResponse

發生錯誤且無法擷取活動記錄警示規則。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

範圍

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

範例

Get an Activity Log Alert rule

範例要求

GET https://management.azure.com/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/Microsoft.Insights/activityLogAlerts/SampleActivityLogAlertRule?api-version=2020-10-01

範例回覆

狀態碼:
200 
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRule",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRule",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "Administrative"
        },
        {
          "field": "level",
          "equals": "Error"
        }
      ]
    },
    "actions": {
      "actionGroups": [
        {
          "actionGroupId": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/actionGroups/SampleActionGroup",
          "webhookProperties": {
            "sampleWebhookProperty": "SamplePropertyValue"
          }
        }
      ]
    },
    "enabled": true,
    "description": "Description of sample Activity Log Alert rule."
  }
}

定義

名稱 Description
ActionGroup

Azure 動作群組的指標。
ActionList

活動記錄警示規則動作的清單。
ActivityLogAlertResource

活動記錄警示規則資源。
AlertRuleAllOfCondition

符合其所有成員條件時符合的活動記錄警示規則條件。
AlertRuleAnyOfOrLeafCondition

符合其所有成員條件時符合的活動記錄警示規則條件。 每個條件可以是下列其中一種類型： 重要：每個類型都有其唯一的屬性子集。 不同類型的屬性無法存在於一個條件中。

  • 分葉條件 - 必須包含 'field' 和 'equals' 或 'containsAny'。 請注意，'anyOf' 不應該 在分葉條件中設定。
  • AnyOf 條件 -只能 包含 'anyOf' (，這是分葉條件) 陣列。 請注意，'field'、'equals' 和 'containsAny' 不應該 在 AnyOf 條件中設定。
AlertRuleLeafCondition

比較活動記錄事件的欄位和值，以符合活動記錄警示規則條件。 此條件必須包含 『field』 和 'equals' 或 'containsAny'。
ErrorResponse

錯誤回應。

ActionGroup

Azure 動作群組的指標。

名稱 類型 Description
actionGroupId

string

動作群組的資源標識碼。 這不可以是 Null 或空白。
webhookProperties

object

要包含在後續作業中的自定義屬性字典。 這些數據會附加至 Webhook 承載。

ActionList

活動記錄警示規則動作的清單。

名稱 類型 Description
actionGroups

ActionGroup[]

動作群組的清單。

ActivityLogAlertResource

活動記錄警示規則資源。

名稱 類型 預設值 Description
id

string

資源標識碼。
location

string

global

資源的位置。 全域、西歐和北歐區域支援 Azure 活動記錄警示規則。
name

string

資源名稱。
properties.actions

ActionList

符合條件時將會啟動的動作。
properties.condition

AlertRuleAllOfCondition

導致此警示啟動的條件。
properties.description

string

此活動記錄警示規則的描述。
properties.enabled

boolean

True

指出是否啟用此活動記錄警示規則。 如果未啟用活動記錄警示規則，則不會啟動其任何動作。
properties.scopes

string[]

將做為前置詞的資源標識符清單。 警示只會套用至屬於下列其中一個前置詞的資源標識符的活動記錄事件。 此清單至少必須包含一個專案。
tags

object

資源的標記。
type

string

資源類型。

AlertRuleAllOfCondition

符合其所有成員條件時符合的活動記錄警示規則條件。

名稱 類型 Description
allOf

AlertRuleAnyOfOrLeafCondition[]

活動記錄警示規則條件的清單。

AlertRuleAnyOfOrLeafCondition

符合其所有成員條件時符合的活動記錄警示規則條件。 每個條件可以是下列其中一種類型： 重要：每個類型都有其唯一的屬性子集。 不同類型的屬性無法存在於一個條件中。

  • 分葉條件 - 必須包含 'field' 和 'equals' 或 'containsAny'。 請注意，'anyOf' 不應該 在分葉條件中設定。
  • AnyOf 條件 -只能 包含 'anyOf' (，這是分葉條件) 陣列。 請注意，'field'、'equals' 和 'containsAny' 不應該 在 AnyOf 條件中設定。
名稱 類型 Description
anyOf

AlertRuleLeafCondition[]

活動記錄警示規則 『anyOf』 條件。
符合至少一個成員分葉條件時符合的活動記錄警示規則條件。
containsAny

string[]

事件欄位的值會與此陣列中的值進行比較， (不區分大小寫的) ，以判斷是否符合條件。
equals

string

事件欄位的值會與此值進行比較， (不區分大小寫的) ，以判斷是否符合條件。
field

string

此條件將檢查的活動記錄事件欄位名稱。 此字段的可能值 (不區分大小寫的) ：'resourceId'、'category'、'caller'、'level'、'operationName'、'resourceGroup'、'resourceProvider'、'status'、'subStatus'、'resourceType'，或任何以 'properties' 開頭的任何專案。

AlertRuleLeafCondition

比較活動記錄事件的欄位和值，以符合活動記錄警示規則條件。 此條件必須包含 『field』 和 'equals' 或 'containsAny'。

名稱 類型 Description
containsAny

string[]

事件欄位的值會與此陣列中的值進行比較， (不區分大小寫的) ，以判斷是否符合條件。
equals

string

事件欄位的值會與此值進行比較， (不區分大小寫的) ，以判斷是否符合條件。
field

string

此條件將檢查的活動記錄事件欄位名稱。 此字段的可能值 (不區分大小寫的) ：'resourceId'、'category'、'caller'、'level'、'operationName'、'resourceGroup'、'resourceProvider'、'status'、'subStatus'、'resourceType'，或任何以 'properties' 開頭的任何專案。

ErrorResponse

錯誤回應。

名稱 類型 Description
code

string

錯誤碼。
message

string

錯誤訊息，指出作業失敗的原因。