insights.azure.com/v1api20180301


APIVersion

Value Description
“2018-03-01”

MetricAlert

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Insights/metricAlerts/{ruleName}

Used by: MetricAlertList.

Property Description Type
metav1.TypeMeta
metav1.ObjectMeta
spec MetricAlert_Spec
Optional
status MetricAlert_STATUS
Optional

MetricAlert_Spec

Property Description Type
actions the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. MetricAlertAction[]
Optional
autoMitigate the flag that indicates whether the alert should be auto resolved or not. The default is true. bool
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
criteria defines the specific alert criteria information. MetricAlertCriteria
Required
description the description of the metric alert that will be included in the alert email. string
Optional
enabled the flag that indicates whether the metric alert is enabled. bool
Required
evaluationFrequency how often the metric alert is evaluated represented in ISO 8601 duration format. string
Required
location Resource location string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure MetricAlertOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
scopesReferences the list of resource id’s that this metric alert is scoped to. genruntime.ResourceReference[]
Required
severity Alert severity {0, 1, 2, 3, 4} int
Required
tags Resource tags map[string]string
Optional
targetResourceRegion the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
targetResourceType the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
windowSize the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. string
Required

MetricAlert_STATUS

Property Description Type
actions the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. MetricAlertAction_STATUS[]
Optional
autoMitigate the flag that indicates whether the alert should be auto resolved or not. The default is true. bool
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
criteria defines the specific alert criteria information. MetricAlertCriteria_STATUS
Optional
description the description of the metric alert that will be included in the alert email. string
Optional
enabled the flag that indicates whether the metric alert is enabled. bool
Optional
evaluationFrequency how often the metric alert is evaluated represented in ISO 8601 duration format. string
Optional
id Azure resource Id string
Optional
isMigrated the value indicating whether this alert rule is migrated. bool
Optional
lastUpdatedTime Last time the rule was updated in ISO8601 format. string
Optional
location Resource location string
Optional
name Azure resource name string
Optional
scopes the list of resource id’s that this metric alert is scoped to. string[]
Optional
severity Alert severity {0, 1, 2, 3, 4} int
Optional
tags Resource tags map[string]string
Optional
targetResourceRegion the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
targetResourceType the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
type Azure resource type string
Optional
windowSize the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. string
Optional

MetricAlertList

Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2018-03-01/metricAlert_API.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Insights/metricAlerts/{ruleName}

Property Description Type
metav1.TypeMeta
metav1.ListMeta
items MetricAlert[]
Optional

MetricAlert_Spec

Used by: MetricAlert.

Property Description Type
actions the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. MetricAlertAction[]
Optional
autoMitigate the flag that indicates whether the alert should be auto resolved or not. The default is true. bool
Optional
azureName The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be. string
Optional
criteria defines the specific alert criteria information. MetricAlertCriteria
Required
description the description of the metric alert that will be included in the alert email. string
Optional
enabled the flag that indicates whether the metric alert is enabled. bool
Required
evaluationFrequency how often the metric alert is evaluated represented in ISO 8601 duration format. string
Required
location Resource location string
Required
operatorSpec The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure MetricAlertOperatorSpec
Optional
owner The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource genruntime.KnownResourceReference
Required
scopesReferences the list of resource id’s that this metric alert is scoped to. genruntime.ResourceReference[]
Required
severity Alert severity {0, 1, 2, 3, 4} int
Required
tags Resource tags map[string]string
Optional
targetResourceRegion the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
targetResourceType the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
windowSize the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. string
Required

MetricAlert_STATUS

Used by: MetricAlert.

Property Description Type
actions the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. MetricAlertAction_STATUS[]
Optional
autoMitigate the flag that indicates whether the alert should be auto resolved or not. The default is true. bool
Optional
conditions The observed state of the resource conditions.Condition[]
Optional
criteria defines the specific alert criteria information. MetricAlertCriteria_STATUS
Optional
description the description of the metric alert that will be included in the alert email. string
Optional
enabled the flag that indicates whether the metric alert is enabled. bool
Optional
evaluationFrequency how often the metric alert is evaluated represented in ISO 8601 duration format. string
Optional
id Azure resource Id string
Optional
isMigrated the value indicating whether this alert rule is migrated. bool
Optional
lastUpdatedTime Last time the rule was updated in ISO8601 format. string
Optional
location Resource location string
Optional
name Azure resource name string
Optional
scopes the list of resource id’s that this metric alert is scoped to. string[]
Optional
severity Alert severity {0, 1, 2, 3, 4} int
Optional
tags Resource tags map[string]string
Optional
targetResourceRegion the region of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
targetResourceType the resource type of the target resource(s) on which the alert is created/updated. Mandatory if the scope contains a subscription, resource group, or more than one resource. string
Optional
type Azure resource type string
Optional
windowSize the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. string
Optional

