Microsoft.AlertsManagement (preview:2019-05-05)

2025/11/19 • 10 new, 10 deleted methods

ActionRules_ListBySubscription (new)
Description :  List all action rules of the subscription and given input filters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
impactedScope:
{
Description: filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. ,
Required: False ,
}
string ,
description:
{
Description: filter by alert rule description ,
Required: False ,
}
string ,
alertRuleId:
{
Description: filter by alert rule id ,
Required: False ,
}
string ,
actionGroup:
{
Description: filter by action group configured as part of action rule ,
Required: False ,
}
string ,
name:
{
Description: filter by action rule name ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of action rules ,
}
{
nextLink:
{
Description: URL to fetch the next set of action rules ,
Required: False ,
}
string ,
value:
{
Description: List of action rules ,
Required: False ,
}
[
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_ListByResourceGroup (new)
Description :  List all action rules of the subscription, created in given resource group and given input filters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
impactedScope:
{
Description: filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. ,
Required: False ,
}
string ,
description:
{
Description: filter by alert rule description ,
Required: False ,
}
string ,
alertRuleId:
{
Description: filter by alert rule id ,
Required: False ,
}
string ,
actionGroup:
{
Description: filter by action group configured as part of action rule ,
Required: False ,
}
string ,
name:
{
Description: filter by action rule name ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of action rules ,
}
{
nextLink:
{
Description: URL to fetch the next set of action rules ,
Required: False ,
}
string ,
value:
{
Description: List of action rules ,
Required: False ,
}
[
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_GetByName (new)
Description :  Get a specific action rule
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name of action rule that needs to be fetched ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_CreateUpdate (new)
Description :  Creates/Updates a specific action rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name of action rule that needs to be created/updated ,
Required: True ,
}
string ,
actionRule:
{
Description: action rule to be created/updated ,
Required: True ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_Delete (new)
Description :  Deletes a given action rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name that needs to be deleted ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema: boolean ,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_Update (new)
Description :  Update enabled flag and/or tags for the given action rule
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name that needs to be updated ,
Required: True ,
}
string ,
actionRulePatch:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: properties supported by patch operation ,
Required: False ,
}
{
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetAll (new)
Description :  List all the Smart Groups within a specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
smartGroupState:
{
Description: Filter by state of the smart group. Default value is to select all. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
pageCount:
{
Description: Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. ,
Format: int64 ,
Required: False ,
}
integer ,
sortBy:
{
Description: Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'. ,
Required: False ,
}
string ,
sortOrder:
{
Description: Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to fetch the next set of alerts. ,
Required: False ,
}
string ,
value:
{
Description: List of alerts ,
Required: False ,
}
[
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetById (new)
Description :  Get information related to a specific Smart Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Set of related alerts grouped together smartly by AMS. ,
}
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_ChangeState (new)
Description :  Change the state of a Smart Group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Set of related alerts grouped together smartly by AMS. ,
}
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetHistory (new)
Description :  Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the smartGroup modification item. ,
Required: False ,
}
{
smartGroupId:
{
Description: Unique Id of the smartGroup for which the history is being retrieved ,
Required: False ,
}
string ,
modifications:
{
Description: Modification details ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
SmartGroupCreated: No description available. ,
StateChange: No description available. ,
AlertAdded: No description available. ,
AlertRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
oldValue:
{
Description: Old value ,
Required: False ,
}
string ,
newValue:
{
Description: New value ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Modified date and time ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified user details (Principal client name) ,
Required: False ,
}
string ,
comments:
{
Description: Modification comments ,
Required: False ,
}
string ,
description:
{
Description: Description of the modification ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_ListBySubscription (removed)
Description :  List all action rules of the subscription and given input filters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
impactedScope:
{
Description: filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. ,
Required: False ,
}
string ,
description:
{
Description: filter by alert rule description ,
Required: False ,
}
string ,
alertRuleId:
{
Description: filter by alert rule id ,
Required: False ,
}
string ,
actionGroup:
{
Description: filter by action group configured as part of action rule ,
Required: False ,
}
string ,
name:
{
Description: filter by action rule name ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of action rules ,
}
{
nextLink:
{
Description: URL to fetch the next set of action rules ,
Required: False ,
}
string ,
value:
{
Description: List of action rules ,
Required: False ,
}
[
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_ListByResourceGroup (removed)
Description :  List all action rules of the subscription, created in given resource group and given input filters
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
impactedScope:
{
Description: filter by impacted/target scope (provide comma separated list for multiple scopes). The value should be an well constructed ARM id of the scope. ,
Required: False ,
}
string ,
description:
{
Description: filter by alert rule description ,
Required: False ,
}
string ,
alertRuleId:
{
Description: filter by alert rule id ,
Required: False ,
}
string ,
actionGroup:
{
Description: filter by action group configured as part of action rule ,
Required: False ,
}
string ,
name:
{
Description: filter by action rule name ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of action rules ,
}
{
nextLink:
{
Description: URL to fetch the next set of action rules ,
Required: False ,
}
string ,
value:
{
Description: List of action rules ,
Required: False ,
}
[
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_GetByName (removed)
Description :  Get a specific action rule
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name of action rule that needs to be fetched ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_CreateUpdate (removed)
Description :  Creates/Updates a specific action rule
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name of action rule that needs to be created/updated ,
Required: True ,
}
string ,
actionRule:
{
Description: action rule to be created/updated ,
Required: True ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_Delete (removed)
Description :  Deletes a given action rule
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name that needs to be deleted ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema: boolean ,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ActionRules_Update (removed)
Description :  Update enabled flag and/or tags for the given action rule
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{actionRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
actionRuleName:
{
Description: The name that needs to be updated ,
Required: True ,
}
string ,
actionRulePatch:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: properties supported by patch operation ,
Required: False ,
}
{
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: tags to be updated ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Action rule object containing target scope, conditions and suppression logic ,
}
{
properties:
{
Description: action rule properties ,
Required: False ,
}
{
scope:
{
Description: scope on which action rule will apply ,
Required: False ,
}
{
scopeType:
{
Description: type of target scope ,
Enum:
{
ResourceGroup: No description available. ,
Resource: No description available. ,
Subscription: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of ARM IDs of the given scope type which will be the target of the given action rule. ,
Required: False ,
}
[
string ,
]
,
}
,
conditions:
{
Description: conditions on which alerts will be filtered ,
Required: False ,
}
{
severity:
{
Description: filter alerts by severity ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorService:
{
Description: filter alerts by monitor service ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
monitorCondition:
{
Description: filter alerts by monitor condition ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
targetResourceType:
{
Description: filter alerts by target resource type ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleId:
{
Description: filter alerts by alert rule id ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertRuleName:
{
Description: filter alerts by alert rule name ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
description:
{
Description: filter alerts by alert rule description ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
alertContext:
{
Description: filter alerts by alert context (payload) ,
Required: False ,
}
{
operator:
{
Description: operator for a given condition ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: list of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
description:
{
Description: Description of action rule ,
Required: False ,
}
string ,
createdAt:
{
Description: Creation time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedAt:
{
Description: Last updated time of action rule. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
createdBy:
{
Description: Created by user name. ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
status:
{
Description: Indicates if the given action rule is enabled or disabled ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
type:
{
Description: Indicates type of action rule ,
Enum:
{
Suppression: No description available. ,
ActionGroup: No description available. ,
Diagnostics: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetAll (removed)
Description :  List all the Smart Groups within a specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
monitorService:
{
Description: Filter by monitor service which generates the alert instance. Default value is select all. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. ,
Required: False ,
}
string ,
severity:
{
Description: Filter by severity. Default value is select all. ,
Required: False ,
}
string ,
smartGroupState:
{
Description: Filter by state of the smart group. Default value is to select all. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
pageCount:
{
Description: Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. ,
Format: int64 ,
Required: False ,
}
integer ,
sortBy:
{
Description: Sort the query results by input field. Default value is sort by 'lastModifiedDateTime'. ,
Required: False ,
}
string ,
sortOrder:
{
Description: Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: URL to fetch the next set of alerts. ,
Required: False ,
}
string ,
value:
{
Description: List of alerts ,
Required: False ,
}
[
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetById (removed)
Description :  Get information related to a specific Smart Group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Set of related alerts grouped together smartly by AMS. ,
}
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_ChangeState (removed)
Description :  Change the state of a Smart Group.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Set of related alerts grouped together smartly by AMS. ,
}
{
properties:
{
Description: Properties of smart group. ,
Required: False ,
}
{
alertsCount:
{
Description: Total number of alerts in smart group ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupState:
{
Description: Smart group state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of smart group is the highest(Sev0 >... > Sev4) severity of all the alerts in the group. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
startDateTime:
{
Description: Creation time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last updated time of smart group. Date-Time in ISO-8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: Last modified by user name. ,
Required: False ,
}
string ,
resources:
{
Description: Summary of target resources in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceTypes:
{
Description: Summary of target resource types in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
resourceGroups:
{
Description: Summary of target resource groups in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorServices:
{
Description: Summary of monitorServices in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
monitorConditions:
{
Description: Summary of monitorConditions in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertStates:
{
Description: Summary of alertStates in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
alertSeverities:
{
Description: Summary of alertSeverities in the smart group ,
Required: False ,
}
[
{
name:
{
Description: Name of the type. ,
Required: False ,
}
string ,
count:
{
Description: Total number of items of type. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of alerts. Call ListNext() with this URI to fetch the next page alerts. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}
SmartGroups_GetHistory (removed)
Description :  Get the history a smart group, which captures any Smart Group state changes (New/Acknowledged/Closed) .
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart group unique id. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the smartGroup modification item. ,
Required: False ,
}
{
smartGroupId:
{
Description: Unique Id of the smartGroup for which the history is being retrieved ,
Required: False ,
}
string ,
modifications:
{
Description: Modification details ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
SmartGroupCreated: No description available. ,
StateChange: No description available. ,
AlertAdded: No description available. ,
AlertRemoved: No description available. ,
}
,
Required: False ,
}
enum ,
oldValue:
{
Description: Old value ,
Required: False ,
}
string ,
newValue:
{
Description: New value ,
Required: False ,
}
string ,
modifiedAt:
{
Description: Modified date and time ,
Required: False ,
}
string ,
modifiedBy:
{
Description: Modified user details (Principal client name) ,
Required: False ,
}
string ,
comments:
{
Description: Modification comments ,
Required: False ,
}
string ,
description:
{
Description: Description of the modification ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of results. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Details of error response. ,
Required: False ,
}
{
code:
{
Description: Error code, intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: Description of the error, intended for display in user interface. ,
Required: False ,
}
string ,
target:
{
Description: Target of the particular error, for example name of the property. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
}
,
}