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

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

Operations_List (new)
Description :  List all operations available through Azure Alerts Management Resource Provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/operations
{
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: Array of operations ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
display:
{
Description: Properties of the operation ,
Required: False ,
}
{
provider:
{
Description: Provider name ,
Required: False ,
}
string ,
resource:
{
Description: Resource name ,
Required: False ,
}
string ,
operation:
{
Description: Operation name ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Alerts_GetAll (new)
Description :  List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResource:
{
Description: filter by target resource ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
targetResourceType:
{
Description: filter by target resource type ,
Required: False ,
}
string ,
monitorService:
{
Description: filter by monitor service which is the source of the alert object. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: filter by monitor condition which is the state of the alert at monitor service ,
Required: False ,
}
string ,
severity:
{
Description: filter by severity ,
Required: False ,
}
string ,
alertState:
{
Description: filter by state ,
Required: False ,
}
string ,
smartGroupId:
{
Description: filter by smart Group Id ,
Required: False ,
}
string ,
includePayload:
{
Description: include payload field content, default value is 'false'. ,
Required: False ,
}
boolean ,
pageCount:
{
Description: number of items per page, default value is '25'. ,
Required: False ,
}
integer ,
sortBy:
{
Description: sort the query results by input field, default value is '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 ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
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: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_GetById (new)
Description :  Get information related to a specific alert
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_ChangeState (new)
Description :  Change the state of the alert.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: filter by state ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_GetHistory (new)
Description :  Get the history of the changes of an alert.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the alert modification item. ,
Required: False ,
}
{
alertId:
{
Description: Unique Id of the alert for which the history is being retrieved ,
Required: False ,
}
string ,
modifications:
{
Description: Modification details ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
MonitorConditionChange: 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 ,
}
,
]
,
}
,
}

⚐ 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 ,
]
,
}
,
}
Alerts_GetSummary (new)
Description :  Summary of alerts with the count each severity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Summary of the alerts ,
Required: False ,
}
{
total:
{
Description: Total number of alerts. ,
Required: False ,
}
integer ,
smartGroupsCount:
{
Description: Total number of smart groups. ,
Required: False ,
}
integer ,
summaryByState:
{
Description: Summary of alerts by state ,
Required: False ,
}
object ,
summaryBySeverity:
{
Description: Summary of alerts by severity ,
Required: False ,
}
{
sev0:
{
Description: Summary of alerts by severity 'Sev0' ,
Required: False ,
}
object ,
sev1:
{
Description: Summary of alerts by severity 'Sev1' ,
Required: False ,
}
object ,
sev2:
{
Description: Summary of alerts by severity 'Sev2' ,
Required: False ,
}
object ,
sev3:
{
Description: Summary of alerts by severity 'Sev3' ,
Required: False ,
}
object ,
sev4:
{
Description: Summary of alerts by severity 'Sev4' ,
Required: False ,
}
object ,
}
,
summaryBySeverityAndMonitorCondition:
{
Description: Summary of alerts by severity and monitor condition ,
Required: False ,
}
object ,
summaryByMonitorService:
{
Description: Summary of alerts by severity ,
Required: False ,
}
object ,
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 ,
]
,
}
,
}
SmartGroups_GetAll (new)
Description :  List all the smartGroups within the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResource:
{
Description: filter by target resource ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
targetResourceType:
{
Description: filter by target resource type ,
Required: False ,
}
string ,
monitorService:
{
Description: filter by monitor service which is the source of the alert object. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: filter by monitor condition which is the state of the alert at monitor service ,
Required: False ,
}
string ,
severity:
{
Description: filter by severity ,
Required: False ,
}
string ,
smartGroupState:
{
Description: filter by state ,
Required: False ,
}
string ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
Required: False ,
}
string ,
pageCount:
{
Description: number of items per page, default value is '25'. ,
Required: False ,
}
integer ,
sortBy:
{
Description: sort the query results by input field, default value is '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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 details of smart group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group 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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 from unresolved to resolved and all the alerts within the smart group will also be resolved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group Id ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: filter by state ,
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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 of the changes of smart group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group 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 ,
]
,
}
,
}
Operations_List (removed)
Description :  List all operations available through Azure Alerts Management Resource Provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/operations
{
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: Array of operations ,
Required: True ,
}
[
{
name:
{
Description: Name of the operation ,
Required: False ,
}
string ,
display:
{
Description: Properties of the operation ,
Required: False ,
}
{
provider:
{
Description: Provider name ,
Required: False ,
}
string ,
resource:
{
Description: Resource name ,
Required: False ,
}
string ,
operation:
{
Description: Operation name ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Alerts_GetAll (removed)
Description :  List all the existing alerts, where the results can be selective by passing multiple filter parameters including time range and sorted on specific fields.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResource:
{
Description: filter by target resource ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
targetResourceType:
{
Description: filter by target resource type ,
Required: False ,
}
string ,
monitorService:
{
Description: filter by monitor service which is the source of the alert object. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: filter by monitor condition which is the state of the alert at monitor service ,
Required: False ,
}
string ,
severity:
{
Description: filter by severity ,
Required: False ,
}
string ,
alertState:
{
Description: filter by state ,
Required: False ,
}
string ,
smartGroupId:
{
Description: filter by smart Group Id ,
Required: False ,
}
string ,
includePayload:
{
Description: include payload field content, default value is 'false'. ,
Required: False ,
}
boolean ,
pageCount:
{
Description: number of items per page, default value is '25'. ,
Required: False ,
}
integer ,
sortBy:
{
Description: sort the query results by input field, default value is '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 ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
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: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_GetById (removed)
Description :  Get information related to a specific alert
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_ChangeState (removed)
Description :  Change the state of the alert.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: filter by state ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: An alert created in alert management service. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev1 being highest and Sev3 being lowest. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
signalType:
{
Description: Log based alert or metric based alert ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Condition of the rule at the monitor service ,
Enum:
{
Fired: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
targetResource:
{
Description: Target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceName:
{
Description: Target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service which is the source of the alert object. ,
Enum:
{
Platform: No description available. ,
Application Insights: No description available. ,
Log Analytics: No description available. ,
Infrastructure Insights: No description available. ,
ActivityLog Administrative: No description available. ,
ActivityLog Security: No description available. ,
ActivityLog Recommendation: No description available. ,
ActivityLog Policy: No description available. ,
ActivityLog Autoscale: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
Zabbix: No description available. ,
SCOM: No description available. ,
Nagios: No description available. ,
}
,
Required: False ,
}
enum ,
alertRule:
{
Description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. ,
Required: False ,
}
string ,
sourceCreatedId:
{
Description: Unique Id created by monitor service ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Reason for addition to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert. ,
Required: False ,
}
string ,
payload:
{
Description: More details which are contextual to the monitor service. ,
Required: False ,
}
object ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
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 ,
]
,
}
,
}
Alerts_GetHistory (removed)
Description :  Get the history of the changes of an alert.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert object. ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the alert modification item. ,
Required: False ,
}
{
alertId:
{
Description: Unique Id of the alert for which the history is being retrieved ,
Required: False ,
}
string ,
modifications:
{
Description: Modification details ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
MonitorConditionChange: 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 ,
}
,
]
,
}
,
}

⚐ 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 ,
]
,
}
,
}
Alerts_GetSummary (removed)
Description :  Summary of alerts with the count each severity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertsSummary
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
Required: False ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Summary of the alerts ,
Required: False ,
}
{
total:
{
Description: Total number of alerts. ,
Required: False ,
}
integer ,
smartGroupsCount:
{
Description: Total number of smart groups. ,
Required: False ,
}
integer ,
summaryByState:
{
Description: Summary of alerts by state ,
Required: False ,
}
object ,
summaryBySeverity:
{
Description: Summary of alerts by severity ,
Required: False ,
}
{
sev0:
{
Description: Summary of alerts by severity 'Sev0' ,
Required: False ,
}
object ,
sev1:
{
Description: Summary of alerts by severity 'Sev1' ,
Required: False ,
}
object ,
sev2:
{
Description: Summary of alerts by severity 'Sev2' ,
Required: False ,
}
object ,
sev3:
{
Description: Summary of alerts by severity 'Sev3' ,
Required: False ,
}
object ,
sev4:
{
Description: Summary of alerts by severity 'Sev4' ,
Required: False ,
}
object ,
}
,
summaryBySeverityAndMonitorCondition:
{
Description: Summary of alerts by severity and monitor condition ,
Required: False ,
}
object ,
summaryByMonitorService:
{
Description: Summary of alerts by severity ,
Required: False ,
}
object ,
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 ,
]
,
}
,
}
SmartGroups_GetAll (removed)
Description :  List all the smartGroups within the specified subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
targetResource:
{
Description: filter by target resource ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: filter by target resource group name ,
Required: False ,
}
string ,
targetResourceType:
{
Description: filter by target resource type ,
Required: False ,
}
string ,
monitorService:
{
Description: filter by monitor service which is the source of the alert object. ,
Required: False ,
}
string ,
monitorCondition:
{
Description: filter by monitor condition which is the state of the alert at monitor service ,
Required: False ,
}
string ,
severity:
{
Description: filter by severity ,
Required: False ,
}
string ,
smartGroupState:
{
Description: filter by state ,
Required: False ,
}
string ,
timeRange:
{
Description: filter by time range, default value is 1 day ,
Required: False ,
}
string ,
pageCount:
{
Description: number of items per page, default value is '25'. ,
Required: False ,
}
integer ,
sortBy:
{
Description: sort the query results by input field, default value is '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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 details of smart group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group 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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 from unresolved to resolved and all the alerts within the smart group will also be resolved.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/changeState
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group Id ,
Required: True ,
}
string ,
api-version:
{
Description: client API version ,
Required: True ,
}
string ,
newState:
{
Description: filter by state ,
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 ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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. ,
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 of the changes of smart group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/smartGroups/{smartGroupId}/history
{
subscriptionId:
{
Description: subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
smartGroupId:
{
Description: Smart Group 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 ,
]
,
}
,
}