MetricAlertAction

An alert action.

Used by: MetricAlert_Spec.

Property Description Type
actionGroupId the id of the action group to use. string
Optional
webHookProperties This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. map[string]string
Optional

MetricAlertAction_STATUS

An alert action.

Used by: MetricAlert_STATUS.

Property Description Type
actionGroupId the id of the action group to use. string
Optional
webHookProperties This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. map[string]string
Optional

MetricAlertCriteria

Used by: MetricAlert_Spec.

Property Description Type
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria Mutually exclusive with all other properties MetricAlertMultipleResourceMultipleMetricCriteria
Optional
microsoftAzureMonitorSingleResourceMultipleMetricCriteria Mutually exclusive with all other properties MetricAlertSingleResourceMultipleMetricCriteria
Optional
microsoftAzureMonitorWebtestLocationAvailabilityCriteria Mutually exclusive with all other properties WebtestLocationAvailabilityCriteria
Optional

MetricAlertCriteria_STATUS

Used by: MetricAlert_STATUS.

Property Description Type
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria Mutually exclusive with all other properties MetricAlertMultipleResourceMultipleMetricCriteria_STATUS
Optional
microsoftAzureMonitorSingleResourceMultipleMetricCriteria Mutually exclusive with all other properties MetricAlertSingleResourceMultipleMetricCriteria_STATUS
Optional
microsoftAzureMonitorWebtestLocationAvailabilityCriteria Mutually exclusive with all other properties WebtestLocationAvailabilityCriteria_STATUS
Optional

MetricAlertOperatorSpec

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Used by: MetricAlert_Spec.

Property Description Type
configMapExpressions configures where to place operator written dynamic ConfigMaps (created with CEL expressions). core.DestinationExpression[]
Optional
secretExpressions configures where to place operator written dynamic secrets (created with CEL expressions). core.DestinationExpression[]
Optional

MetricAlertMultipleResourceMultipleMetricCriteria

Used by: MetricAlertCriteria.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
allOf the list of multiple metric criteria for this ‘all of’ operation. MultiMetricCriteria[]
Optional
odata.type specifies the type of the alert criteria. MetricAlertMultipleResourceMultipleMetricCriteria_OdataType
Required

MetricAlertMultipleResourceMultipleMetricCriteria_STATUS

Used by: MetricAlertCriteria_STATUS.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
allOf the list of multiple metric criteria for this ‘all of’ operation. MultiMetricCriteria_STATUS[]
Optional
odata.type specifies the type of the alert criteria. MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS
Optional

MetricAlertSingleResourceMultipleMetricCriteria

Used by: MetricAlertCriteria.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
allOf The list of metric criteria for this ‘all of’ operation. MetricCriteria[]
Optional
odata.type specifies the type of the alert criteria. MetricAlertSingleResourceMultipleMetricCriteria_OdataType
Required

MetricAlertSingleResourceMultipleMetricCriteria_STATUS

Used by: MetricAlertCriteria_STATUS.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
allOf The list of metric criteria for this ‘all of’ operation. MetricCriteria_STATUS[]
Optional
odata.type specifies the type of the alert criteria. MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS
Optional

WebtestLocationAvailabilityCriteria

Used by: MetricAlertCriteria.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
componentReference The Application Insights resource Id. genruntime.ResourceReference
Required
failedLocationCount The number of failed locations. float64
Required
odata.type specifies the type of the alert criteria. WebtestLocationAvailabilityCriteria_OdataType
Required
webTestId The Application Insights web test Id. string
Required

WebtestLocationAvailabilityCriteria_STATUS

Used by: MetricAlertCriteria_STATUS.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
componentId The Application Insights resource Id. string
Optional
failedLocationCount The number of failed locations. float64
Optional
odata.type specifies the type of the alert criteria. WebtestLocationAvailabilityCriteria_OdataType_STATUS
Optional
webTestId The Application Insights web test Id. string
Optional

