alertsmanagement.azure.com/v1api20230301
alertsmanagement.azure.com/v1api20230301
Package v1api20230301 contains API Schema definitions for the alertsmanagement v1api20230301 API group
APIVersion
(string
alias)
Value | Description |
---|---|
"2023-03-01" |
PrometheusRule
(Appears on:PrometheusRuleGroup_Spec)
An Azure Prometheus alerting or recording rule.
Field | Description |
---|---|
actions []PrometheusRuleGroupAction |
Actions: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
alert string |
Alert: Alert rule name. |
annotations map[string]string |
Annotations: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. |
enabled bool |
Enabled: Enable/disable rule. |
expression string |
Expression: The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by ‘interval’, and the result recorded as a new set of time series with the metric name as given by ‘record’. |
for string |
For: The amount of time alert must be active before firing. |
labels map[string]string |
Labels: Labels to add or overwrite before storing the result. |
record string |
Record: Recorded metrics name. |
resolveConfiguration PrometheusRuleResolveConfiguration |
ResolveConfiguration: Defines the configuration for resolving fired alerts. Only relevant for alerts. |
severity int |
Severity: The severity of the alerts fired by the rule. Must be between 0 and 4. |
PrometheusRuleGroup
Generator information: - Generated from: /alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2023-03-01/PrometheusRuleGroups.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}p>
Field | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
metadata Kubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||||||||
spec PrometheusRuleGroup_Spec |
|
||||||||||||||||||||
status PrometheusRuleGroup_STATUS |
PrometheusRuleGroupAction
(Appears on:PrometheusRule)
An alert action. Only relevant for alerts.
Field | Description |
---|---|
actionGroupReference genruntime.ResourceReference |
ActionGroupReference: The resource id of the action group to use. |
actionProperties map[string]string |
ActionProperties: The properties of an action group object. |
PrometheusRuleGroupAction_ARM
(Appears on:PrometheusRule_ARM)
An alert action. Only relevant for alerts.
Field | Description |
---|---|
actionGroupId string |
|
actionProperties map[string]string |
ActionProperties: The properties of an action group object. |
PrometheusRuleGroupAction_STATUS
(Appears on:PrometheusRule_STATUS)
An alert action. Only relevant for alerts.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: The resource id of the action group to use. |
actionProperties map[string]string |
ActionProperties: The properties of an action group object. |
PrometheusRuleGroupAction_STATUS_ARM
(Appears on:PrometheusRule_STATUS_ARM)
An alert action. Only relevant for alerts.
Field | Description |
---|---|
actionGroupId string |
ActionGroupId: The resource id of the action group to use. |
actionProperties map[string]string |
ActionProperties: The properties of an action group object. |
PrometheusRuleGroupProperties_ARM
(Appears on:PrometheusRuleGroup_Spec_ARM)
An Azure Prometheus rule group.
Field | Description |
---|---|
clusterName string |
ClusterName: Apply rule to data from a specific cluster. |
description string |
Description: Rule group description. |
enabled bool |
Enabled: Enable/disable rule group. |
interval string |
Interval: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes |
rules []PrometheusRule_ARM |
Rules: Defines the rules in the Prometheus rule group. |
scopes []string |
PrometheusRuleGroupProperties_STATUS_ARM
(Appears on:PrometheusRuleGroup_STATUS_ARM)
An Azure Prometheus rule group.
Field | Description |
---|---|
clusterName string |
ClusterName: Apply rule to data from a specific cluster. |
description string |
Description: Rule group description. |
enabled bool |
Enabled: Enable/disable rule group. |
interval string |
Interval: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes |
rules []PrometheusRule_STATUS_ARM |
Rules: Defines the rules in the Prometheus rule group. |
scopes []string |
Scopes: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. |
PrometheusRuleGroup_STATUS
(Appears on:PrometheusRuleGroup)
Field | Description |
---|---|
clusterName string |
ClusterName: Apply rule to data from a specific cluster. |
conditions []genruntime/conditions.Condition |
Conditions: The observed state of the resource |
description string |
Description: Rule group description. |
enabled bool |
Enabled: Enable/disable rule group. |
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
interval string |
Interval: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
rules []PrometheusRule_STATUS |
Rules: Defines the rules in the Prometheus rule group. |
scopes []string |
Scopes: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. |
systemData SystemData_STATUS |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
PrometheusRuleGroup_STATUS_ARM
Field | Description |
---|---|
id string |
Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}p> |
location string |
Location: The geo-location where the resource lives |
name string |
Name: The name of the resource |
properties PrometheusRuleGroupProperties_STATUS_ARM |
Properties: The Prometheus rule group properties of the resource. |
systemData SystemData_STATUS_ARM |
SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. |
tags map[string]string |
Tags: Resource tags. |
type string |
Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” |
PrometheusRuleGroup_Spec
(Appears on:PrometheusRuleGroup)
Field | Description |
---|---|
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. |
clusterName string |
ClusterName: Apply rule to data from a specific cluster. |
description string |
Description: Rule group description. |
enabled bool |
Enabled: Enable/disable rule group. |
interval string |
Interval: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes |
location string |
Location: The geo-location where the resource lives |
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 |
rules []PrometheusRule |
Rules: Defines the rules in the Prometheus rule group. |
scopesReferences []genruntime.ResourceReference |
ScopesReferences: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. |
tags map[string]string |
Tags: Resource tags. |
PrometheusRuleGroup_Spec_ARM
Field | Description |
---|---|
location string |
Location: The geo-location where the resource lives |
name string |
|
properties PrometheusRuleGroupProperties_ARM |
Properties: The Prometheus rule group properties of the resource. |
tags map[string]string |
Tags: Resource tags. |
PrometheusRuleResolveConfiguration
(Appears on:PrometheusRule)
Specifies the Prometheus alert rule configuration.
Field | Description |
---|---|
autoResolved bool |
AutoResolved: Enable alert auto-resolution. |
timeToResolve string |
TimeToResolve: Alert auto-resolution timeout. |
PrometheusRuleResolveConfiguration_ARM
(Appears on:PrometheusRule_ARM)
Specifies the Prometheus alert rule configuration.
Field | Description |
---|---|
autoResolved bool |
AutoResolved: Enable alert auto-resolution. |
timeToResolve string |
TimeToResolve: Alert auto-resolution timeout. |
PrometheusRuleResolveConfiguration_STATUS
(Appears on:PrometheusRule_STATUS)
Specifies the Prometheus alert rule configuration.
Field | Description |
---|---|
autoResolved bool |
AutoResolved: Enable alert auto-resolution. |
timeToResolve string |
TimeToResolve: Alert auto-resolution timeout. |
PrometheusRuleResolveConfiguration_STATUS_ARM
(Appears on:PrometheusRule_STATUS_ARM)
Specifies the Prometheus alert rule configuration.
Field | Description |
---|---|
autoResolved bool |
AutoResolved: Enable alert auto-resolution. |
timeToResolve string |
TimeToResolve: Alert auto-resolution timeout. |
PrometheusRule_ARM
(Appears on:PrometheusRuleGroupProperties_ARM)
An Azure Prometheus alerting or recording rule.
Field | Description |
---|---|
actions []PrometheusRuleGroupAction_ARM |
Actions: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
alert string |
Alert: Alert rule name. |
annotations map[string]string |
Annotations: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. |
enabled bool |
Enabled: Enable/disable rule. |
expression string |
Expression: The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by ‘interval’, and the result recorded as a new set of time series with the metric name as given by ‘record’. |
for string |
For: The amount of time alert must be active before firing. |
labels map[string]string |
Labels: Labels to add or overwrite before storing the result. |
record string |
Record: Recorded metrics name. |
resolveConfiguration PrometheusRuleResolveConfiguration_ARM |
ResolveConfiguration: Defines the configuration for resolving fired alerts. Only relevant for alerts. |
severity int |
Severity: The severity of the alerts fired by the rule. Must be between 0 and 4. |
PrometheusRule_STATUS
(Appears on:PrometheusRuleGroup_STATUS)
An Azure Prometheus alerting or recording rule.
Field | Description |
---|---|
actions []PrometheusRuleGroupAction_STATUS |
Actions: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
alert string |
Alert: Alert rule name. |
annotations map[string]string |
Annotations: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. |
enabled bool |
Enabled: Enable/disable rule. |
expression string |
Expression: The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by ‘interval’, and the result recorded as a new set of time series with the metric name as given by ‘record’. |
for string |
For: The amount of time alert must be active before firing. |
labels map[string]string |
Labels: Labels to add or overwrite before storing the result. |
record string |
Record: Recorded metrics name. |
resolveConfiguration PrometheusRuleResolveConfiguration_STATUS |
ResolveConfiguration: Defines the configuration for resolving fired alerts. Only relevant for alerts. |
severity int |
Severity: The severity of the alerts fired by the rule. Must be between 0 and 4. |
PrometheusRule_STATUS_ARM
(Appears on:PrometheusRuleGroupProperties_STATUS_ARM)
An Azure Prometheus alerting or recording rule.
Field | Description |
---|---|
actions []PrometheusRuleGroupAction_STATUS_ARM |
Actions: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. |
alert string |
Alert: Alert rule name. |
annotations map[string]string |
Annotations: The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. |
enabled bool |
Enabled: Enable/disable rule. |
expression string |
Expression: The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by ‘interval’, and the result recorded as a new set of time series with the metric name as given by ‘record’. |
for string |
For: The amount of time alert must be active before firing. |
labels map[string]string |
Labels: Labels to add or overwrite before storing the result. |
record string |
Record: Recorded metrics name. |
resolveConfiguration PrometheusRuleResolveConfiguration_STATUS_ARM |
ResolveConfiguration: Defines the configuration for resolving fired alerts. Only relevant for alerts. |
severity int |
Severity: The severity of the alerts fired by the rule. Must be between 0 and 4. |
SystemData_CreatedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_CreatedByType_STATUS_ARM
(string
alias)
(Appears on:SystemData_STATUS_ARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS
(string
alias)
(Appears on:SystemData_STATUS)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_LastModifiedByType_STATUS_ARM
(string
alias)
(Appears on:SystemData_STATUS_ARM)
Value | Description |
---|---|
"Application" |
|
"Key" |
|
"ManagedIdentity" |
|
"User" |
SystemData_STATUS
(Appears on:PrometheusRuleGroup_STATUS)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemData_LastModifiedByType_STATUS |
LastModifiedByType: The type of identity that last modified the resource. |
SystemData_STATUS_ARM
(Appears on:PrometheusRuleGroup_STATUS_ARM)
Metadata pertaining to creation and last modification of the resource.
Field | Description |
---|---|
createdAt string |
CreatedAt: The timestamp of resource creation (UTC). |
createdBy string |
CreatedBy: The identity that created the resource. |
createdByType SystemData_CreatedByType_STATUS_ARM |
CreatedByType: The type of identity that created the resource. |
lastModifiedAt string |
LastModifiedAt: The timestamp of resource last modification (UTC) |
lastModifiedBy string |
LastModifiedBy: The identity that last modified the resource. |
lastModifiedByType SystemData_LastModifiedByType_STATUS_ARM |
LastModifiedByType: The type of identity that last modified the resource. |