Delen via

Activity Log Alerts - Create Or Update

  • Referentie
Service:
Monitor
API-versie:
2020-10-01

Maak een nieuwe waarschuwingsregel voor activiteitenlogboeken of werk een bestaande bij.

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

URI-parameters

Name In Vereist Type Description
activityLogAlertName
 path True

string

De naam van de waarschuwingsregel voor het activiteitenlogboek.
resourceGroupName
 path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
subscriptionId
 path True

string

De id van het doelabonnement.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name Vereist Type Description
properties.actions True

ActionList

De acties die worden geactiveerd wanneer aan de voorwaarde wordt voldaan.
properties.condition True

AlertRuleAllOfCondition

De voorwaarde die ervoor zorgt dat deze waarschuwing wordt geactiveerd.
properties.scopes True

string[]

Een lijst met resource-id's die als voorvoegsels worden gebruikt. De waarschuwing is alleen van toepassing op activiteitenlogboekgebeurtenissen met resource-id's die onder een van deze voorvoegsels vallen. Deze lijst moet ten minste één item bevatten.
location

string

De locatie van de resource. Waarschuwingsregels voor Azure-activiteitenlogboeken worden ondersteund in de regio's Algemeen, Europa - west en Europa - noord.
properties.description

string

Een beschrijving van deze waarschuwingsregel voor activiteitenlogboeken.
properties.enabled

boolean

Geeft aan of deze waarschuwingsregel voor activiteitenlogboeken is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, worden geen van de acties geactiveerd.
tags

object

De tags van de resource.

Antwoorden

Name Type Description
200 OK

ActivityLogAlertResource

Een bestaande waarschuwingsregel voor activiteitenlogboeken is bijgewerkt.
201 Created

ActivityLogAlertResource

Er is een nieuwe waarschuwingsregel voor activiteitenlogboeken gemaakt.
Other Status Codes

ErrorResponse

Er is een fout opgetreden en de waarschuwingsregel voor activiteitenlogboeken kan niet worden gemaakt of bijgewerkt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200 
{
  "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."
  }
}
Statuscode:
201 
{
  "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'

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
200 
{
  "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'."
  }
}
Statuscode:
201 
{
  "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'."
  }
}

Definities

Name Description
ActionGroup

Een aanwijzer naar een Azure-actiegroep.
ActionList

Een lijst met waarschuwingsregelacties voor activiteitenlogboeken.
ActivityLogAlertResource

Een resource voor waarschuwingsregel voor activiteitenlogboeken.
AlertRuleAllOfCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan.
AlertRuleAnyOfOrLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan. Elke voorwaarde kan een van de volgende typen hebben: Belangrijk: elk type heeft een unieke subset van eigenschappen. Eigenschappen van verschillende typen KUNNEN NIET in één voorwaarde bestaan.

  • Bladvoorwaarde: moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'. Houd er rekening mee dat 'anyOf' niet mag worden ingesteld in een bladvoorwaarde.
  • AnyOf Condition- mag alleen 'anyOf' bevatten (dit is een matrix van Bladvoorwaarden). Houd er rekening mee dat 'field', 'equals' en 'containsAny' niet mogen worden ingesteld in een AnyOf-voorwaarde.
AlertRuleLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan door het veld en de waarde van een gebeurtenis in een activiteitenlogboek te vergelijken. Deze voorwaarde moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'.
ErrorResponse

Het antwoord op de fout.

ActionGroup

Een aanwijzer naar een Azure-actiegroep.

Name Type Description
actionGroupId

string

De resource-id van de actiegroep. Dit mag niet null of leeg zijn.
webhookProperties

object

de woordenlijst met aangepaste eigenschappen die moeten worden opgenomen in de postbewerking. Deze gegevens worden toegevoegd aan de nettolading van de webhook.

ActionList

Een lijst met waarschuwingsregelacties voor activiteitenlogboeken.

Name Type Description
actionGroups

ActionGroup[]