MetricAlertMultipleResourceMultipleMetricCriteria_OdataType

Used by: MetricAlertMultipleResourceMultipleMetricCriteria.

Value Description
“Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria”

MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS

Used by: MetricAlertMultipleResourceMultipleMetricCriteria_STATUS.

Value Description
“Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria”

MetricAlertSingleResourceMultipleMetricCriteria_OdataType

Used by: MetricAlertSingleResourceMultipleMetricCriteria.

Value Description
“Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria”

MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS

Used by: MetricAlertSingleResourceMultipleMetricCriteria_STATUS.

Value Description
“Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria”

MetricCriteria

Used by: MetricAlertSingleResourceMultipleMetricCriteria, and MultiMetricCriteria.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
criterionType Specifies the type of threshold criteria MetricCriteria_CriterionType
Required
dimensions List of dimension conditions. MetricDimension[]
Optional
metricName Name of the metric. string
Required
metricNamespace Namespace of the metric. string
Optional
name Name of the criteria. string
Required
operator the criteria operator. MetricCriteria_Operator
Required
skipMetricValidation Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. bool
Optional
threshold the criteria threshold value that activates the alert. float64
Required
timeAggregation the criteria time aggregation types. MetricCriteria_TimeAggregation
Required

MetricCriteria_STATUS

Used by: MetricAlertSingleResourceMultipleMetricCriteria_STATUS, and MultiMetricCriteria_STATUS.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
criterionType Specifies the type of threshold criteria MetricCriteria_CriterionType_STATUS
Optional
dimensions List of dimension conditions. MetricDimension_STATUS[]
Optional
metricName Name of the metric. string
Optional
metricNamespace Namespace of the metric. string
Optional
name Name of the criteria. string
Optional
operator the criteria operator. MetricCriteria_Operator_STATUS
Optional
skipMetricValidation Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. bool
Optional
threshold the criteria threshold value that activates the alert. float64
Optional
timeAggregation the criteria time aggregation types. MetricCriteria_TimeAggregation_STATUS
Optional

MultiMetricCriteria

Used by: MetricAlertMultipleResourceMultipleMetricCriteria.

Property Description Type
dynamicThresholdCriterion Mutually exclusive with all other properties DynamicMetricCriteria
Optional
staticThresholdCriterion Mutually exclusive with all other properties MetricCriteria
Optional

MultiMetricCriteria_STATUS

Used by: MetricAlertMultipleResourceMultipleMetricCriteria_STATUS.

Property Description Type
dynamicThresholdCriterion Mutually exclusive with all other properties DynamicMetricCriteria_STATUS
Optional
staticThresholdCriterion Mutually exclusive with all other properties MetricCriteria_STATUS
Optional

WebtestLocationAvailabilityCriteria_OdataType

Used by: WebtestLocationAvailabilityCriteria.

Value Description
“Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria”

WebtestLocationAvailabilityCriteria_OdataType_STATUS

Used by: WebtestLocationAvailabilityCriteria_STATUS.

Value Description
“Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria”

DynamicMetricCriteria

Used by: MultiMetricCriteria.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
alertSensitivity The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. DynamicMetricCriteria_AlertSensitivity
Required
criterionType Specifies the type of threshold criteria DynamicMetricCriteria_CriterionType
Required
dimensions List of dimension conditions. MetricDimension[]
Optional
failingPeriods The minimum number of violations required within the selected lookback time window required to raise an alert. DynamicThresholdFailingPeriods
Required
ignoreDataBefore Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format) string
Optional
metricName Name of the metric. string
Required
metricNamespace Namespace of the metric. string
Optional
name Name of the criteria. string
Required
operator The operator used to compare the metric value against the threshold. DynamicMetricCriteria_Operator
Required
skipMetricValidation Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. bool
Optional
timeAggregation the criteria time aggregation types. DynamicMetricCriteria_TimeAggregation
Required

DynamicMetricCriteria_STATUS

Used by: MultiMetricCriteria_STATUS.

