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

2024/12/05 • 6 deleted methods

AlertRules_CreateOrUpdate (removed)
Description :  Creates or updates a classic metric alert rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}
{
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 ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
AlertRules_Delete (removed)
Description :  Deletes a classic metric alert rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}
{
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 ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (200)

{}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AlertRules_Get (removed)
Description :  Gets a classic metric alert rule
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{ruleName}
{
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 ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AlertRules_Update (removed)
Description :  Updates an existing classic metric AlertRuleResource. To update other fields use the CreateOrUpdate method.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules/{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 ,
alertRulesResource:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
string ,
properties:
{
Description: The properties of an alert rule. ,
Required: False ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The alert rule properties of the resource. ,
Required: True ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AlertRules_ListByResourceGroup (removed)
Description :  List the classic metric alert rules within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/alertrules
{
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 ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
AlertRules_ListBySubscription (removed)
Description :  List the classic metric alert rules within a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Insights/alertrules
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
{
name:
{
Description: the name of the alert rule. ,
Required: True ,
}
string ,
description:
{
Description: the description of the alert rule that will be included in the alert email. ,
Required: False ,
}
string ,
provisioningState:
{
Description: the provisioning state. ,
Required: False ,
}
string ,
isEnabled:
{
Description: the flag that indicates whether the alert rule is enabled. ,
Required: True ,
}
boolean ,
condition:
{
Description: the condition that results in the alert rule being activated. ,
Required: True ,
}
{
odata.type:
{
Description: specifies the type of condition. This can be one of three types: ManagementEventRuleCondition (occurrences of management events), LocationThresholdRuleCondition (based on the number of failures of a web test), and ThresholdRuleCondition (based on the threshold of a metric). ,
Required: True ,
}
string ,
dataSource:
{
Description: the resource from which the rule collects its data. For this type dataSource will always be of type RuleMetricDataSource. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of data source. There are two types of rule data sources: RuleMetricDataSource and RuleManagementEventDataSource ,
Required: True ,
}
string ,
resourceUri:
{
Description: the resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
legacyResourceId:
{
Description: the legacy resource identifier of the resource the rule monitors. **NOTE**: this property cannot be updated for an existing rule. ,
Required: False ,
}
string ,
resourceLocation:
{
Description: the location of the resource. ,
Required: False ,
}
string ,
metricNamespace:
{
Description: the namespace of the metric. ,
Required: False ,
}
string ,
}
,
}
,
action:
{
Description: action that is performed when the alert rule becomes active, and when an alert condition is resolved. ,
Required: False ,
}
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
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 ,
}
[
{
odata.type:
{
Description: specifies the type of the action. There are two types of actions: RuleEmailAction and RuleWebhookAction. ,
Required: True ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Description: Last time the rule was updated in ISO8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}