De lijst met actiegroepen.

ActivityLogAlertResource

Een resource voor waarschuwingsregel voor activiteitenlogboeken.

Name Type Default value Description
id

string

De resource-id.
location

string

global

De locatie van de resource. Waarschuwingsregels voor Azure-activiteitenlogboeken worden ondersteund in de regio's Algemeen, Europa - west en Europa - noord.
name

string

De naam van de resource.
properties.actions

ActionList

De acties die worden geactiveerd wanneer aan de voorwaarde wordt voldaan.
properties.condition

AlertRuleAllOfCondition

De voorwaarde die ervoor zorgt dat deze waarschuwing wordt geactiveerd.
properties.description

string

Een beschrijving van deze waarschuwingsregel voor activiteitenlogboeken.
properties.enabled

boolean

True

Geeft aan of deze waarschuwingsregel voor activiteitenlogboeken is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, worden geen van de acties geactiveerd.
properties.scopes

string[]

Een lijst met resource-id's die als voorvoegsels worden gebruikt. De waarschuwing is alleen van toepassing op activiteitenlogboekgebeurtenissen met resource-id's die onder een van deze voorvoegsels vallen. Deze lijst moet ten minste één item bevatten.
tags

object

De tags van de resource.
type

string

Het type resource.

AlertRuleAllOfCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan.

Name Type Description
allOf

AlertRuleAnyOfOrLeafCondition[]

De lijst met regels voor waarschuwingen voor activiteitenlogboeken.

AlertRuleAnyOfOrLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan alle lidvoorwaarden wordt voldaan. Elke voorwaarde kan een van de volgende typen hebben: Belangrijk: elk type heeft een unieke subset van eigenschappen. Eigenschappen van verschillende typen KUNNEN NIET in één voorwaarde bestaan.

  • Bladvoorwaarde: moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'. Houd er rekening mee dat 'anyOf' niet mag worden ingesteld in een bladvoorwaarde.
  • AnyOf Condition- mag alleen 'anyOf' bevatten (dit is een matrix van Bladvoorwaarden). Houd er rekening mee dat 'field', 'equals' en 'containsAny' niet mogen worden ingesteld in een AnyOf-voorwaarde.
Name Type Description
anyOf

AlertRuleLeafCondition[]

Een waarschuwingsregel voor activiteitenlogboek 'anyOf'-voorwaarde.
Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan ten minste één van de lidbladvoorwaarden wordt voldaan.
containsAny

string[]

De waarde van het veld van de gebeurtenis wordt vergeleken met de waarden in deze matrix (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde is voldaan.
equals

string

De waarde van het veld van de gebeurtenis wordt vergeleken met deze waarde (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde wordt voldaan.
field

string

De naam van het veld van de gebeurtenis activiteitenlogboek dat door deze voorwaarde wordt onderzocht. De mogelijke waarden voor dit veld zijn (niet hoofdlettergevoelig): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' of iets dat begint met 'properties'.

AlertRuleLeafCondition

Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan door het veld en de waarde van een gebeurtenis in een activiteitenlogboek te vergelijken. Deze voorwaarde moet 'veld' bevatten en 'is gelijk aan' of 'containsAny'.

Name Type Description
containsAny

string[]

De waarde van het veld van de gebeurtenis wordt vergeleken met de waarden in deze matrix (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde is voldaan.
equals

string

De waarde van het veld van de gebeurtenis wordt vergeleken met deze waarde (niet hoofdlettergevoelig) om te bepalen of aan de voorwaarde wordt voldaan.
field

string

De naam van het veld van de gebeurtenis activiteitenlogboek dat door deze voorwaarde wordt onderzocht. De mogelijke waarden voor dit veld zijn (niet hoofdlettergevoelig): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType' of iets dat begint met 'properties'.

ErrorResponse

Het antwoord op de fout.

Name Type Description
code

string

De foutcode.
message

string

Het foutbericht dat aangeeft waarom de bewerking is mislukt.