Microsoft.AlertsManagement (stable:2023-03-01)

2025/10/23 • 6 new, 6 deleted methods

PrometheusRuleGroups_ListBySubscription (new)
Description :  Retrieve Prometheus all rule group definitions in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/prometheusRuleGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule resources. ,
Required: False ,
}
[
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_ListByResourceGroup (new)
Description :  Retrieve Prometheus rule group definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule resources. ,
Required: False ,
}
[
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Get (new)
Description :  Retrieve a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_CreateOrUpdate (new)
Description :  Create or update a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule group to create or update. ,
Required: True ,
}
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Update (new)
Description :  Update an Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule group to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
enabled:
{
Description: the flag that indicates whether the Prometheus rule group is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Delete (new)
Description :  Delete a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_ListBySubscription (removed)
Description :  Retrieve Prometheus all rule group definitions in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/prometheusRuleGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule resources. ,
Required: False ,
}
[
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_ListByResourceGroup (removed)
Description :  Retrieve Prometheus rule group definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule resources. ,
Required: False ,
}
[
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Get (removed)
Description :  Retrieve a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_CreateOrUpdate (removed)
Description :  Create or update a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule group to create or update. ,
Required: True ,
}
{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Update (removed)
Description :  Update an Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule group to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
enabled:
{
Description: the flag that indicates whether the Prometheus rule group is enabled. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Prometheus rule group properties of the resource. ,
Required: True ,
}
{
description:
{
Description: Rule group description. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule group. ,
Required: False ,
}
boolean ,
clusterName:
{
Description: Apply rule to data from a specific cluster. ,
Required: False ,
}
string ,
scopes:
{
Description: Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future. ,
Required: True ,
}
[
string ,
]
,
interval:
{
Description: The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes ,
Format: duration ,
Required: False ,
}
string ,
rules:
{
Description: Defines the rules in the Prometheus rule group. ,
Required: True ,
}
[
{
record:
{
Description: Recorded metrics name. ,
Required: False ,
}
string ,
alert:
{
Description: Alert rule name. ,
Required: False ,
}
string ,
enabled:
{
Description: Enable/disable rule. ,
Required: False ,
}
boolean ,
expression:
{
Description: 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'. ,
Required: True ,
}
string ,
labels:
{
Description: Labels to add or overwrite before storing the result. ,
Required: False ,
}
object ,
severity:
{
Description: The severity of the alerts fired by the rule. Must be between 0 and 4. ,
Format: int32 ,
Required: False ,
}
integer ,
for:
{
Description: The amount of time alert must be active before firing. ,
Format: duration ,
Required: False ,
}
string ,
annotations:
{
Description: 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. ,
Required: False ,
}
object ,
actions:
{
Description: Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The resource id of the action group to use. ,
Required: False ,
}
string ,
actionProperties:
{
Description: The properties of an action group object. ,
Required: False ,
}
object ,
}
,
]
,
resolveConfiguration:
{
Description: Defines the configuration for resolving fired alerts. Only relevant for alerts. ,
Required: False ,
}
{
autoResolved:
{
Description: Enable alert auto-resolution. ,
Required: False ,
}
boolean ,
timeToResolve:
{
Description: Alert auto-resolution timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrometheusRuleGroups_Delete (removed)
Description :  Delete a Prometheus rule group definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/prometheusRuleGroups/{ruleGroupName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
ruleGroupName:
{
Description: The name of the rule group. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}