Sdílet prostřednictvím


Activity Log Alerts - Create Or Update

Vytvořte nové pravidlo upozornění protokolu aktivit nebo aktualizujte existující pravidlo.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
activityLogAlertName
path True

string

Název pravidla upozornění protokolu aktivit.

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name Vyžadováno Typ Description
properties.actions True

ActionList

Akce, které se aktivují při splnění podmínky.

properties.condition True

AlertRuleAllOfCondition

Podmínka, která způsobí aktivaci tohoto upozornění.

properties.scopes True

string[]

Seznam ID prostředků, které se použijí jako předpony. Upozornění se bude vztahovat pouze na události protokolu aktivit s ID prostředků, které spadají pod jednu z těchto předpon. Tento seznam musí obsahovat alespoň jednu položku.

location

string

Umístění prostředku. Pravidla upozornění protokolu aktivit Azure se podporují v oblastech Globální, Západní Evropa a Severní Evropa.

properties.description

string

Popis tohoto pravidla upozornění protokolu aktivit.

properties.enabled

boolean

Označuje, jestli je toto pravidlo upozornění protokolu aktivit povolené. Pokud pravidlo upozornění protokolu aktivit není povolené, nebude aktivována žádná z jeho akcí.

tags

object

Značky prostředku.

Odpovědi

Name Typ Description
200 OK

ActivityLogAlertResource

Existující pravidlo upozornění protokolu aktivit bylo úspěšně aktualizováno.

201 Created

ActivityLogAlertResource

Nové pravidlo upozornění protokolu aktivit bylo úspěšně vytvořeno.

Other Status Codes

ErrorResponse

Došlo k chybě a pravidlo upozornění protokolu aktivit nebylo možné vytvořit nebo aktualizovat.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
ActionGroup

Ukazatel na skupinu akcí Azure.

ActionList

Seznam akcí pravidla upozornění protokolu aktivit.

ActivityLogAlertResource

Prostředek pravidla upozornění protokolu aktivit.

AlertRuleAllOfCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky.

AlertRuleAnyOfOrLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky. Každá podmínka může mít jeden z následujících typů: Důležité: Každý typ má svou jedinečnou podmnožinu vlastností. Vlastnosti z různých typů NEMOHOU existovat v jedné podmínce.

  • Podmínka listu – musí obsahovat pole a buď "rovná se", nebo "containsAny". Upozorňujeme, že parametr anyOf by neměl být nastaven v podmínce listu.
  • Podmínka AnyOf – musí obsahovat pouze hodnotu anyOf (což je pole podmínek listu). Mějte na paměti, že "field", "equals" a "containsAny" by neměly být nastaveny v podmínce AnyOf.
AlertRuleLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna porovnáním pole a hodnoty události protokolu aktivit. Tato podmínka musí obsahovat pole a buď "rovná se", nebo "containsAny".

ErrorResponse

Odpověď na chybu.

ActionGroup

Ukazatel na skupinu akcí Azure.

Name Typ Description
actionGroupId

string

ID prostředku skupiny akcí. Tato hodnota nesmí být null nebo prázdná.

webhookProperties

object

slovník vlastních vlastností, které se mají zahrnout do operace post. Tato data jsou připojena k datové části webhooku.

ActionList

Seznam akcí pravidla upozornění protokolu aktivit.

Name Typ Description
actionGroups

ActionGroup[]

Seznam skupin akcí.

ActivityLogAlertResource

Prostředek pravidla upozornění protokolu aktivit.

Name Typ Default value Description
id

string

ID prostředku.

location

string

global

Umístění prostředku. Pravidla upozornění protokolu aktivit Azure se podporují v oblastech Globální, Západní Evropa a Severní Evropa.

name

string

Název prostředku.

properties.actions

ActionList

Akce, které se aktivují při splnění podmínky.

properties.condition

AlertRuleAllOfCondition

Podmínka, která způsobí aktivaci tohoto upozornění.

properties.description

string

Popis tohoto pravidla upozornění protokolu aktivit.

properties.enabled

boolean

True

Označuje, jestli je toto pravidlo upozornění protokolu aktivit povolené. Pokud pravidlo upozornění protokolu aktivit není povolené, nebude aktivována žádná z jeho akcí.

properties.scopes

string[]

Seznam ID prostředků, které se použijí jako předpony. Upozornění se bude vztahovat pouze na události protokolu aktivit s ID prostředků, které spadají pod jednu z těchto předpon. Tento seznam musí obsahovat alespoň jednu položku.

tags

object

Značky prostředku.

type

string

Typ prostředku.

AlertRuleAllOfCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky.

Name Typ Description
allOf

AlertRuleAnyOfOrLeafCondition[]

Seznam podmínek pravidla upozornění protokolu aktivit.

AlertRuleAnyOfOrLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna, když jsou splněny všechny jeho členské podmínky. Každá podmínka může mít jeden z následujících typů: Důležité: Každý typ má svou jedinečnou podmnožinu vlastností. Vlastnosti z různých typů NEMOHOU existovat v jedné podmínce.

  • Podmínka listu – musí obsahovat pole a buď "rovná se", nebo "containsAny". Upozorňujeme, že parametr anyOf by neměl být nastaven v podmínce listu.
  • Podmínka AnyOf – musí obsahovat pouze hodnotu anyOf (což je pole podmínek listu). Mějte na paměti, že "field", "equals" a "containsAny" by neměly být nastaveny v podmínce AnyOf.
Name Typ Description
anyOf

AlertRuleLeafCondition[]

Podmínka pravidla upozornění protokolu aktivit anyOf
Podmínka pravidla upozornění protokolu aktivit, která je splněna, pokud je splněna alespoň jedna z podmínek jeho člena listu.

containsAny

string[]

Hodnota pole události bude porovnána s hodnotami v tomto poli (nerozlišují se malá a malá písmena), aby se zjistilo, jestli je podmínka splněna.

equals

string

Hodnota pole události bude porovnána s touto hodnotou (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněna.

field

string

Název pole události protokolu aktivit, které tato podmínka prozkoumá. Možné hodnoty pro toto pole jsou (nerozlišují se malá a velká písmena): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType nebo cokoli, co začíná na vlastnosti.

AlertRuleLeafCondition

Podmínka pravidla upozornění protokolu aktivit, která je splněna porovnáním pole a hodnoty události protokolu aktivit. Tato podmínka musí obsahovat pole a buď "rovná se", nebo "containsAny".

Name Typ Description
containsAny

string[]

Hodnota pole události bude porovnána s hodnotami v tomto poli (nerozlišují se malá a malá písmena), aby se zjistilo, jestli je podmínka splněna.

equals

string

Hodnota pole události bude porovnána s touto hodnotou (nerozlišují se malá a velká písmena), aby se zjistilo, jestli je podmínka splněna.

field

string

Název pole události protokolu aktivit, které tato podmínka prozkoumá. Možné hodnoty pro toto pole jsou (nerozlišují se malá a velká písmena): resourceId, category, caller, level, operationName, resourceGroup, resourceProvider, status, subStatus, resourceType nebo cokoli, co začíná na vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
code

string

Kód chyby

message

string

Chybová zpráva označující, proč operace selhala.