insights.azure.com/v1api20180301
insights.azure.com/v1api20180301
Package v1api20180301 contains API Schema definitions for the insights v1api20180301 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2018-03-01" |
DynamicMetricCriteria
(Appears on:MultiMetricCriteria)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
alertSensitivity DynamicMetricCriteria_AlertSensitivity |
AlertSensitivity: The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. |
criterionType DynamicMetricCriteria_CriterionType |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension |
Dimensions: List of dimension conditions. |
failingPeriods DynamicThresholdFailingPeriods |
FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. |
ignoreDataBefore string |
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) |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator DynamicMetricCriteria_Operator |
Operator: The operator used to compare the metric value against the threshold. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
timeAggregation DynamicMetricCriteria_TimeAggregation |
TimeAggregation: the criteria time aggregation types. |
DynamicMetricCriteria_ARM
(Appears on:MultiMetricCriteria_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
alertSensitivity DynamicMetricCriteria_AlertSensitivity_ARM |
AlertSensitivity: The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. |
criterionType DynamicMetricCriteria_CriterionType_ARM |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_ARM |
Dimensions: List of dimension conditions. |
failingPeriods DynamicThresholdFailingPeriods_ARM |
FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. |
ignoreDataBefore string |
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) |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator DynamicMetricCriteria_Operator_ARM |
Operator: The operator used to compare the metric value against the threshold. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
timeAggregation DynamicMetricCriteria_TimeAggregation_ARM |
TimeAggregation: the criteria time aggregation types. |
DynamicMetricCriteria_AlertSensitivity
(string
alias)
(Appears on:DynamicMetricCriteria)
Value | Description |
---|---|
"High" |
|
"Low" |
|
"Medium" |
DynamicMetricCriteria_AlertSensitivity_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_ARM)
Value | Description |
---|---|
"High" |
|
"Low" |
|
"Medium" |
DynamicMetricCriteria_AlertSensitivity_STATUS
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS)
Value | Description |
---|---|
"High" |
|
"Low" |
|
"Medium" |
DynamicMetricCriteria_AlertSensitivity_STATUS_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"High" |
|
"Low" |
|
"Medium" |
DynamicMetricCriteria_CriterionType
(string
alias)
(Appears on:DynamicMetricCriteria)
Value | Description |
---|---|
"DynamicThresholdCriterion" |
DynamicMetricCriteria_CriterionType_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_ARM)
Value | Description |
---|---|
"DynamicThresholdCriterion" |
DynamicMetricCriteria_CriterionType_STATUS
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS)
Value | Description |
---|---|
"DynamicThresholdCriterion" |
DynamicMetricCriteria_CriterionType_STATUS_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"DynamicThresholdCriterion" |
DynamicMetricCriteria_Operator
(string
alias)
(Appears on:DynamicMetricCriteria)
Value | Description |
---|---|
"GreaterOrLessThan" |
|
"GreaterThan" |
|
"LessThan" |
DynamicMetricCriteria_Operator_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_ARM)
Value | Description |
---|---|
"GreaterOrLessThan" |
|
"GreaterThan" |
|
"LessThan" |
DynamicMetricCriteria_Operator_STATUS
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS)
Value | Description |
---|---|
"GreaterOrLessThan" |
|
"GreaterThan" |
|
"LessThan" |
DynamicMetricCriteria_Operator_STATUS_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"GreaterOrLessThan" |
|
"GreaterThan" |
|
"LessThan" |
DynamicMetricCriteria_STATUS
(Appears on:MultiMetricCriteria_STATUS)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
alertSensitivity DynamicMetricCriteria_AlertSensitivity_STATUS |
AlertSensitivity: The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. |
criterionType DynamicMetricCriteria_CriterionType_STATUS |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_STATUS |
Dimensions: List of dimension conditions. |
failingPeriods DynamicThresholdFailingPeriods_STATUS |
FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. |
ignoreDataBefore string |
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) |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator DynamicMetricCriteria_Operator_STATUS |
Operator: The operator used to compare the metric value against the threshold. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
timeAggregation DynamicMetricCriteria_TimeAggregation_STATUS |
TimeAggregation: the criteria time aggregation types. |
DynamicMetricCriteria_STATUS_ARM
(Appears on:MultiMetricCriteria_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
alertSensitivity DynamicMetricCriteria_AlertSensitivity_STATUS_ARM |
AlertSensitivity: The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. |
criterionType DynamicMetricCriteria_CriterionType_STATUS_ARM |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_STATUS_ARM |
Dimensions: List of dimension conditions. |
failingPeriods DynamicThresholdFailingPeriods_STATUS_ARM |
FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. |
ignoreDataBefore string |
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) |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator DynamicMetricCriteria_Operator_STATUS_ARM |
Operator: The operator used to compare the metric value against the threshold. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
timeAggregation DynamicMetricCriteria_TimeAggregation_STATUS_ARM |
TimeAggregation: the criteria time aggregation types. |
DynamicMetricCriteria_TimeAggregation
(string
alias)
(Appears on:DynamicMetricCriteria)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
DynamicMetricCriteria_TimeAggregation_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_ARM)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
DynamicMetricCriteria_TimeAggregation_STATUS
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
DynamicMetricCriteria_TimeAggregation_STATUS_ARM
(string
alias)
(Appears on:DynamicMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
DynamicThresholdFailingPeriods
(Appears on:DynamicMetricCriteria)
The minimum number of violations required within the selected lookback time window required to raise an alert.
Field | Description |
---|---|
minFailingPeriodsToAlert float64 |
MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. |
numberOfEvaluationPeriods float64 |
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. |
DynamicThresholdFailingPeriods_ARM
(Appears on:DynamicMetricCriteria_ARM)
The minimum number of violations required within the selected lookback time window required to raise an alert.
Field | Description |
---|---|
minFailingPeriodsToAlert float64 |
MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. |
numberOfEvaluationPeriods float64 |
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. |
DynamicThresholdFailingPeriods_STATUS
(Appears on:DynamicMetricCriteria_STATUS)
The minimum number of violations required within the selected lookback time window required to raise an alert.
Field | Description |
---|---|
minFailingPeriodsToAlert float64 |
MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. |
numberOfEvaluationPeriods float64 |
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. |
DynamicThresholdFailingPeriods_STATUS_ARM
(Appears on:DynamicMetricCriteria_STATUS_ARM)
The minimum number of violations required within the selected lookback time window required to raise an alert.
Field | Description |
---|---|
minFailingPeriodsToAlert float64 |
MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. |
numberOfEvaluationPeriods float64 |
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. |
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}p>
Field | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||||||||||||
spec MetricAlert_Spec |
|
||||||||||||||||||||||||||||||
status MetricAlert_STATUS |
MetricAlertAction
(Appears on:MetricAlert_Spec)
An alert action.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: the id of the action group to use. |
webHookProperties map[string]string |
WebHookProperties: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. |
MetricAlertAction_ARM
(Appears on:MetricAlertProperties_ARM)
An alert action.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: the id of the action group to use. |
webHookProperties map[string]string |
WebHookProperties: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. |
MetricAlertAction_STATUS
(Appears on:MetricAlert_STATUS)
An alert action.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: the id of the action group to use. |
webHookProperties map[string]string |
WebHookProperties: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. |
MetricAlertAction_STATUS_ARM
(Appears on:MetricAlertProperties_STATUS_ARM)
An alert action.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: the id of the action group to use. |
webHookProperties map[string]string |
WebHookProperties: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. |
MetricAlertCriteria
(Appears on:MetricAlert_Spec)
Field | Description |
---|---|
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria MetricAlertMultipleResourceMultipleMetricCriteria |
MicrosoftAzureMonitorMultipleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorSingleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria |
MicrosoftAzureMonitorSingleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorWebtestLocationAvailabilityCriteria WebtestLocationAvailabilityCriteria |
MicrosoftAzureMonitorWebtestLocationAvailability: Mutually exclusive with all other properties |
MetricAlertCriteria_ARM
(Appears on:MetricAlertProperties_ARM)
Field | Description |
---|---|
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria MetricAlertMultipleResourceMultipleMetricCriteria_ARM |
MicrosoftAzureMonitorMultipleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorSingleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria_ARM |
MicrosoftAzureMonitorSingleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorWebtestLocationAvailabilityCriteria WebtestLocationAvailabilityCriteria_ARM |
MicrosoftAzureMonitorWebtestLocationAvailability: Mutually exclusive with all other properties |
MetricAlertCriteria_STATUS
(Appears on:MetricAlert_STATUS)
Field | Description |
---|---|
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria MetricAlertMultipleResourceMultipleMetricCriteria_STATUS |
MicrosoftAzureMonitorMultipleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorSingleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria_STATUS |
MicrosoftAzureMonitorSingleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorWebtestLocationAvailabilityCriteria WebtestLocationAvailabilityCriteria_STATUS |
MicrosoftAzureMonitorWebtestLocationAvailability: Mutually exclusive with all other properties |
MetricAlertCriteria_STATUS_ARM
(Appears on:MetricAlertProperties_STATUS_ARM)
Field | Description |
---|---|
microsoftAzureMonitorMultipleResourceMultipleMetricCriteria MetricAlertMultipleResourceMultipleMetricCriteria_STATUS_ARM |
MicrosoftAzureMonitorMultipleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorSingleResourceMultipleMetricCriteria MetricAlertSingleResourceMultipleMetricCriteria_STATUS_ARM |
MicrosoftAzureMonitorSingleResourceMultipleMetric: Mutually exclusive with all other properties |
microsoftAzureMonitorWebtestLocationAvailabilityCriteria WebtestLocationAvailabilityCriteria_STATUS_ARM |
MicrosoftAzureMonitorWebtestLocationAvailability: Mutually exclusive with all other properties |
MetricAlertMultipleResourceMultipleMetricCriteria
(Appears on:MetricAlertCriteria)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MultiMetricCriteria |
AllOf: the list of multiple metric criteria for this ‘all of’ operation. |
odata.type MetricAlertMultipleResourceMultipleMetricCriteria_OdataType |
OdataType: specifies the type of the alert criteria. |
MetricAlertMultipleResourceMultipleMetricCriteria_ARM
(Appears on:MetricAlertCriteria_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MultiMetricCriteria_ARM |
AllOf: the list of multiple metric criteria for this ‘all of’ operation. |
odata.type MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_ARM |
OdataType: specifies the type of the alert criteria. |
MetricAlertMultipleResourceMultipleMetricCriteria_OdataType
(string
alias)
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" |
MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_ARM
(string
alias)
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" |
MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS
(string
alias)
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_STATUS)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" |
MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS_ARM
(string
alias)
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" |
MetricAlertMultipleResourceMultipleMetricCriteria_STATUS
(Appears on:MetricAlertCriteria_STATUS)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MultiMetricCriteria_STATUS |
AllOf: the list of multiple metric criteria for this ‘all of’ operation. |
odata.type MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS |
OdataType: specifies the type of the alert criteria. |
MetricAlertMultipleResourceMultipleMetricCriteria_STATUS_ARM
(Appears on:MetricAlertCriteria_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MultiMetricCriteria_STATUS_ARM |
AllOf: the list of multiple metric criteria for this ‘all of’ operation. |
odata.type MetricAlertMultipleResourceMultipleMetricCriteria_OdataType_STATUS_ARM |
OdataType: specifies the type of the alert criteria. |
MetricAlertProperties_ARM
(Appears on:MetricAlert_Spec_ARM)
An alert rule.
Field | Description |
---|---|
actions []MetricAlertAction_ARM |
Actions: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
autoMitigate bool |
AutoMitigate: the flag that indicates whether the alert should be auto resolved or not. The default is true. |
criteria MetricAlertCriteria_ARM |
Criteria: defines the specific alert criteria information. |
description string |
Description: the description of the metric alert that will be included in the alert email. |
enabled bool |
Enabled: the flag that indicates whether the metric alert is enabled. |
evaluationFrequency string |
EvaluationFrequency: how often the metric alert is evaluated represented in ISO 8601 duration format. |
scopes []string |
|
severity int |
Severity: Alert severity {0, 1, 2, 3, 4} |
targetResourceRegion string |
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. |
targetResourceType string |
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. |
windowSize string |
WindowSize: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. |
MetricAlertProperties_STATUS_ARM
(Appears on:MetricAlert_STATUS_ARM)
An alert rule.
Field | Description |
---|---|
actions []MetricAlertAction_STATUS_ARM |
Actions: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
autoMitigate bool |
AutoMitigate: the flag that indicates whether the alert should be auto resolved or not. The default is true. |
criteria MetricAlertCriteria_STATUS_ARM |
Criteria: defines the specific alert criteria information. |
description string |
Description: the description of the metric alert that will be included in the alert email. |
enabled bool |
Enabled: the flag that indicates whether the metric alert is enabled. |
evaluationFrequency string |
EvaluationFrequency: how often the metric alert is evaluated represented in ISO 8601 duration format. |
isMigrated bool |
IsMigrated: the value indicating whether this alert rule is migrated. |
lastUpdatedTime string |
LastUpdatedTime: Last time the rule was updated in ISO8601 format. |
scopes []string |
Scopes: the list of resource id’s that this metric alert is scoped to. |
severity int |
Severity: Alert severity {0, 1, 2, 3, 4} |
targetResourceRegion string |
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. |
targetResourceType string |
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. |
windowSize string |
WindowSize: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. |
MetricAlertSingleResourceMultipleMetricCriteria
(Appears on:MetricAlertCriteria)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MetricCriteria |
AllOf: The list of metric criteria for this ‘all of’ operation. |
odata.type MetricAlertSingleResourceMultipleMetricCriteria_OdataType |
OdataType: specifies the type of the alert criteria. |
MetricAlertSingleResourceMultipleMetricCriteria_ARM
(Appears on:MetricAlertCriteria_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MetricCriteria_ARM |
AllOf: The list of metric criteria for this ‘all of’ operation. |
odata.type MetricAlertSingleResourceMultipleMetricCriteria_OdataType_ARM |
OdataType: specifies the type of the alert criteria. |
MetricAlertSingleResourceMultipleMetricCriteria_OdataType
(string
alias)
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" |
MetricAlertSingleResourceMultipleMetricCriteria_OdataType_ARM
(string
alias)
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" |
MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS
(string
alias)
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_STATUS)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" |
MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS_ARM
(string
alias)
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" |
MetricAlertSingleResourceMultipleMetricCriteria_STATUS
(Appears on:MetricAlertCriteria_STATUS)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MetricCriteria_STATUS |
AllOf: The list of metric criteria for this ‘all of’ operation. |
odata.type MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS |
OdataType: specifies the type of the alert criteria. |
MetricAlertSingleResourceMultipleMetricCriteria_STATUS_ARM
(Appears on:MetricAlertCriteria_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
allOf []MetricCriteria_STATUS_ARM |
AllOf: The list of metric criteria for this ‘all of’ operation. |
odata.type MetricAlertSingleResourceMultipleMetricCriteria_OdataType_STATUS_ARM |
OdataType: specifies the type of the alert criteria. |
MetricAlert_STATUS
(Appears on:MetricAlert)
Field | Description |
---|---|
actions []MetricAlertAction_STATUS |
Actions: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
autoMitigate bool |
AutoMitigate: the flag that indicates whether the alert should be auto resolved or not. The default is true. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
criteria MetricAlertCriteria_STATUS |
Criteria: defines the specific alert criteria information. |
description string |
Description: the description of the metric alert that will be included in the alert email. |
enabled bool |
Enabled: the flag that indicates whether the metric alert is enabled. |
evaluationFrequency string |
EvaluationFrequency: how often the metric alert is evaluated represented in ISO 8601 duration format. |
id string |
Id: Azure resource Id |
isMigrated bool |
IsMigrated: the value indicating whether this alert rule is migrated. |
lastUpdatedTime string |
LastUpdatedTime: Last time the rule was updated in ISO8601 format. |
location string |
Location: Resource location |
name string |
Name: Azure resource name |
scopes []string |
Scopes: the list of resource id’s that this metric alert is scoped to. |
severity int |
Severity: Alert severity {0, 1, 2, 3, 4} |
tags map[string]string |
Tags: Resource tags |
targetResourceRegion string |
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. |
targetResourceType string |
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. |
type string |
Type: Azure resource type |
windowSize string |
WindowSize: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. |
MetricAlert_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Azure resource Id |
location string |
Location: Resource location |
name string |
Name: Azure resource name |
properties MetricAlertProperties_STATUS_ARM |
Properties: The alert rule properties of the resource. |
tags map[string]string |
Tags: Resource tags |
type string |
Type: Azure resource type |
MetricAlert_Spec
(Appears on:MetricAlert)
Field | Description |
---|---|
actions []MetricAlertAction |
Actions: the array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
autoMitigate bool |
AutoMitigate: the flag that indicates whether the alert should be auto resolved or not. The default is true. |
azureName string |
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. |
criteria MetricAlertCriteria |
Criteria: defines the specific alert criteria information. |
description string |
Description: the description of the metric alert that will be included in the alert email. |
enabled bool |
Enabled: the flag that indicates whether the metric alert is enabled. |
evaluationFrequency string |
EvaluationFrequency: how often the metric alert is evaluated represented in ISO 8601 duration format. |
location string |
Location: Resource location |
owner genruntime.KnownResourceReference |
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 |
scopesReferences []genruntime.ResourceReference |
ScopesReferences: the list of resource id’s that this metric alert is scoped to. |
severity int |
Severity: Alert severity {0, 1, 2, 3, 4} |
tags map[string]string |
Tags: Resource tags |
targetResourceRegion string |
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. |
targetResourceType string |
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. |
windowSize string |
WindowSize: the period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. |
MetricAlert_Spec_ARM
Field | Description |
---|---|
location string |
Location: Resource location |
name string |
|
properties MetricAlertProperties_ARM |
Properties: The alert rule properties of the resource. |
tags map[string]string |
Tags: Resource tags |
MetricCriteria
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria, MultiMetricCriteria)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
criterionType MetricCriteria_CriterionType |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension |
Dimensions: List of dimension conditions. |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator MetricCriteria_Operator |
Operator: the criteria operator. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
threshold float64 |
Threshold: the criteria threshold value that activates the alert. |
timeAggregation MetricCriteria_TimeAggregation |
TimeAggregation: the criteria time aggregation types. |
MetricCriteria_ARM
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_ARM, MultiMetricCriteria_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
criterionType MetricCriteria_CriterionType_ARM |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_ARM |
Dimensions: List of dimension conditions. |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator MetricCriteria_Operator_ARM |
Operator: the criteria operator. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
threshold float64 |
Threshold: the criteria threshold value that activates the alert. |
timeAggregation MetricCriteria_TimeAggregation_ARM |
TimeAggregation: the criteria time aggregation types. |
MetricCriteria_CriterionType
(string
alias)
(Appears on:MetricCriteria)
Value | Description |
---|---|
"StaticThresholdCriterion" |
MetricCriteria_CriterionType_ARM
(string
alias)
(Appears on:MetricCriteria_ARM)
Value | Description |
---|---|
"StaticThresholdCriterion" |
MetricCriteria_CriterionType_STATUS
(string
alias)
(Appears on:MetricCriteria_STATUS)
Value | Description |
---|---|
"StaticThresholdCriterion" |
MetricCriteria_CriterionType_STATUS_ARM
(string
alias)
(Appears on:MetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"StaticThresholdCriterion" |
MetricCriteria_Operator
(string
alias)
(Appears on:MetricCriteria)
Value | Description |
---|---|
"Equals" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
MetricCriteria_Operator_ARM
(string
alias)
(Appears on:MetricCriteria_ARM)
Value | Description |
---|---|
"Equals" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
MetricCriteria_Operator_STATUS
(string
alias)
(Appears on:MetricCriteria_STATUS)
Value | Description |
---|---|
"Equals" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
MetricCriteria_Operator_STATUS_ARM
(string
alias)
(Appears on:MetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"Equals" |
|
"GreaterThan" |
|
"GreaterThanOrEqual" |
|
"LessThan" |
|
"LessThanOrEqual" |
MetricCriteria_STATUS
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_STATUS, MultiMetricCriteria_STATUS)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
criterionType MetricCriteria_CriterionType_STATUS |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_STATUS |
Dimensions: List of dimension conditions. |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator MetricCriteria_Operator_STATUS |
Operator: the criteria operator. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
threshold float64 |
Threshold: the criteria threshold value that activates the alert. |
timeAggregation MetricCriteria_TimeAggregation_STATUS |
TimeAggregation: the criteria time aggregation types. |
MetricCriteria_STATUS_ARM
(Appears on:MetricAlertSingleResourceMultipleMetricCriteria_STATUS_ARM, MultiMetricCriteria_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
criterionType MetricCriteria_CriterionType_STATUS_ARM |
CriterionType: Specifies the type of threshold criteria |
dimensions []MetricDimension_STATUS_ARM |
Dimensions: List of dimension conditions. |
metricName string |
MetricName: Name of the metric. |
metricNamespace string |
MetricNamespace: Namespace of the metric. |
name string |
Name: Name of the criteria. |
operator MetricCriteria_Operator_STATUS_ARM |
Operator: the criteria operator. |
skipMetricValidation bool |
SkipMetricValidation: Allows creating an alert rule on a custom metric that isn’t yet emitted, by causing the metric validation to be skipped. |
threshold float64 |
Threshold: the criteria threshold value that activates the alert. |
timeAggregation MetricCriteria_TimeAggregation_STATUS_ARM |
TimeAggregation: the criteria time aggregation types. |
MetricCriteria_TimeAggregation
(string
alias)
(Appears on:MetricCriteria)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
MetricCriteria_TimeAggregation_ARM
(string
alias)
(Appears on:MetricCriteria_ARM)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
MetricCriteria_TimeAggregation_STATUS
(string
alias)
(Appears on:MetricCriteria_STATUS)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
MetricCriteria_TimeAggregation_STATUS_ARM
(string
alias)
(Appears on:MetricCriteria_STATUS_ARM)
Value | Description |
---|---|
"Average" |
|
"Count" |
|
"Maximum" |
|
"Minimum" |
|
"Total" |
MetricDimension
(Appears on:DynamicMetricCriteria, MetricCriteria)
Specifies a metric dimension.
Field | Description |
---|---|
name string |
Name: Name of the dimension. |
operator string |
Operator: the dimension operator. Only ‘Include’ and ‘Exclude’ are supported |
values []string |
Values: list of dimension values. |
MetricDimension_ARM
(Appears on:DynamicMetricCriteria_ARM, MetricCriteria_ARM)
Specifies a metric dimension.
Field | Description |
---|---|
name string |
Name: Name of the dimension. |
operator string |
Operator: the dimension operator. Only ‘Include’ and ‘Exclude’ are supported |
values []string |
Values: list of dimension values. |
MetricDimension_STATUS
(Appears on:DynamicMetricCriteria_STATUS, MetricCriteria_STATUS)
Specifies a metric dimension.
Field | Description |
---|---|
name string |
Name: Name of the dimension. |
operator string |
Operator: the dimension operator. Only ‘Include’ and ‘Exclude’ are supported |
values []string |
Values: list of dimension values. |
MetricDimension_STATUS_ARM
(Appears on:DynamicMetricCriteria_STATUS_ARM, MetricCriteria_STATUS_ARM)
Specifies a metric dimension.
Field | Description |
---|---|
name string |
Name: Name of the dimension. |
operator string |
Operator: the dimension operator. Only ‘Include’ and ‘Exclude’ are supported |
values []string |
Values: list of dimension values. |
MultiMetricCriteria
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria)
Field | Description |
---|---|
dynamicThresholdCriterion DynamicMetricCriteria |
Dynamic: Mutually exclusive with all other properties |
staticThresholdCriterion MetricCriteria |
Static: Mutually exclusive with all other properties |
MultiMetricCriteria_ARM
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_ARM)
Field | Description |
---|---|
dynamicThresholdCriterion DynamicMetricCriteria_ARM |
Dynamic: Mutually exclusive with all other properties |
staticThresholdCriterion MetricCriteria_ARM |
Static: Mutually exclusive with all other properties |
MultiMetricCriteria_STATUS
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_STATUS)
Field | Description |
---|---|
dynamicThresholdCriterion DynamicMetricCriteria_STATUS |
Dynamic: Mutually exclusive with all other properties |
staticThresholdCriterion MetricCriteria_STATUS |
Static: Mutually exclusive with all other properties |
MultiMetricCriteria_STATUS_ARM
(Appears on:MetricAlertMultipleResourceMultipleMetricCriteria_STATUS_ARM)
Field | Description |
---|---|
dynamicThresholdCriterion DynamicMetricCriteria_STATUS_ARM |
Dynamic: Mutually exclusive with all other properties |
staticThresholdCriterion MetricCriteria_STATUS_ARM |
Static: Mutually exclusive with all other properties |
WebtestLocationAvailabilityCriteria
(Appears on:MetricAlertCriteria)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
componentReference genruntime.ResourceReference |
ComponentReference: The Application Insights resource Id. |
failedLocationCount float64 |
FailedLocationCount: The number of failed locations. |
odata.type WebtestLocationAvailabilityCriteria_OdataType |
OdataType: specifies the type of the alert criteria. |
webTestId string |
WebTestId: The Application Insights web test Id. |
WebtestLocationAvailabilityCriteria_ARM
(Appears on:MetricAlertCriteria_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
componentId string |
|
failedLocationCount float64 |
FailedLocationCount: The number of failed locations. |
odata.type WebtestLocationAvailabilityCriteria_OdataType_ARM |
OdataType: specifies the type of the alert criteria. |
webTestId string |
WebTestId: The Application Insights web test Id. |
WebtestLocationAvailabilityCriteria_OdataType
(string
alias)
(Appears on:WebtestLocationAvailabilityCriteria)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" |
WebtestLocationAvailabilityCriteria_OdataType_ARM
(string
alias)
(Appears on:WebtestLocationAvailabilityCriteria_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" |
WebtestLocationAvailabilityCriteria_OdataType_STATUS
(string
alias)
(Appears on:WebtestLocationAvailabilityCriteria_STATUS)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" |
WebtestLocationAvailabilityCriteria_OdataType_STATUS_ARM
(string
alias)
(Appears on:WebtestLocationAvailabilityCriteria_STATUS_ARM)
Value | Description |
---|---|
"Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" |
WebtestLocationAvailabilityCriteria_STATUS
(Appears on:MetricAlertCriteria_STATUS)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
componentId string |
ComponentId: The Application Insights resource Id. |
failedLocationCount float64 |
FailedLocationCount: The number of failed locations. |
odata.type WebtestLocationAvailabilityCriteria_OdataType_STATUS |
OdataType: specifies the type of the alert criteria. |
webTestId string |
WebTestId: The Application Insights web test Id. |
WebtestLocationAvailabilityCriteria_STATUS_ARM
(Appears on:MetricAlertCriteria_STATUS_ARM)
Field | Description |
---|---|
additionalProperties map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON |
|
componentId string |
ComponentId: The Application Insights resource Id. |
failedLocationCount float64 |
FailedLocationCount: The number of failed locations. |
odata.type WebtestLocationAvailabilityCriteria_OdataType_STATUS_ARM |
OdataType: specifies the type of the alert criteria. |
webTestId string |
WebTestId: The Application Insights web test Id. |