Delen via


Activity Log Alerts - Get

Haal een waarschuwingsregel voor activiteitenlogboeken op.

GET 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

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

subscriptionId
path True

string

minLength: 1

De id van het doelabonnement.

api-version
query True

string

minLength: 1

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

Antwoorden

Name Type Description
200 OK

ActivityLogAlertResource

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Er is een fout opgetreden en de waarschuwingsregel voor activiteitenlogboeken kan niet worden opgehaald.

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

Get an Activity Log Alert rule

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ActionGroup

Een aanwijzer naar een Azure-actiegroep.

ActionList

Een lijst met acties voor waarschuwingsregels 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 van een van de volgende typen zijn: Belangrijke: Elk type heeft de unieke subset eigenschappen. Eigenschappen van verschillende typen KUNNEN niet bestaan in één voorwaarde.

  • Bladvoorwaarde: moet veld bevatten en 'is gelijk aan' of 'containsAny'. Let op: 'anyOf' moet niet worden ingesteld in een bladvoorwaarde.
  • AnyOf-voorwaarde: mag alleen 'anyOf' (een matrix van Leaf-voorwaarden). Let op: 'veld', 'is gelijk aan' en 'containsAny' moet niet worden ingesteld in een AnyOf-voorwaarde.
AlertRuleLeafCondition

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

ErrorResponse

Het foutbericht.

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 acties voor waarschuwingsregels 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 Wereldwijd, 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 waardoor deze waarschuwing wordt geactiveerd.

properties.description

string

Een beschrijving van deze waarschuwingsregel voor activiteitenlogboeken.

properties.enabled

boolean

True

Geeft aan of deze waarschuwingsregel voor activiteitenlogboek is ingeschakeld. Als een waarschuwingsregel voor activiteitenlogboeken niet is ingeschakeld, wordt geen van de bijbehorende acties geactiveerd.

properties.scopes

string[]

Een lijst met resource-id's die worden gebruikt als voorvoegsels. De waarschuwing is alleen van toepassing op gebeurtenissen in het activiteitenlogboek 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 voorwaarden voor waarschuwingsregels voor activiteitenlogboeken.

AlertRuleAnyOfOrLeafCondition

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

  • Bladvoorwaarde: moet veld bevatten en 'is gelijk aan' of 'containsAny'. Let op: 'anyOf' moet niet worden ingesteld in een bladvoorwaarde.
  • AnyOf-voorwaarde: mag alleen 'anyOf' (een matrix van Leaf-voorwaarden). Let op: 'veld', 'is gelijk aan' en 'containsAny' moet niet worden ingesteld in een AnyOf-voorwaarde.
Name Type Description
anyOf

AlertRuleLeafCondition[]

Een waarschuwingsregel voor activiteitenlogboeken 'anyOf'-voorwaarde.
Een waarschuwingsregelvoorwaarde voor activiteitenlogboeken waaraan wordt voldaan wanneer aan ten minste één van de bladvoorwaarden van het lid wordt voldaan.

containsAny

string[]

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

equals

string

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

field

string

De naam van het veld van het activiteitenlogboek dat door deze voorwaarde wordt onderzocht. De mogelijke waarden voor dit veld zijn (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 het 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 (hoofdlettergevoelig) om te bepalen of aan de voorwaarde wordt voldaan.

equals

string

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

field

string

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

ErrorResponse

Het foutbericht.

Name Type Description
code

string

De foutcode.

message

string

Het foutbericht dat aangeeft waarom de bewerking is mislukt.