Microsoft.Insights (stable:2018-03-01)

2024/12/05 • 8 updated methods

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

⚶ Changes

{
  "#id": "MetricAlerts_ListBySubscription",
  "$responses": {
    "default": {
      "$properties": {
        "@added_76fd0d8acef842e3bc29007fdd1dc399": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_d96d4dee5669490896a0d5ceb1155be4": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_a3fd173da1c24fadb7c267f702387bbe": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}
,
]
,
}

⚐ 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 (updated)
Description :  Retrieve alert rule definitions in a resource group.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlerts_ListByResourceGroup",
  "$responses": {
    "default": {
      "$properties": {
        "@added_21a7c36be5dc4394b2a42de2cac06b45": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_69c49fe38681478894f80b779ec41351": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_3869ad9c69ec4adaa5cf9ddcfe5ff8b7": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}
,
]
,
}

⚐ 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 (updated)
Description :  Retrieve an alert rule definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlerts_Get",
  "$responses": {
    "default": {
      "$properties": {
        "@added_7062c9f7856f4458b39f0f261863d2d0": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_3a19f75fb7eb4cddbfdc1dd7bce39674": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_e95a1a0b51ce445ab986e920bce14643": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Create or update an metric alert definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlerts_CreateOrUpdate",
  "$responses": {
    "default": {
      "$properties": {
        "@added_88eee85c4de34c44819fae37b88f86ea": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_16b94d596df4420187d76aefa04daa87": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_c6a7a9dc58c64e509c89a8624c608b3c": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}
,
}

⚐ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Update an metric alert definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlerts_Update",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "tags",
          "Type": {
            "new": "object",
            "old": "string"
          }
        }
      ]
    }
  },
  "$responses": {
    "default": {
      "$properties": {
        "@added_a1f651990ee84605917a91444d9b1120": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_cd3d6111d6c94766bde8defd236f1b02": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_7750e43471264336b2d29b8dd8d4cced": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}
,
}

⚐ 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. ,
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: True ,
}
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. ,
Enum:
{
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria: No description available. ,
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria: 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 ,
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 ,
}
,
}

⚐ 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 (updated)
Description :  Delete an alert rule definition.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlerts_Delete",
  "$responses": {
    "default": {
      "$properties": {
        "@added_1731ec3a136e4ed59674b443073866d6": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_afa999d8e7da4b72af1bd92827a21869": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_c1d70ff3c5174c52846888833383888e": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 (updated)
Description :  Retrieve an alert rule status.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlertsStatus_List",
  "$responses": {
    "default": {
      "$properties": {
        "@added_2bf2092d23944e7b87cfb4c4187af008": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_cea99327e8e74612b31d7442aa788d70": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_9f9066dc47b94794b2541ec457a5a03b": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 (updated)
Description :  Retrieve an alert rule status.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MetricAlertsStatus_ListByName",
  "$responses": {
    "default": {
      "$properties": {
        "@added_add9ae562c29419cbf807e85ef21f969": {
          "#name": "error",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "code",
              "Description": "Unlocalized string which can be used to programmatically identify the error.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "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,
              "Type": "string"
            },
            {
              "#name": "target",
              "Description": "The target of the particular error (for example, the name of the property in error).",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "details",
              "Description": "An array of additional nested error response info objects, as described by this contract.",
              "Required": false,
              "Type": "array",
              "$items": {
                "Description": "Describes details of an error response.",
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "Unlocalized string which can be used to programmatically identify the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "Describes the error in detail and provides debugging information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the particular error (for example, the name of the property in error).",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "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": "array",
                    "$items": {
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "type",
                          "Description": "The type of additional information.",
                          "Required": false,
                          "Type": "string"
                        },
                        {
                          "#name": "info",
                          "Description": "The additional information specific to the type.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            },
            {
              "#name": "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": "array",
              "$items": {
                "Type": "object",
                "$properties": [
                  {
                    "#name": "type",
                    "Description": "The type of additional information.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "info",
                    "Description": "The additional information specific to the type.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              }
            }
          ]
        },
        "@removed_09f2f215f8dd4fe8bd7764a8595e099a": {
          "#name": "code",
          "Description": "Error code",
          "Required": false,
          "Type": "string"
        },
        "@removed_560440584b644d8e8d0252a64999d48c": {
          "#name": "message",
          "Description": "Error message indicating why the operation failed.",
          "Required": false,
          "Type": "string"
        }
      }
    }
  }
}

⚼ 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 ,
}
,
]
,
}
,
}