alertsmanagement.azure.com/v1api20230301
APIVersion
| Value | Description |
|---|---|
| “2023-03-01” |
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}
Used by: PrometheusRuleGroupList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | PrometheusRuleGroup_Spec Optional |
|
| status | PrometheusRuleGroup_STATUS Optional |
PrometheusRuleGroup_Spec
| Property | Description | Type |
|---|---|---|
| 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 |
| clusterName | Apply rule to data from a specific cluster. | string Optional |
| description | Rule group description. | string Optional |
| enabled | Enable/disable rule group. | bool Optional |
| interval | The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | PrometheusRuleGroupOperatorSpec 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 |
| rules | Defines the rules in the Prometheus rule group. | PrometheusRule[] Required |
| scopesReferences | Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. | genruntime.ResourceReference[] Required |
| tags | Resource tags. | map[string]string Optional |
PrometheusRuleGroup_STATUS
| Property | Description | Type |
|---|---|---|
| clusterName | Apply rule to data from a specific cluster. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | Rule group description. | string Optional |
| enabled | Enable/disable rule group. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| interval | The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rules | Defines the rules in the Prometheus rule group. | PrometheusRule_STATUS[] Optional |
| scopes | Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. | string[] Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
PrometheusRuleGroupList
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}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | PrometheusRuleGroup[] Optional |
PrometheusRuleGroup_Spec
Used by: PrometheusRuleGroup.
| Property | Description | Type |
|---|---|---|
| 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 |
| clusterName | Apply rule to data from a specific cluster. | string Optional |
| description | Rule group description. | string Optional |
| enabled | Enable/disable rule group. | bool Optional |
| interval | The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes | string Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | PrometheusRuleGroupOperatorSpec 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 |
| rules | Defines the rules in the Prometheus rule group. | PrometheusRule[] Required |
| scopesReferences | Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. | genruntime.ResourceReference[] Required |
| tags | Resource tags. | map[string]string Optional |
PrometheusRuleGroup_STATUS
Used by: PrometheusRuleGroup.
| Property | Description | Type |
|---|---|---|
| clusterName | Apply rule to data from a specific cluster. | string Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| description | Rule group description. | string Optional |
| enabled | Enable/disable rule group. | bool Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| interval | The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes | string Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| rules | Defines the rules in the Prometheus rule group. | PrometheusRule_STATUS[] Optional |
| scopes | Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. | string[] Optional |
| systemData | Azure Resource Manager metadata containing createdBy and modifiedBy information. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
PrometheusRule
An Azure Prometheus alerting or recording rule.
Used by: PrometheusRuleGroup_Spec.
| Property | Description | Type |
|---|---|---|
| actions | Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. | PrometheusRuleGroupAction[] Optional |
| alert | Alert rule name. | string Optional |
| 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. | map[string]string Optional |
| enabled | Enable/disable rule. | bool Optional |
| 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’. | string Required |
| for | The amount of time alert must be active before firing. | string Optional |
| labels | Labels to add or overwrite before storing the result. | map[string]string Optional |
| record | Recorded metrics name. | string Optional |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Only relevant for alerts. | PrometheusRuleResolveConfiguration Optional |
| severity | The severity of the alerts fired by the rule. Must be between 0 and 4. | int Optional |
PrometheusRule_STATUS
An Azure Prometheus alerting or recording rule.
Used by: PrometheusRuleGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| actions | Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. | PrometheusRuleGroupAction_STATUS[] Optional |
| alert | Alert rule name. | string Optional |
| 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. | map[string]string Optional |
| enabled | Enable/disable rule. | bool Optional |
| 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’. | string Optional |
| for | The amount of time alert must be active before firing. | string Optional |
| labels | Labels to add or overwrite before storing the result. | map[string]string Optional |
| record | Recorded metrics name. | string Optional |
| resolveConfiguration | Defines the configuration for resolving fired alerts. Only relevant for alerts. | PrometheusRuleResolveConfiguration_STATUS Optional |
| severity | The severity of the alerts fired by the rule. Must be between 0 and 4. | int Optional |
PrometheusRuleGroupOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: PrometheusRuleGroup_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 |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: PrometheusRuleGroup_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
PrometheusRuleGroupAction
An alert action. Only relevant for alerts.
Used by: PrometheusRule.
| Property | Description | Type |
|---|---|---|
| actionGroupReference | The resource id of the action group to use. | genruntime.ResourceReference Optional |
| actionProperties | The properties of an action group object. | map[string]string Optional |
PrometheusRuleGroupAction_STATUS
An alert action. Only relevant for alerts.
Used by: PrometheusRule_STATUS.
| Property | Description | Type |
|---|---|---|
| actionGroupId | The resource id of the action group to use. | string Optional |
| actionProperties | The properties of an action group object. | map[string]string Optional |
PrometheusRuleResolveConfiguration
Specifies the Prometheus alert rule configuration.
Used by: PrometheusRule.
| Property | Description | Type |
|---|---|---|
| autoResolved | Enable alert auto-resolution. | bool Optional |
| timeToResolve | Alert auto-resolution timeout. | string Optional |
PrometheusRuleResolveConfiguration_STATUS
Specifies the Prometheus alert rule configuration.
Used by: PrometheusRule_STATUS.
| Property | Description | Type |
|---|---|---|
| autoResolved | Enable alert auto-resolution. | bool Optional |
| timeToResolve | Alert auto-resolution timeout. | string Optional |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |