microsoft.insights activityLogAlerts 2017-04-01
Bicep resource definition
The activityLogAlerts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Remarks
For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.
Resource format
To create a microsoft.insights/activityLogAlerts resource, add the following Bicep to your template.
resource symbolicname 'microsoft.insights/activityLogAlerts@2017-04-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actions: {
actionGroups: [
{
actionGroupId: 'string'
webhookProperties: {
{customized property}: 'string'
}
}
]
}
condition: {
allOf: [
{
equals: 'string'
field: 'string'
}
]
}
description: 'string'
enabled: bool
scopes: [
'string'
]
}
}
Property values
activityLogAlerts
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) Character limit: 1-260 Valid characters: Can't use: <>*%{}&:\\?+/#| or control characters Can't end with space or period. |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| properties | The activity log alert properties of the resource. | ActivityLogAlert |
ActivityLogAlert
| Name | Description | Value |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActivityLogAlertActionList (required) |
| condition | The condition that will cause this alert to activate. | ActivityLogAlertAllOfCondition (required) |
| description | A description of this activity log alert. | string |
| enabled | Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. | bool |
| scopes | A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item. | string[] (required) |
ActivityLogAlertActionList
| Name | Description | Value |
|---|---|---|
| actionGroups | The list of activity log alerts. | ActivityLogAlertActionGroup[] |
ActivityLogAlertActionGroup
| Name | Description | Value |
|---|---|---|
| actionGroupId | The resourceId of the action group. This cannot be null or empty. | string (required) |
| webhookProperties | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | ActivityLogAlertActionGroupWebhookProperties |
ActivityLogAlertActionGroupWebhookProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ActivityLogAlertAllOfCondition
| Name | Description | Value |
|---|---|---|
| allOf | The list of activity log alert conditions. | ActivityLogAlertLeafCondition[] (required) |
ActivityLogAlertLeafCondition
| Name | Description | Value |
|---|---|---|
| equals | The field value will be compared to this value (case-insensitive) to determine if the condition is met. | string (required) |
| field | The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'. | string (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Alert for misconfigured Key Vault on Application Gateway |
Use such templates to easily create some important event alerts for your Azure Application Gateway. |
| AKS Cluster with a NAT Gateway and an Application Gateway |
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections. |
| Deploy an Autoscale Activity Log Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any Autoscale records in the Azure Activity Log |
| Deploy an Autoscale Failed Activity Log Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any failed Autoscale records in the Azure Activity Log |
| Deploy a Service Health Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any Service Health records in the Azure Activity Log |
| Create a Private AKS Cluster with a Public DNS Zone |
This sample shows how to a deploy a private AKS cluster with a Public DNS Zone. |
| Creates an Azure service alert |
This template creates an Azure service health alert that optionally sends emails to service administrators and specified email addresses in the event of cerain Azure service outages. |
| AKS cluster with the Application Gateway Ingress Controller |
This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault |
ARM template resource definition
The activityLogAlerts resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Remarks
For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.
Resource format
To create a microsoft.insights/activityLogAlerts resource, add the following JSON to your template.
{
"type": "microsoft.insights/activityLogAlerts",
"apiVersion": "2017-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actions": {
"actionGroups": [
{
"actionGroupId": "string",
"webhookProperties": {
"{customized property}": "string"
}
}
]
},
"condition": {
"allOf": [
{
"equals": "string",
"field": "string"
}
]
},
"description": "string",
"enabled": "bool",
"scopes": [ "string" ]
}
}
Property values
activityLogAlerts
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'microsoft.insights/activityLogAlerts' |
| apiVersion | The resource api version | '2017-04-01' |
| name | The resource name | string (required) Character limit: 1-260 Valid characters: Can't use: <>*%{}&:\\?+/#| or control characters Can't end with space or period. |
| location | Resource location | string (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| properties | The activity log alert properties of the resource. | ActivityLogAlert |
ActivityLogAlert
| Name | Description | Value |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActivityLogAlertActionList (required) |
| condition | The condition that will cause this alert to activate. | ActivityLogAlertAllOfCondition (required) |
| description | A description of this activity log alert. | string |
| enabled | Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. | bool |
| scopes | A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item. | string[] (required) |
ActivityLogAlertActionList
| Name | Description | Value |
|---|---|---|
| actionGroups | The list of activity log alerts. | ActivityLogAlertActionGroup[] |
ActivityLogAlertActionGroup
| Name | Description | Value |
|---|---|---|
| actionGroupId | The resourceId of the action group. This cannot be null or empty. | string (required) |
| webhookProperties | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | ActivityLogAlertActionGroupWebhookProperties |
ActivityLogAlertActionGroupWebhookProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ActivityLogAlertAllOfCondition
| Name | Description | Value |
|---|---|---|
| allOf | The list of activity log alert conditions. | ActivityLogAlertLeafCondition[] (required) |
ActivityLogAlertLeafCondition
| Name | Description | Value |
|---|---|---|
| equals | The field value will be compared to this value (case-insensitive) to determine if the condition is met. | string (required) |
| field | The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'. | string (required) |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Alert for misconfigured Key Vault on Application Gateway |
Use such templates to easily create some important event alerts for your Azure Application Gateway. |
| AKS Cluster with a NAT Gateway and an Application Gateway |
This sample shows how to a deploy an AKS cluster with NAT Gateway for outbound connections and an Application Gateway for inbound connections. |
| Deploy an Autoscale Activity Log Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any Autoscale records in the Azure Activity Log |
| Deploy an Autoscale Failed Activity Log Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any failed Autoscale records in the Azure Activity Log |
| Deploy a Service Health Alert |
This template allows you to deploy a simple alert which uses an action group to send email notifications for any Service Health records in the Azure Activity Log |
| Create a Private AKS Cluster with a Public DNS Zone |
This sample shows how to a deploy a private AKS cluster with a Public DNS Zone. |
| Creates an Azure service alert |
This template creates an Azure service health alert that optionally sends emails to service administrators and specified email addresses in the event of cerain Azure service outages. |
| AKS cluster with the Application Gateway Ingress Controller |
This sample shows how to deploy an AKS cluster with Application Gateway, Application Gateway Ingress Controller, Azure Container Registry, Log Analytics and Key Vault |
Terraform (AzAPI provider) resource definition
The activityLogAlerts resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a microsoft.insights/activityLogAlerts resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "microsoft.insights/activityLogAlerts@2017-04-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actions = {
actionGroups = [
{
actionGroupId = "string"
webhookProperties = {
{customized property} = "string"
}
}
]
}
condition = {
allOf = [
{
equals = "string"
field = "string"
}
]
}
description = "string"
enabled = bool
scopes = [
"string"
]
}
})
}
Property values
activityLogAlerts
| Name | Description | Value |
|---|---|---|
| type | The resource type | "microsoft.insights/activityLogAlerts@2017-04-01" |
| name | The resource name | string (required) Character limit: 1-260 Valid characters: Can't use: <>*%{}&:\\?+/#| or control characters Can't end with space or period. |
| location | Resource location | string (required) |
| parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| properties | The activity log alert properties of the resource. | ActivityLogAlert |
ActivityLogAlert
| Name | Description | Value |
|---|---|---|
| actions | The actions that will activate when the condition is met. | ActivityLogAlertActionList (required) |
| condition | The condition that will cause this alert to activate. | ActivityLogAlertAllOfCondition (required) |
| description | A description of this activity log alert. | string |
| enabled | Indicates whether this activity log alert is enabled. If an activity log alert is not enabled, then none of its actions will be activated. | bool |
| scopes | A list of resourceIds that will be used as prefixes. The alert will only apply to activityLogs with resourceIds that fall under one of these prefixes. This list must include at least one item. | string[] (required) |
ActivityLogAlertActionList
| Name | Description | Value |
|---|---|---|
| actionGroups | The list of activity log alerts. | ActivityLogAlertActionGroup[] |
ActivityLogAlertActionGroup
| Name | Description | Value |
|---|---|---|
| actionGroupId | The resourceId of the action group. This cannot be null or empty. | string (required) |
| webhookProperties | the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. | ActivityLogAlertActionGroupWebhookProperties |
ActivityLogAlertActionGroupWebhookProperties
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ActivityLogAlertAllOfCondition
| Name | Description | Value |
|---|---|---|
| allOf | The list of activity log alert conditions. | ActivityLogAlertLeafCondition[] (required) |
ActivityLogAlertLeafCondition
| Name | Description | Value |
|---|---|---|
| equals | The field value will be compared to this value (case-insensitive) to determine if the condition is met. | string (required) |
| field | The name of the field that this condition will examine. The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties.'. | string (required) |