Microsoft.Insights (preview:2024-03-01)

2025/09/10 • 8 new methods

MetricAlerts_ListBySubscription (new)
Description :  Retrieve alert rule definitions in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/metricAlerts
{
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 alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlerts_ListByResourceGroup (new)
Description :  Retrieve alert rule definitions in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts
{
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 alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlerts_Get (new)
Description :  Retrieve an alert rule definition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}
{
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 ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlerts_CreateOrUpdate (new)
Description :  Create or update an metric alert definition.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}
{
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 ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule to create or update. ,
Required: True ,
}
{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlerts_Update (new)
Description :  Update an metric alert definition.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}
{
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 ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
parameters:
{
Description: The parameters of the rule to update. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
identity:
{
Description: The identity of the resource. ,
Required: False ,
}
{
principalId:
{
Description: The principal ID of resource identity. ,
Required: False ,
}
string ,
tenantId:
{
Description: The tenant ID of resource. ,
Required: False ,
}
string ,
type:
{
Description: Type of managed service identity. Previously undocumented values might be returned ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
userAssignedIdentities:
{
Description: The list of user identities associated with the resource. The user identity dictionary key references will be Azure resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ,
Required: False ,
}
object ,
}
,
properties:
{
Description: The alert rule properties of the resource. ,
Required: False ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: False ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: False ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. ,
Required: False ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: False ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: The resource type of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: The region of the target resource(s) on which the alert is created/updated. Mandatory for MultipleResourceMultipleMetricCriteria. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: False ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
description:
{
Description: The description of the metric alert that will be included in the alert email. ,
Required: False ,
}
string ,
severity:
{
Description: Alert severity {0, 1, 2, 3, 4} ,
Format: int32 ,
Required: True ,
}
integer ,
enabled:
{
Description: The flag that indicates whether the metric alert is enabled. ,
Required: True ,
}
boolean ,
scopes:
{
Description: The list of resource id's that this metric alert is scoped to. You cannot change the scope of a metric rule based on logs. ,
Required: True ,
}
[
string ,
]
,
evaluationFrequency:
{
Description: How often the metric alert is evaluated represented in ISO 8601 duration format. ,
Format: duration ,
Required: True ,
}
string ,
windowSize:
{
Description: The period of time (in ISO 8601 duration format) that is used to monitor alert activity based on the threshold. ,
Format: duration ,
Required: False ,
}
string ,
targetResourceType:
{
Description: 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. ,
Required: False ,
}
string ,
targetResourceRegion:
{
Description: 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. ,
Required: False ,
}
string ,
criteria:
{
Description: Defines the specific alert criteria information. ,
Required: True ,
}
{
odata.type:
{
Description: Specifies the type of the alert criteria. Previously undocumented values might be returned ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: No description available. ,
Microsoft.Azure.Monitor.PromQLCriteria: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
autoMitigate:
{
Description: The flag that indicates whether the alert should be auto resolved or not. The default is true. ,
Required: False ,
}
boolean ,
resolveConfiguration:
{
Description: The configuration for how the alert is resolved. Applicable for PromQLCriteria. ,
Required: False ,
}
{
autoResolved:
{
Description: Indicates whether the alert should be auto resolved ,
Required: True ,
}
boolean ,
timeToResolve:
{
Description: The time (in ISO 8601 duration format) after which the alert should be auto resolved ,
Format: duration ,
Required: False ,
}
string ,
}
,
actions:
{
Description: The array of actions that are performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
[
{
actionGroupId:
{
Description: The id of the action group to use. ,
Required: False ,
}
string ,
webHookProperties:
{
Description: This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. ,
Required: False ,
}
object ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
isMigrated:
{
Description: The value indicating whether this alert rule is migrated. ,
Required: False ,
}
boolean ,
customProperties:
{
Description: The properties of an alert payload. ,
Required: False ,
}
object ,
actionProperties:
{
Description: The properties of an action properties. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlerts_Delete (new)
Description :  Delete an alert rule definition.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}
{
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 ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlertsStatus_List (new)
Description :  Retrieve an alert rule status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status
{
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 ,
ruleName:
{
Description: The name of the rule. ,
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 ,
}
[
{
name:
{
Description: The status name. ,
Required: False ,
}
string ,
id:
{
Description: The alert rule arm id. ,
Required: False ,
}
string ,
type:
{
Description: The extended resource type name. ,
Required: False ,
}
string ,
properties:
{
Description: The alert status properties of the metric alert status. ,
Required: False ,
}
{
dimensions:
{
Description: An object describing the type of the dimensions. ,
Required: False ,
}
object ,
status:
{
Description: Status value ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC time when the status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MetricAlertsStatus_ListByName (new)
Description :  Retrieve an alert rule status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/metricAlerts/{ruleName}/status/{statusName}
{
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 ,
ruleName:
{
Description: The name of the rule. ,
Required: True ,
}
string ,
statusName:
{
Description: The name of the status. ,
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 ,
}
[
{
name:
{
Description: The status name. ,
Required: False ,
}
string ,
id:
{
Description: The alert rule arm id. ,
Required: False ,
}
string ,
type:
{
Description: The extended resource type name. ,
Required: False ,
}
string ,
properties:
{
Description: The alert status properties of the metric alert status. ,
Required: False ,
}
{
dimensions:
{
Description: An object describing the type of the dimensions. ,
Required: False ,
}
object ,
status:
{
Description: Status value ,
Required: False ,
}
string ,
timestamp:
{
Description: UTC time when the status was checked. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Required: False ,
}
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. If Accept-Language is set in the request, it must be localized to that language. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: An array of additional nested error response info objects, as described by this contract. ,
Required: False ,
}
[
{
code:
{
Description: Unlocalized string which can be used to programmatically identify the error. ,
Required: False ,
}
string ,
message:
{
Description: Describes the error in detail and provides debugging information. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error (for example, the name of the property in error). ,
Required: False ,
}
string ,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
]
,
additionalInfo:
{
Description: An array of objects with 'type' and 'info' properties. The schema of 'info' is service-specific and dependent on the 'type' string. ,
Required: False ,
}
[
{
type:
{
Description: The type of additional information. ,
Required: False ,
}
string ,
info:
{
Description: The additional information specific to the type. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}