Condividi tramite

Activity Log Alerts - Create Or Update

  • Riferimento
Servizio:
Monitor
Versione API:
2020-10-01

Creare una nuova regola di avviso del log attività o aggiornare una regola esistente.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
activityLogAlertName
 path True

string

Nome della regola di avviso del log attività.
resourceGroupName
 path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
subscriptionId
 path True

string

ID della sottoscrizione di destinazione.
api-version
 query True

string

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Necessario Tipo Descrizione
properties.actions True

ActionList

Azioni che verranno attivate quando viene soddisfatta la condizione.
properties.condition True

AlertRuleAllOfCondition

Condizione che causerà l'attivazione dell'avviso.
properties.scopes True

string[]

Elenco di ID risorsa che verranno usati come prefissi. L'avviso verrà applicato solo agli eventi del log attività con ID risorsa che rientrano in uno di questi prefissi. Questo elenco deve includere almeno un elemento.
location

string

Il percorso della risorsa. Le regole di avviso del log attività di Azure sono supportate nelle aree Globali, Europa occidentale ed Europa settentrionale.
properties.description

string

Descrizione di questa regola di avviso del log attività.
properties.enabled

boolean

Indica se questa regola di avviso del log attività è abilitata. Se una regola di avviso del log attività non è abilitata, nessuna delle relative azioni verrà attivata.
tags

object

Tag della risorsa.

Risposte

Nome Tipo Descrizione
200 OK

ActivityLogAlertResource

Una regola di avviso del log attività esistente è stata aggiornata correttamente.
201 Created

ActivityLogAlertResource

È stata creata una nuova regola di avviso del log attività.
Other Status Codes

ErrorResponse

Si è verificato un errore e non è stato possibile creare o aggiornare la regola di avviso del log attività.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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."
  }
}
Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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."
  }
}
Codice di stato:
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'

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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'."
  }
}
Codice di stato:
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'."
  }
}

Definizioni

Nome Descrizione
ActionGroup

Puntatore a un gruppo di azioni di Azure.
ActionList

Elenco delle azioni delle regole di avviso del log attività.
ActivityLogAlertResource

Risorsa regola avviso log attività.
AlertRuleAllOfCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro.
AlertRuleAnyOfOrLeafCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro. Ogni condizione può essere di uno dei tipi seguenti: Importante: ogni tipo ha un sottoinsieme univoco di proprietà. Le proprietà di tipi diversi NON POSSONO esistere in una condizione.

  • Condizione foglia: deve contenere 'field' e 'equals' o 'containsAny'. Si noti che 'anyOf' non deve essere impostato in una condizione foglia.
  • AnyOf Condition: deve contenere solo 'anyOf', ovvero una matrice di condizioni foglia. Si noti che 'field', 'equals' e 'containsAny' non devono essere impostati in una condizione AnyOf.
AlertRuleLeafCondition

Condizione della regola di avviso del log attività soddisfatta confrontando il campo e il valore di un evento del log attività. Questa condizione deve contenere 'field' e 'equals' o 'containsAny'.
ErrorResponse

Risposta di errore.

ActionGroup

Puntatore a un gruppo di azioni di Azure.

Nome Tipo Descrizione
actionGroupId

string

ID risorsa del gruppo di azioni. Non può essere null o vuoto.
webhookProperties

object

dizionario delle proprietà personalizzate da includere con l'operazione post. Questi dati vengono aggiunti al payload del webhook.

ActionList

Elenco delle azioni delle regole di avviso del log attività.

Nome Tipo Descrizione
actionGroups

ActionGroup[]

Elenco dei gruppi di azioni.

ActivityLogAlertResource

Risorsa regola avviso log attività.

Nome Tipo Valore predefinito Descrizione
id

string

ID risorsa.
location

string

global

Il percorso della risorsa. Le regole di avviso del log attività di Azure sono supportate nelle aree Globali, Europa occidentale ed Europa settentrionale.
name

string

Nome della risorsa.
properties.actions

ActionList

Azioni che verranno attivate quando viene soddisfatta la condizione.
properties.condition

AlertRuleAllOfCondition

Condizione che causerà l'attivazione dell'avviso.
properties.description

string

Descrizione di questa regola di avviso del log attività.
properties.enabled

boolean

True

Indica se questa regola di avviso del log attività è abilitata. Se una regola di avviso del log attività non è abilitata, nessuna delle relative azioni verrà attivata.
properties.scopes

string[]

Elenco di ID risorsa che verranno usati come prefissi. L'avviso verrà applicato solo agli eventi del log attività con ID risorsa che rientrano in uno di questi prefissi. Questo elenco deve includere almeno un elemento.
tags

object

Tag della risorsa.
type

string

Tipo di risorsa.

AlertRuleAllOfCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro.

Nome Tipo Descrizione
allOf

AlertRuleAnyOfOrLeafCondition[]

Elenco delle condizioni delle regole di avviso del log attività.

AlertRuleAnyOfOrLeafCondition

Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte tutte le relative condizioni membro. Ogni condizione può essere di uno dei tipi seguenti: Importante: ogni tipo ha un sottoinsieme univoco di proprietà. Le proprietà di tipi diversi NON POSSONO esistere in una condizione.

  • Condizione foglia: deve contenere 'field' e 'equals' o 'containsAny'. Si noti che 'anyOf' non deve essere impostato in una condizione foglia.
  • AnyOf Condition: deve contenere solo 'anyOf', ovvero una matrice di condizioni foglia. Si noti che 'field', 'equals' e 'containsAny' non devono essere impostati in una condizione AnyOf.
Nome Tipo Descrizione
anyOf

AlertRuleLeafCondition[]

Una regola di avviso del log attività 'anyOf'.
Condizione della regola di avviso del log attività soddisfatta quando vengono soddisfatte almeno una delle relative condizioni foglia membro.
containsAny

string[]

Il valore del campo dell'evento verrà confrontato con i valori di questa matrice (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
equals

string

Il valore del campo dell'evento verrà confrontato con questo valore (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
field

string

Nome del campo dell'evento del log attività che questa condizione esaminerà. I valori possibili per questo campo sono (senza distinzione tra maiuscole e minuscole): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o qualsiasi elemento che inizia con 'properties'.

AlertRuleLeafCondition

Condizione della regola di avviso del log attività soddisfatta confrontando il campo e il valore di un evento del log attività. Questa condizione deve contenere 'field' e 'equals' o 'containsAny'.

Nome Tipo Descrizione
containsAny

string[]

Il valore del campo dell'evento verrà confrontato con i valori di questa matrice (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
equals

string

Il valore del campo dell'evento verrà confrontato con questo valore (senza distinzione tra maiuscole e minuscole) per determinare se la condizione viene soddisfatta.
field

string

Nome del campo dell'evento del log attività che questa condizione esaminerà. I valori possibili per questo campo sono (senza distinzione tra maiuscole e minuscole): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', o qualsiasi elemento che inizia con 'properties'.

ErrorResponse

Risposta di errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.