Microsoft.AlertsManagement (preview:2025-05-25)

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

Alerts_GetAllTenant (new)
Description :  List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts
{
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. Default value is to select all. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Filter the alerts list by the Smart Group Id. Default value is none. ,
Required: False ,
}
string ,
includeContext:
{
Description: Include context which has contextual data specific to the monitor service. Default value is false' ,
Required: False ,
}
boolean ,
includeEgressConfig:
{
Description: Include egress config which would be used for displaying the content in portal. Default value is 'false'. ,
Required: False ,
}
boolean ,
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 '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 ,
select:
{
Description: This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: 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: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ 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_GetByIdTenant (new)
Description :  Get information related to a specific alert.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts/{alertId}
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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_GetHistoryTenant (new)
Description :  Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert modification history properties. ,
Required: False ,
}
{
alertId:
{
Description: Unique identifier of the alert. ,
Required: False ,
}
string ,
modifications:
{
Description: Array of alert modification events. ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
SeverityChange: No description available. ,
MonitorConditionChange: No description available. ,
ActionsTriggered: No description available. ,
ActionsSuppressed: 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 ,
details:
{
Description: Base details class. ,
Required: False ,
}
{
type:
{
Description: Type of modification details ,
Enum:
{
PropertyChange: No description available. ,
ActionsSuppressed: No description available. ,
ActionsTriggered: 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 ,
]
,
}
,
}
Alerts_ChangeStateTenant (new)
Description :  Change the state of an alert.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
comment:
{
Description: reason of change alert state ,
Required: False ,
}
{
comments:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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 (new)
Description :  List all operations available through Azure Alerts Management Resource Provider.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/operations
{
api-version:
{
Description: 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 ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
}
Alerts_MetaData (new)
Description :  List alerts meta data information based on value of identifier parameter.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alertsMetaData
{
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
identifier:
{
Description: Identification of the information to be retrieved by API call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: alert meta data property bag ,
Required: False ,
}
{
metadataIdentifier:
{
Description: Identification of the information to be retrieved by API call ,
Enum:
{
MonitorServiceList: 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 ,
]
,
}
,
}
Alerts_GetAll (new)
Description :  List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. Default value is to select all. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Filter the alerts list by the Smart Group Id. Default value is none. ,
Required: False ,
}
string ,
includeContext:
{
Description: Include context which has contextual data specific to the monitor service. Default value is false' ,
Required: False ,
}
boolean ,
includeEgressConfig:
{
Description: Include egress config which would be used for displaying the content in portal. Default value is 'false'. ,
Required: False ,
}
boolean ,
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 '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 ,
select:
{
Description: This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: 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: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ 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. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get alert by id then use parent resource of scope. So in this example get alert by id call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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 an alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to change state of this particular alert then use parent resource of scope. So in this example change state call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
comment:
{
Description: reason of change alert state ,
Required: False ,
}
{
comments:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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 an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get history of this particular alert then use parent resource of scope. So in this example get history call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history'.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert modification history properties. ,
Required: False ,
}
{
alertId:
{
Description: Unique identifier of the alert. ,
Required: False ,
}
string ,
modifications:
{
Description: Array of alert modification events. ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
SeverityChange: No description available. ,
MonitorConditionChange: No description available. ,
ActionsTriggered: No description available. ,
ActionsSuppressed: 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 ,
details:
{
Description: Base details class. ,
Required: False ,
}
{
type:
{
Description: Type of modification details ,
Enum:
{
PropertyChange: No description available. ,
ActionsSuppressed: No description available. ,
ActionsTriggered: 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 ,
]
,
}
,
}
Alerts_GetSummary (new)
Description :  Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alertsSummary
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
groupby:
{
Description: This parameter allows the result set to be grouped by input fields. For example, groupby=severity,alertstate. ,
Required: True ,
}
string ,
includeSmartGroupsCount:
{
Description: Include count of the SmartGroups as part of the summary. Default value is 'false'. ,
Required: False ,
}
boolean ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. 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 ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Group the result set. ,
Required: False ,
}
{
total:
{
Description: Total count of the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupsCount:
{
Description: Total count of the smart groups. ,
Format: int64 ,
Required: False ,
}
integer ,
groupedby:
{
Description: Name of the field aggregated ,
Required: False ,
}
string ,
values:
{
Description: List of the items ,
Required: False ,
}
[
{
name:
{
Description: Value of the aggregated field ,
Required: False ,
}
string ,
count:
{
Description: Count of the aggregated field ,
Format: int64 ,
Required: False ,
}
integer ,
groupedby:
{
Description: Name of the field aggregated ,
Required: False ,
}
string ,
values:
{
Description: List of the items ,
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_GetEnrichments (new)
Description :  Get the enrichments of an alert. It returns a collection of one object named default.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List the alert's enrichments ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the alert enrichment item. ,
Required: False ,
}
{
alertId:
{
Description: Unique Id (GUID) of the alert for which the enrichments are being retrieved. ,
Required: False ,
}
string ,
enrichments:
{
Description: Enrichment details ,
Required: False ,
}
[
{
title:
{
Description: The enrichment title. ,
Required: True ,
}
string ,
description:
{
Description: The enrichment description. ,
Required: True ,
}
string ,
status:
{
Description: The status of the evaluation of the enrichment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: The error message. Will be present only if the status is 'Failed'. ,
Required: False ,
}
string ,
type:
{
Description: The enrichment type. ,
Enum:
{
PrometheusInstantQuery: No description available. ,
PrometheusRangeQuery: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Alerts_GetAllTenant (removed)
Description :  List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts
{
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. Default value is to select all. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Filter the alerts list by the Smart Group Id. Default value is none. ,
Required: False ,
}
string ,
includeContext:
{
Description: Include context which has contextual data specific to the monitor service. Default value is false' ,
Required: False ,
}
boolean ,
includeEgressConfig:
{
Description: Include egress config which would be used for displaying the content in portal. Default value is 'false'. ,
Required: False ,
}
boolean ,
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 '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 ,
select:
{
Description: This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: 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: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ 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_GetByIdTenant (removed)
Description :  Get information related to a specific alert.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts/{alertId}
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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_GetHistoryTenant (removed)
Description :  Get the history of an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert modification history properties. ,
Required: False ,
}
{
alertId:
{
Description: Unique identifier of the alert. ,
Required: False ,
}
string ,
modifications:
{
Description: Array of alert modification events. ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
SeverityChange: No description available. ,
MonitorConditionChange: No description available. ,
ActionsTriggered: No description available. ,
ActionsSuppressed: 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 ,
details:
{
Description: Base details class. ,
Required: False ,
}
{
type:
{
Description: Type of modification details ,
Enum:
{
PropertyChange: No description available. ,
ActionsSuppressed: No description available. ,
ActionsTriggered: 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 ,
]
,
}
,
}
Alerts_ChangeStateTenant (removed)
Description :  Change the state of an alert.
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
comment:
{
Description: reason of change alert state ,
Required: False ,
}
{
comments:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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: 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 ,
}
,
origin:
{
Description: Origin of the operation ,
Required: False ,
}
string ,
}
,
]
,
}
Alerts_MetaData (removed)
Description :  List alerts meta data information based on value of identifier parameter.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.AlertsManagement/alertsMetaData
{
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
identifier:
{
Description: Identification of the information to be retrieved by API call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: alert meta data property bag ,
Required: False ,
}
{
metadataIdentifier:
{
Description: Identification of the information to be retrieved by API call ,
Enum:
{
MonitorServiceList: 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 ,
]
,
}
,
}
Alerts_GetAll (removed)
Description :  List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. Default value is to select all. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Filter the alerts list by the Smart Group Id. Default value is none. ,
Required: False ,
}
string ,
includeContext:
{
Description: Include context which has contextual data specific to the monitor service. Default value is false' ,
Required: False ,
}
boolean ,
includeEgressConfig:
{
Description: Include egress config which would be used for displaying the content in portal. Default value is 'false'. ,
Required: False ,
}
boolean ,
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 '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 ,
select:
{
Description: This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. ,
Required: False ,
}
string ,
timeRange:
{
Description: Filter by time range by below listed values. Default value is 1 day. ,
Required: False ,
}
string ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: 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: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}
,
]
,
}

⚐ 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. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get alert by id then use parent resource of scope. So in this example get alert by id call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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 an alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to change state of this particular alert then use parent resource of scope. So in this example change state call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}'.
Reference :  Link ¶

⚼ Request

POST:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
newState:
{
Description: New state of the alert. ,
Required: True ,
}
string ,
comment:
{
Description: reason of change alert state ,
Required: False ,
}
{
comments:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Alert property bag ,
Required: False ,
}
{
essentials:
{
Description: This object contains consistent fields across different monitor services. ,
Required: False ,
}
{
severity:
{
Description: Severity of alert Sev0 being highest and Sev4 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: The type of signal the alert is based on, which could be metrics, logs or activity logs. ,
Enum:
{
Metric: No description available. ,
Log: No description available. ,
Unknown: No description available. ,
}
,
Required: False ,
}
enum ,
alertState:
{
Description: Alert object state, which can be modified by the user. ,
Enum:
{
New: No description available. ,
Acknowledged: No description available. ,
Closed: No description available. ,
}
,
Required: False ,
}
enum ,
monitorCondition:
{
Description: Can be 'Fired' or 'Resolved', which represents whether the underlying conditions have crossed the defined alert rule thresholds. ,
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: Name of the target ARM resource name, on which alert got created. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Resource group of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Resource type of target ARM resource, on which alert got created. ,
Required: False ,
}
string ,
monitorService:
{
Description: Monitor service on which the rule(monitor) is set. ,
Enum:
{
Application 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. ,
Log Analytics: No description available. ,
Nagios: No description available. ,
Platform: No description available. ,
SCOM: No description available. ,
ServiceHealth: No description available. ,
SmartDetector: No description available. ,
VM Insights: No description available. ,
Zabbix: No description available. ,
Resource Health: 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 for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. ,
Required: False ,
}
string ,
smartGroupId:
{
Description: Unique Id of the smart group ,
Required: False ,
}
string ,
smartGroupingReason:
{
Description: Verbose reason describing the reason why this alert instance is added to a smart group ,
Required: False ,
}
string ,
startDateTime:
{
Description: Creation time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedDateTime:
{
Description: Last modification time(ISO-8601 format) of alert instance. ,
Format: date-time ,
Required: False ,
}
string ,
monitorConditionResolvedDateTime:
{
Description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedUserName:
{
Description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. ,
Required: False ,
}
string ,
actionStatus:
{
Description: Action status ,
Required: False ,
}
{
isSuppressed:
{
Description: Value indicating whether alert is suppressed. ,
Required: False ,
}
boolean ,
}
,
description:
{
Description: Alert description. ,
Required: False ,
}
string ,
}
,
context:
{
Description: Information specific to the monitor service that gives more contextual details about the alert. ,
Required: False ,
}
object ,
egressConfig:
{
Description: Config which would be used for displaying the data in portal. ,
Required: False ,
}
object ,
customProperties:
{
Description: Custom properties that can hold any user defined key-value pairs ,
Required: False ,
}
object ,
}
,
}

⚐ 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 an alert, which captures any monitor condition changes (Fired/Resolved), alert state changes (New/Acknowledged/Closed) and applied action rules for that particular alert. If scope is a deleted resource then please use scope as parent resource of the delete resource. For example if my alert id is '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/virtualMachines/vm1/providers/Microsoft.AlertsManagement/alerts/{alertId}' and 'vm1' is deleted then if you want to get history of this particular alert then use parent resource of scope. So in this example get history call will look like this: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history'.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Alert modification history properties. ,
Required: False ,
}
{
alertId:
{
Description: Unique identifier of the alert. ,
Required: False ,
}
string ,
modifications:
{
Description: Array of alert modification events. ,
Required: False ,
}
[
{
modificationEvent:
{
Description: Reason for the modification ,
Enum:
{
AlertCreated: No description available. ,
StateChange: No description available. ,
SeverityChange: No description available. ,
MonitorConditionChange: No description available. ,
ActionsTriggered: No description available. ,
ActionsSuppressed: 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 ,
details:
{
Description: Base details class. ,
Required: False ,
}
{
type:
{
Description: Type of modification details ,
Enum:
{
PropertyChange: No description available. ,
ActionsSuppressed: No description available. ,
ActionsTriggered: 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 ,
]
,
}
,
}
Alerts_GetSummary (removed)
Description :  Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity).
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alertsSummary
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
groupby:
{
Description: This parameter allows the result set to be grouped by input fields. For example, groupby=severity,alertstate. ,
Required: True ,
}
string ,
includeSmartGroupsCount:
{
Description: Include count of the SmartGroups as part of the summary. Default value is 'false'. ,
Required: False ,
}
boolean ,
targetResource:
{
Description: Filter by target resource( which is full ARM ID) Default value is select all. ,
Required: False ,
}
string ,
targetResourceType:
{
Description: Filter by target resource type. Default value is select all. ,
Required: False ,
}
string ,
targetResourceGroup:
{
Description: Filter by target resource group name. 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 ,
alertState:
{
Description: Filter by state of the alert instance. Default value is to select all. ,
Required: False ,
}
string ,
alertRule:
{
Description: Filter by specific alert rule. 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 ,
customTimeRange:
{
Description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. ,
Required: False ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Group the result set. ,
Required: False ,
}
{
total:
{
Description: Total count of the result set. ,
Format: int64 ,
Required: False ,
}
integer ,
smartGroupsCount:
{
Description: Total count of the smart groups. ,
Format: int64 ,
Required: False ,
}
integer ,
groupedby:
{
Description: Name of the field aggregated ,
Required: False ,
}
string ,
values:
{
Description: List of the items ,
Required: False ,
}
[
{
name:
{
Description: Value of the aggregated field ,
Required: False ,
}
string ,
count:
{
Description: Count of the aggregated field ,
Format: int64 ,
Required: False ,
}
integer ,
groupedby:
{
Description: Name of the field aggregated ,
Required: False ,
}
string ,
values:
{
Description: List of the items ,
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_GetEnrichments (removed)
Description :  Get the enrichments of an alert. It returns a collection of one object named default.
Reference :  Link ¶

⚼ Request

GET:  /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments
{
scope:
{
Description: scope here is resourceId for which alert is created. ,
Required: True ,
}
string ,
alertId:
{
Description: Unique ID of an alert instance. ,
Required: True ,
}
string ,
api-version:
{
Description: API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List the alert's enrichments ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the alert enrichment item. ,
Required: False ,
}
{
alertId:
{
Description: Unique Id (GUID) of the alert for which the enrichments are being retrieved. ,
Required: False ,
}
string ,
enrichments:
{
Description: Enrichment details ,
Required: False ,
}
[
{
title:
{
Description: The enrichment title. ,
Required: True ,
}
string ,
description:
{
Description: The enrichment description. ,
Required: True ,
}
string ,
status:
{
Description: The status of the evaluation of the enrichment. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: True ,
}
enum ,
errorMessage:
{
Description: The error message. Will be present only if the status is 'Failed'. ,
Required: False ,
}
string ,
type:
{
Description: The enrichment type. ,
Enum:
{
PrometheusInstantQuery: No description available. ,
PrometheusRangeQuery: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
nextLink:
{
Description: Request URL that can be used to query next page. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}