Freigeben über


Activity Log Alerts - Create Or Update

Erstellen Sie eine neue Aktivitätsprotokollwarnungsregel, oder aktualisieren Sie eine vorhandene Regel.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
activityLogAlertName
path True

string

Der Name der Aktivitätsprotokollwarnungsregel.

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name Erforderlich Typ Beschreibung
properties.actions True

ActionList

Die Aktionen, die aktiviert werden, wenn die Bedingung erfüllt ist.

properties.condition True

AlertRuleAllOfCondition

Die Bedingung, die dazu führt, dass diese Warnung aktiviert wird.

properties.scopes True

string[]

Eine Liste der Ressourcen-IDs, die als Präfixe verwendet werden. Die Warnung gilt nur für Aktivitätsprotokollereignisse mit Ressourcen-IDs, die unter eines dieser Präfixe fallen. Diese Liste muss mindestens ein Element enthalten.

location

string

Der Speicherort der Ressource. Azure-Aktivitätsprotokollwarnungsregeln werden in den Regionen "Global", "Europa, Westen" und "Europa, Norden" unterstützt.

properties.description

string

Eine Beschreibung dieser Aktivitätsprotokollwarnungsregel.

properties.enabled

boolean

Gibt an, ob diese Aktivitätsprotokollwarnungsregel aktiviert ist. Wenn eine Aktivitätsprotokollwarnungsregel nicht aktiviert ist, wird keine ihrer Aktionen aktiviert.

tags

object

Die Tags der Ressource.

Antworten

Name Typ Beschreibung
200 OK

ActivityLogAlertResource

Eine vorhandene Aktivitätsprotokollwarnungsregel wurde erfolgreich aktualisiert.

201 Created

ActivityLogAlertResource

Eine neue Aktivitätsprotokollwarnungsregel wurde erfolgreich erstellt.

Other Status Codes

ErrorResponse

Ein Fehler ist aufgetreten, und die Aktivitätsprotokollwarnungsregel konnte nicht erstellt oder aktualisiert werden.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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'

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
ActionGroup

Ein Zeiger auf eine Azure-Aktionsgruppe.

ActionList

Eine Liste der Aktionen für Aktivitätsprotokollwarnungen.

ActivityLogAlertResource

Eine Aktivitätsprotokoll-Warnungsregelressource.

AlertRuleAllOfCondition

Eine Regelbedingung für Aktivitätsprotokollwarnungen, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind.

AlertRuleAnyOfOrLeafCondition

Eine Regelbedingung für Aktivitätsprotokollwarnungen, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind. Jede Bedingung kann einen der folgenden Typen aufweisen: Wichtig: Jeder Typ verfügt über eine eindeutige Teilmenge von Eigenschaften. Eigenschaften aus verschiedenen Typen KÖNNEN NICHT in einer Bedingung vorhanden sein.

  • Blattbedingung: muss "field" und entweder "equals" oder "containsAny" enthalten. Beachten Sie, dass "anyOf" nicht in einer Blattbedingung festgelegt werden darf.
  • AnyOf-Bedingung: darf nur "anyOf" (ein Array von Blattbedingungen) enthalten. Beachten Sie, dass "field", "equals" und "containsAny" nicht in einer AnyOf-Bedingung festgelegt werden dürfen.
AlertRuleLeafCondition

Eine Regelbedingung für aktivitätsprotokollwarnungen, die durch den Vergleich des Felds und des Werts eines Aktivitätsprotokollereignisses erfüllt wird. Diese Bedingung muss "field" und entweder "equals" oder "containsAny" enthalten.

ErrorResponse

Die Fehlerantwort.

ActionGroup

Ein Zeiger auf eine Azure-Aktionsgruppe.

Name Typ Beschreibung
actionGroupId

string

Die Ressourcen-ID der Aktionsgruppe. Dies darf nicht NULL oder leer sein.

webhookProperties

object

das Wörterbuch der benutzerdefinierten Eigenschaften, die in den post-Vorgang eingeschlossen werden sollen. Diese Daten werden an die Webhooknutzlast angefügt.

ActionList

Eine Liste der Aktionen für Aktivitätsprotokollwarnungen.

Name Typ Beschreibung
actionGroups

ActionGroup[]

Die Liste der Aktionsgruppen.

ActivityLogAlertResource

Eine Aktivitätsprotokoll-Warnungsregelressource.

Name Typ Standardwert Beschreibung
id

string

Die Ressourcen-ID.

location

string

global

Der Speicherort der Ressource. Azure-Aktivitätsprotokollwarnungsregeln werden in den Regionen "Global", "Europa, Westen" und "Europa, Norden" unterstützt.

