Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Microsoft.Insights metricAlerts

Remarks

For guidance on deploying monitoring solutions, see Create monitoring resources by using Bicep.

Bicep resource definition

The metricAlerts 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.

Resource format

To create a Microsoft.Insights/metricAlerts resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/metricAlerts@2024-03-01-preview' = {
 identity: {
 type: 'string'
 userAssignedIdentities: {
 {customized property}: {}
 }
 }
 location: 'string'
 name: 'string'
 properties: {
 actionProperties: {
 {customized property}: 'string'
 }
 actions: [
 {
 actionGroupId: 'string'
 webHookProperties: {
 {customized property}: 'string'
 }
 }
 ]
 autoMitigate: bool
 criteria: {
 odata.type: 'string'
 // For remaining properties, see MetricAlertCriteria objects
 }
 customProperties: {
 {customized property}: 'string'
 }
 description: 'string'
 enabled: bool
 evaluationFrequency: 'string'
 resolveConfiguration: {
 autoResolved: bool
 timeToResolve: 'string'
 }
 scopes: [
 'string'
 ]
 severity: int
 targetResourceRegion: 'string'
 targetResourceType: 'string'
 windowSize: 'string'
 }
 tags: {
 {customized property}: 'string'
 }
}

MultiPromQLCriteria objects

Set the criterionType property to specify the type of object.

For DynamicThresholdCriterion, use:

{
 alertSensitivity: 'string'
 criterionType: 'DynamicThresholdCriterion'
 ignoreDataBefore: 'string'
 operator: 'string'
}

For StaticThresholdCriterion, use:

{
 criterionType: 'StaticThresholdCriterion'
}

MultiMetricCriteria objects

Set the criterionType property to specify the type of object.

For DynamicThresholdCriterion, use:

{
 alertSensitivity: 'string'
 criterionType: 'DynamicThresholdCriterion'
 failingPeriods: {
 minFailingPeriodsToAlert: int
 numberOfEvaluationPeriods: int
 }
 ignoreDataBefore: 'string'
 operator: 'string'
}

For StaticThresholdCriterion, use:

{
 criterionType: 'StaticThresholdCriterion'
 operator: 'string'
 threshold: int
}

MetricAlertCriteria objects

Set the odata.type property to specify the type of object.

For Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria, use:

{
 allOf: [
 {
 dimensions: [
 {
 name: 'string'
 operator: 'string'
 values: [
 'string'
 ]
 }
 ]
 metricName: 'string'
 metricNamespace: 'string'
 name: 'string'
 skipMetricValidation: bool
 timeAggregation: 'string'
 criterionType: 'string'
 // For remaining properties, see MultiMetricCriteria objects
 }
 ]
 odata.type: 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'
}

For Microsoft.Azure.Monitor.PromQLCriteria, use:

{
 allOf: [
 {
 name: 'string'
 query: 'string'
 criterionType: 'string'
 // For remaining properties, see MultiPromQLCriteria objects
 }
 ]
 failingPeriods: {
 for: 'string'
 }
 odata.type: 'Microsoft.Azure.Monitor.PromQLCriteria'
}

For Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria, use:

{
 allOf: [
 {
 criterionType: 'string'
 dimensions: [
 {
 name: 'string'
 operator: 'string'
 values: [
 'string'
 ]
 }
 ]
 metricName: 'string'
 metricNamespace: 'string'
 name: 'string'
 operator: 'string'
 skipMetricValidation: bool
 threshold: int
 timeAggregation: 'string'
 }
 ]
 odata.type: 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'
}

For Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria, use:

{
 componentId: 'string'
 failedLocationCount: int
 odata.type: 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
 webTestId: 'string'
}

Property Values