Activity Log Alerts - Create Or Update

Buat aturan Pemberitahuan Log Aktivitas baru atau perbarui aturan yang sudah ada.

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

Parameter URI

Name In Required Type Description
activityLogAlertName
path True
  • string

Nama aturan Pemberitahuan Log Aktivitas.

resourceGroupName
path True
  • string

Nama grup sumber daya. Nama tidak peka huruf besar/kecil.

subscriptionId
path True
  • string

ID langganan target.

api-version
query True
  • string

Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Name Required Type Description
properties.actions True

Tindakan yang akan diaktifkan saat kondisi terpenuhi.

properties.condition True

Kondisi yang akan menyebabkan pemberitahuan ini diaktifkan.

properties.scopes True
  • string[]

Daftar ID sumber daya yang akan digunakan sebagai awalan. Pemberitahuan hanya akan berlaku untuk peristiwa Log Aktivitas dengan ID sumber daya yang termasuk dalam salah satu awalan ini. Daftar ini harus menyertakan setidaknya satu item.

location
  • string

Lokasi sumber daya. Karena Pemberitahuan Log Aktivitas Azure adalah layanan global, lokasi aturan harus selalu 'global'.

properties.description
  • string

Deskripsi aturan Pemberitahuan Log Aktivitas ini.

properties.enabled
  • boolean

Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.

tags
  • object

Tag sumber daya.

Respons

Name Type Description
200 OK

Aturan Pemberitahuan Log Aktivitas yang ada berhasil diperbarui.

201 Created

Aturan Pemberitahuan Log Aktivitas baru berhasil dibuat.

Other Status Codes

Terjadi kesalahan dan aturan Pemberitahuan Log Aktivitas tidak dapat dibuat atau diperbarui.

Keamanan

azure_auth

Azure Active Directory Flow OAuth2

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

Scopes

Name Description
user_impersonation meniru akun pengguna Anda

Contoh

Create or update an Activity Log Alert rule
Create or update an Activity Log Alert rule with 'anyOf' condition
Create or update an Activity Log Alert rule with 'containsAny'

Create or update an Activity Log Alert rule

Sample Request

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

{
  "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."
  }
}

Sample Response

{
  "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."
  }
}
{
  "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."
  }
}

Create or update an Activity Log Alert rule with 'anyOf' condition

Sample Request

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

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "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 with 'anyOf' condition."
  }
}

Sample Response

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "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 with 'anyOf' condition."
  }
}
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithAnyOfCondition",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithAnyOfCondition",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "anyOf": [
            {
              "field": "properties.incidentType",
              "equals": "Incident"
            },
            {
              "field": "properties.incidentType",
              "equals": "Maintenance"
            }
          ]
        }
      ]
    },
    "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 with 'anyOf' condition."
  }
}

Create or update an Activity Log Alert rule with 'containsAny'

Sample Request

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

{
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "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 with 'containsAny'."
  }
}

Sample Response

{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "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 with 'containsAny'."
  }
}
{
  "id": "/subscriptions/187f412d-1758-44d9-b052-169e2564721d/resourceGroups/MyResourceGroup/providers/microsoft.insights/activityLogAlerts/SampleActivityLogAlertRuleWithContainsAny",
  "type": "Microsoft.Insights/ActivityLogAlerts",
  "name": "SampleActivityLogAlertRuleWithContainsAny",
  "location": "Global",
  "tags": {},
  "properties": {
    "scopes": [
      "subscriptions/187f412d-1758-44d9-b052-169e2564721d"
    ],
    "condition": {
      "allOf": [
        {
          "field": "category",
          "equals": "ServiceHealth"
        },
        {
          "field": "properties.impactedServices[*].ImpactedRegions[*].RegionName",
          "containsAny": [
            "North Europe",
            "West Europe"
          ]
        }
      ]
    },
    "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 with 'containsAny'."
  }
}

Definisi

ActionGroup

Penunjuk ke Grup Tindakan Azure.

ActionList

Daftar tindakan aturan Pemberitahuan Log Aktivitas.

ActivityLogAlertResource

Sumber daya aturan Pemberitahuan Log Aktivitas.

AlertRuleAllOfCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.

AlertRuleAnyOfOrLeafCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting: Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi.

  • Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' tidak boleh diatur dalam Kondisi Daun.
  • Kondisi AnyOf -hanya boleh berisi 'anyOf' (yang merupakan array Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' tidak boleh diatur dalam Kondisi AnyOf.
AlertRuleLeafCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang dipenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'field' dan 'equals' atau 'containsAny'.

ErrorResponse

Respons kesalahan.

ActionGroup

Penunjuk ke Grup Tindakan Azure.

Name Type Description
actionGroupId
  • string

ID sumber daya Grup Tindakan. Ini tidak boleh null atau kosong.

webhookProperties
  • object

kamus properti kustom untuk disertakan dengan operasi pasca. Data ini ditambahkan ke payload webhook.

ActionList

Daftar tindakan aturan Pemberitahuan Log Aktivitas.

Name Type Description
actionGroups

Daftar Grup Tindakan.

ActivityLogAlertResource

Sumber daya aturan Pemberitahuan Log Aktivitas.

Name Type Default Value Description
id
  • string

Id sumber daya.

location
  • string
global

Lokasi sumber daya. Karena Pemberitahuan Log Aktivitas Azure adalah layanan global, lokasi aturan harus selalu 'global'.

name
  • string

Nama sumber daya.

properties.actions

Tindakan yang akan diaktifkan saat kondisi terpenuhi.

properties.condition

Kondisi yang akan menyebabkan pemberitahuan ini diaktifkan.

properties.description
  • string

Deskripsi aturan Pemberitahuan Log Aktivitas ini.

properties.enabled
  • boolean
True

Menunjukkan apakah aturan Pemberitahuan Log Aktivitas ini diaktifkan. Jika aturan Pemberitahuan Log Aktivitas tidak diaktifkan, maka tidak ada tindakannya yang akan diaktifkan.

properties.scopes
  • string[]

Daftar ID sumber daya yang akan digunakan sebagai awalan. Pemberitahuan hanya akan berlaku untuk peristiwa Log Aktivitas dengan ID sumber daya yang termasuk dalam salah satu awalan ini. Daftar ini harus menyertakan setidaknya satu item.

tags
  • object

Tag sumber daya.

type
  • string

Jenis sumber daya.

AlertRuleAllOfCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi.

Name Type Description
allOf

Daftar kondisi aturan Pemberitahuan Log Aktivitas.

AlertRuleAnyOfOrLeafCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi saat semua kondisi anggotanya terpenuhi. Setiap kondisi dapat berupa salah satu jenis berikut: Penting: Setiap jenis memiliki subset properti yang unik. Properti dari berbagai jenis TIDAK DAPAT ada dalam satu kondisi.

  • Kondisi Daun - harus berisi 'bidang' dan 'sama dengan' atau 'containsAny'. Harap dicatat, 'anyOf' tidak boleh diatur dalam Kondisi Daun.
  • Kondisi AnyOf -hanya boleh berisi 'anyOf' (yang merupakan array Kondisi Daun). Harap dicatat, 'field', 'equals' dan 'containsAny' tidak boleh diatur dalam Kondisi AnyOf.
Name Type Description
anyOf

Aturan Pemberitahuan Log Aktivitas kondisi 'anyOf'.
Kondisi aturan Pemberitahuan Log Aktivitas yang terpenuhi ketika setidaknya salah satu kondisi daun anggotanya terpenuhi.

containsAny
  • string[]

Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.

equals
  • string

Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.

field
  • string

Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properties'.

AlertRuleLeafCondition

Kondisi aturan Pemberitahuan Log Aktivitas yang dipenuhi dengan membandingkan bidang dan nilai peristiwa Log Aktivitas. Kondisi ini harus berisi 'field' dan 'equals' atau 'containsAny'.

Name Type Description
containsAny
  • string[]

Nilai bidang peristiwa akan dibandingkan dengan nilai dalam array ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.

equals
  • string

Nilai bidang peristiwa akan dibandingkan dengan nilai ini (tidak peka huruf besar/kecil) untuk menentukan apakah kondisi terpenuhi.

field
  • string

Nama bidang peristiwa Log Aktivitas yang akan diperiksa kondisi ini. Nilai yang mungkin untuk bidang ini adalah (tidak peka huruf besar/kecil): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', atau apa pun yang dimulai dengan 'properties'.

ErrorResponse

Respons kesalahan.

Name Type Description
code
  • string

Kode kesalahan.

message
  • string

Pesan kesalahan yang menunjukkan mengapa operasi gagal.