Property Description Type
additionalProperties map[string]v1.JSON
Optional
alertSensitivity The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. DynamicMetricCriteria_AlertSensitivity_STATUS
Optional
criterionType Specifies the type of threshold criteria DynamicMetricCriteria_CriterionType_STATUS
Optional
dimensions List of dimension conditions. MetricDimension_STATUS[]
Optional
failingPeriods The minimum number of violations required within the selected lookback time window required to raise an alert. DynamicThresholdFailingPeriods_STATUS
Optional
ignoreDataBefore Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format) string
Optional
metricName Name of the metric. string
Optional
metricNamespace Namespace of the metric. string
Optional
name Name of the criteria. string
Optional
operator The operator used to compare the metric value against the threshold. DynamicMetricCriteria_Operator_STATUS
Optional
skipMetricValidation Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. bool
Optional
timeAggregation the criteria time aggregation types. DynamicMetricCriteria_TimeAggregation_STATUS
Optional

MetricCriteria_CriterionType

Used by: MetricCriteria.

Value Description
“StaticThresholdCriterion”

MetricCriteria_CriterionType_STATUS

Used by: MetricCriteria_STATUS.

Value Description
“StaticThresholdCriterion”

MetricCriteria_Operator

Used by: MetricCriteria.

Value Description
“Equals”
“GreaterThan”
“GreaterThanOrEqual”
“LessThan”
“LessThanOrEqual”

MetricCriteria_Operator_STATUS

Used by: MetricCriteria_STATUS.

Value Description
“Equals”
“GreaterThan”
“GreaterThanOrEqual”
“LessThan”
“LessThanOrEqual”

MetricCriteria_TimeAggregation

Used by: MetricCriteria.

Value Description
“Average”
“Count”
“Maximum”
“Minimum”
“Total”

MetricCriteria_TimeAggregation_STATUS

Used by: MetricCriteria_STATUS.

Value Description
“Average”
“Count”
“Maximum”
“Minimum”
“Total”

MetricDimension

Specifies a metric dimension.

Used by: DynamicMetricCriteria, and MetricCriteria.

Property Description Type
name Name of the dimension. string
Required
operator the dimension operator. Only ‘Include’ and ‘Exclude’ are supported string
Required
values list of dimension values. string[]
Required

MetricDimension_STATUS

Specifies a metric dimension.

Used by: DynamicMetricCriteria_STATUS, and MetricCriteria_STATUS.

Property Description Type
name Name of the dimension. string
Optional
operator the dimension operator. Only ‘Include’ and ‘Exclude’ are supported string
Optional
values list of dimension values. string[]
Optional

DynamicMetricCriteria_AlertSensitivity

Used by: DynamicMetricCriteria.

Value Description
“High”
“Low”
“Medium”

DynamicMetricCriteria_AlertSensitivity_STATUS

Used by: DynamicMetricCriteria_STATUS.

Value Description
“High”
“Low”
“Medium”

DynamicMetricCriteria_CriterionType

Used by: DynamicMetricCriteria.

Value Description
“DynamicThresholdCriterion”

DynamicMetricCriteria_CriterionType_STATUS

Used by: DynamicMetricCriteria_STATUS.

Value Description
“DynamicThresholdCriterion”

DynamicMetricCriteria_Operator

Used by: DynamicMetricCriteria.

Value Description
“GreaterOrLessThan”
“GreaterThan”
“LessThan”

DynamicMetricCriteria_Operator_STATUS

Used by: DynamicMetricCriteria_STATUS.

Value Description
“GreaterOrLessThan”
“GreaterThan”
“LessThan”

DynamicMetricCriteria_TimeAggregation

Used by: DynamicMetricCriteria.

Value Description
“Average”
“Count”
“Maximum”
“Minimum”
“Total”

DynamicMetricCriteria_TimeAggregation_STATUS

Used by: DynamicMetricCriteria_STATUS.

Value Description
“Average”
“Count”
“Maximum”
“Minimum”
“Total”

DynamicThresholdFailingPeriods

The minimum number of violations required within the selected lookback time window required to raise an alert.

Used by: DynamicMetricCriteria.

Property Description Type
minFailingPeriodsToAlert The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. float64
Required
numberOfEvaluationPeriods The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. float64
Required

DynamicThresholdFailingPeriods_STATUS

The minimum number of violations required within the selected lookback time window required to raise an alert.

Used by: DynamicMetricCriteria_STATUS.

Property Description Type
minFailingPeriodsToAlert The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. float64
Optional
numberOfEvaluationPeriods The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. float64
Optional