name

string

Der Name der Ressource.

properties.actions

ActionList

Die Aktionen, die aktiviert werden, wenn die Bedingung erfüllt ist.

properties.condition

AlertRuleAllOfCondition

Die Bedingung, die dazu führt, dass diese Warnung aktiviert wird.

properties.description

string

Eine Beschreibung dieser Aktivitätsprotokollwarnungsregel.

properties.enabled

boolean

True

Gibt an, ob diese Aktivitätsprotokollwarnungsregel aktiviert ist. Wenn eine Aktivitätsprotokollwarnungsregel nicht aktiviert ist, wird keine ihrer Aktionen aktiviert.

properties.scopes

string[]

Eine Liste der Ressourcen-IDs, die als Präfixe verwendet werden. Die Warnung gilt nur für Aktivitätsprotokollereignisse mit Ressourcen-IDs, die unter eines dieser Präfixe fallen. Diese Liste muss mindestens ein Element enthalten.

tags

object

Die Tags der Ressource.

type

string

Der Typ der Ressource.

AlertRuleAllOfCondition

Eine Regelbedingung für Aktivitätsprotokollwarnungen, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind.

Name Typ Beschreibung
allOf

AlertRuleAnyOfOrLeafCondition[]

Die Liste der Regelbedingungen für Aktivitätsprotokollwarnungen.

AlertRuleAnyOfOrLeafCondition

Eine Regelbedingung für Aktivitätsprotokollwarnungen, die erfüllt ist, wenn alle Memberbedingungen erfüllt sind. Jede Bedingung kann einen der folgenden Typen aufweisen: Wichtig: Jeder Typ verfügt über eine eindeutige Teilmenge von Eigenschaften. Eigenschaften aus verschiedenen Typen KÖNNEN NICHT in einer Bedingung vorhanden sein.

  • Blattbedingung: muss "field" und entweder "equals" oder "containsAny" enthalten. Beachten Sie, dass "anyOf" nicht in einer Blattbedingung festgelegt werden darf.
  • AnyOf-Bedingung: darf nur "anyOf" (ein Array von Blattbedingungen) enthalten. Beachten Sie, dass "field", "equals" und "containsAny" nicht in einer AnyOf-Bedingung festgelegt werden dürfen.
Name Typ Beschreibung
anyOf

AlertRuleLeafCondition[]

Eine Aktivitätsprotokollwarnungsregel "anyOf"-Bedingung.
Eine Regelbedingung für Aktivitätsprotokollwarnungen, die erfüllt ist, wenn mindestens eine ihrer Memberblattbedingungen erfüllt ist.

containsAny

string[]

Der Wert des Ereignisfelds wird mit den Werten in diesem Array verglichen (ohne Berücksichtigung der Groß-/Kleinschreibung), um zu bestimmen, ob die Bedingung erfüllt ist.

equals

string

Der Wert des Ereignisfelds wird mit diesem Wert verglichen (ohne Berücksichtigung der Groß-/Kleinschreibung), um zu bestimmen, ob die Bedingung erfüllt ist.

field

string

Der Name des Felds des Aktivitätsprotokollereignisses, das von dieser Bedingung untersucht wird. Die möglichen Werte für dieses Feld sind (ohne Beachtung der Groß-/Kleinschreibung): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" oder alles, was mit "properties" beginnt.

AlertRuleLeafCondition

Eine Regelbedingung für aktivitätsprotokollwarnungen, die durch den Vergleich des Felds und des Werts eines Aktivitätsprotokollereignisses erfüllt wird. Diese Bedingung muss "field" und entweder "equals" oder "containsAny" enthalten.

Name Typ Beschreibung
containsAny

string[]

Der Wert des Ereignisfelds wird mit den Werten in diesem Array verglichen (ohne Berücksichtigung der Groß-/Kleinschreibung), um zu bestimmen, ob die Bedingung erfüllt ist.

equals

string

Der Wert des Ereignisfelds wird mit diesem Wert verglichen (ohne Berücksichtigung der Groß-/Kleinschreibung), um zu bestimmen, ob die Bedingung erfüllt ist.

field

string

Der Name des Felds des Aktivitätsprotokollereignisses, das von dieser Bedingung untersucht wird. Die möglichen Werte für dieses Feld sind (ohne Beachtung der Groß-/Kleinschreibung): "resourceId", "category", "caller", "level", "operationName", "resourceGroup", "resourceProvider", "status", "subStatus", "resourceType" oder alles, was mit "properties" beginnt.

ErrorResponse

Die Fehlerantwort.

Name Typ Beschreibung
code

string

Der Fehlercode.

message

string

Die Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.