Activity Log Alerts - Create Or Update

Skapa en ny aktivitetsloggaviseringsregel eller uppdatera en befintlig.

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

URI-parametrar

Name I Obligatorisk Typ Description
activityLogAlertName
path True

string

Namnet på aviseringsregeln för aktivitetsloggen.

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Begärandetext

Name Obligatorisk Typ Description
properties.actions True

ActionList

De åtgärder som aktiveras när villkoret uppfylls.

properties.condition True

AlertRuleAllOfCondition

Villkoret som gör att aviseringen aktiveras.

properties.scopes True

string[]

En lista över resurs-ID:t som ska användas som prefix. Aviseringen gäller endast för aktivitetslogghändelser med resurs-ID:t som omfattas av något av dessa prefix. Listan måste innehålla minst ett objekt.

location

string

Platsen för resursen. Azure Activity Log Alert-regler stöds i regionerna Global, Europa, västra och Europa, norra.

properties.description

string

En beskrivning av den här aviseringsregeln för aktivitetsloggen.

properties.enabled

boolean

Anger om den här aviseringsregeln för aktivitetslogg är aktiverad. Om en aktivitetsloggaviseringsregel inte är aktiverad aktiveras ingen av dess åtgärder.

tags

object

Taggarna för resursen.

Svar

Name Typ Description
200 OK

ActivityLogAlertResource

En befintlig aktivitetsloggaviseringsregel har uppdaterats.

201 Created

ActivityLogAlertResource

En ny aktivitetsloggaviseringsregel har skapats.

Other Status Codes

ErrorResponse

Ett fel uppstod och det gick inte att skapa eller uppdatera aviseringsregeln för aktivitetsloggen.

Säkerhet

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 personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
ActionGroup

En pekare till en Azure-åtgärdsgrupp.

ActionList

En lista över aktivitetsloggens aviseringsregelåtgärder.

ActivityLogAlertResource

En resurs för aktivitetsloggaviseringsregler.

AlertRuleAllOfCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls.

AlertRuleAnyOfOrLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls. Varje villkor kan vara av någon av följande typer: Viktigt: Varje typ har sin unika delmängd av egenskaper. Egenskaper från olika typer KAN INTE finnas i ett villkor.

  • Lövvillkor – måste innehålla "field" och antingen "equals" eller "containsAny". Observera att "anyOf" inte ska anges i ett lövvillkor.
  • AnyOf-villkor – får bara innehålla 'anyOf' (som är en matris med lövvillkor). Observera att "field", "equals" och "containsAny" inte ska anges i ett AnyOf-villkor.
AlertRuleLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls genom att jämföra fältet och värdet för en aktivitetslogghändelse. Det här villkoret måste innehålla "field" och antingen "equals" eller "containsAny".

ErrorResponse

Felsvaret.

ActionGroup

En pekare till en Azure-åtgärdsgrupp.

Name Typ Description
actionGroupId

string

Resurs-ID för åtgärdsgruppen. Detta får inte vara null eller tomt.

webhookProperties

object

ordlistan med anpassade egenskaper som ska inkluderas i poståtgärden. Dessa data läggs till i webhookens nyttolast.

ActionList

En lista över aktivitetsloggens aviseringsregelåtgärder.

Name Typ Description
actionGroups

ActionGroup[]

Listan över åtgärdsgrupper.

ActivityLogAlertResource

En resurs för aktivitetsloggaviseringsregler.

Name Typ Standardvärde Description
id

string

Resurs-ID:t.

location

string

global

Platsen för resursen. Azure Activity Log Alert-regler stöds i regionerna Global, Europa, västra och Europa, norra.

name

string

Namnet på resursen.

properties.actions

ActionList

De åtgärder som aktiveras när villkoret uppfylls.

properties.condition

AlertRuleAllOfCondition

Villkoret som gör att aviseringen aktiveras.

properties.description

string

En beskrivning av den här aviseringsregeln för aktivitetsloggen.

properties.enabled

boolean

True

Anger om den här aviseringsregeln för aktivitetslogg är aktiverad. Om en aktivitetsloggaviseringsregel inte är aktiverad aktiveras ingen av dess åtgärder.

properties.scopes

string[]

En lista över resurs-ID:t som ska användas som prefix. Aviseringen gäller endast för aktivitetslogghändelser med resurs-ID:t som omfattas av något av dessa prefix. Listan måste innehålla minst ett objekt.

tags

object

Taggarna för resursen.

type

string

Resurstypen.

AlertRuleAllOfCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls.

Name Typ Description
allOf

AlertRuleAnyOfOrLeafCondition[]

Listan över villkor för aktivitetsloggaviseringsregler.

AlertRuleAnyOfOrLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls när alla dess medlemsvillkor uppfylls. Varje villkor kan vara av någon av följande typer: Viktigt: Varje typ har sin unika delmängd av egenskaper. Egenskaper från olika typer KAN INTE finnas i ett villkor.

  • Lövvillkor – måste innehålla "field" och antingen "equals" eller "containsAny". Observera att "anyOf" inte ska anges i ett lövvillkor.
  • AnyOf-villkor – får bara innehålla 'anyOf' (som är en matris med lövvillkor). Observera att "field", "equals" och "containsAny" inte ska anges i ett AnyOf-villkor.
Name Typ Description
anyOf

AlertRuleLeafCondition[]

Ett villkor för aktivitetsloggaviseringsregeln "anyOf".
Ett regelvillkor för aktivitetsloggavisering som uppfylls när minst ett av dess lövvillkor för medlemmar uppfylls.

containsAny

string[]

Värdet för händelsens fält jämförs med värdena i den här matrisen (skiftlägesokänsliga) för att avgöra om villkoret uppfylls.

equals

string

Värdet för händelsens fält jämförs med det här värdet (skiftlägesokänsligt) för att avgöra om villkoret uppfylls.

field

string

Namnet på aktivitetslogghändelsens fält som villkoret ska undersöka. Möjliga värden för det här fältet är (skiftlägesokänsliga): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" eller något som börjar med "properties".

AlertRuleLeafCondition

Ett regelvillkor för aktivitetsloggavisering som uppfylls genom att jämföra fältet och värdet för en aktivitetslogghändelse. Det här villkoret måste innehålla "field" och antingen "equals" eller "containsAny".

Name Typ Description
containsAny

string[]

Värdet för händelsens fält jämförs med värdena i den här matrisen (skiftlägesokänsliga) för att avgöra om villkoret uppfylls.

equals

string

Värdet för händelsens fält jämförs med det här värdet (skiftlägesokänsligt) för att avgöra om villkoret uppfylls.

field

string

Namnet på aktivitetslogghändelsens fält som villkoret ska undersöka. Möjliga värden för det här fältet är (skiftlägesokänsliga): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" eller något som börjar med "properties".

ErrorResponse

Felsvaret.

Name Typ Description
code

string

Felkoden.

message

string

Felmeddelandet som anger varför åtgärden misslyckades.