microsoft.alertsManagement (stable:2019-03-01)

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

SmartDetectorAlertRules_List (new)
Description :  List all the existing Smart Detector alert rules within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/microsoft.alertsManagement/smartDetectorAlertRules
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: List of Smart Detector alert rules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
SmartDetectorAlertRules_ListByResourceGroup (new)
Description :  List all the existing Smart Detector alert rules within the subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: List of Smart Detector alert rules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
SmartDetectorAlertRules_Get (new)
Description :  Get a specific Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
expandDetector:
{
Description: Indicates if Smart Detector should be expanded. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_CreateOrUpdate (new)
Description :  Create or update a Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_Patch (new)
Description :  Patch a specific Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
actionGroups:
{
Description: The alert rule actions. ,
Required: False ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_Delete (new)
Description :  Delete an existing Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{}

⚐ Response (204)

{}
SmartDetectorAlertRules_List (removed)
Description :  List all the existing Smart Detector alert rules within the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/microsoft.alertsManagement/smartDetectorAlertRules
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: List of Smart Detector alert rules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
SmartDetectorAlertRules_ListByResourceGroup (removed)
Description :  List all the existing Smart Detector alert rules within the subscription and resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: List of Smart Detector alert rules. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
SmartDetectorAlertRules_Get (removed)
Description :  Get a specific Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
expandDetector:
{
Description: Indicates if Smart Detector should be expanded. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_CreateOrUpdate (removed)
Description :  Create or update a Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_Patch (removed)
Description :  Patch a specific Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
id:
{
Description: The resource ID. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
tags:
{
Description: The resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: False ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: False ,
}
string ,
actionGroups:
{
Description: The alert rule actions. ,
Required: False ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Description: The properties of the alert rule. ,
Required: False ,
}
{
description:
{
Description: The alert rule description. ,
Required: False ,
}
string ,
state:
{
Description: The alert rule state. ,
Enum:
{
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: True ,
}
enum ,
severity:
{
Description: The alert rule severity. ,
Enum:
{
Sev0: No description available. ,
Sev1: No description available. ,
Sev2: No description available. ,
Sev3: No description available. ,
Sev4: No description available. ,
}
,
Required: True ,
}
enum ,
frequency:
{
Description: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 5 minutes. ,
Format: duration ,
Required: True ,
}
string ,
detector:
{
Description: The alert rule's detector. ,
Required: True ,
}
{
id:
{
Description: The detector id. ,
Required: True ,
}
string ,
parameters:
{
Description: The detector's parameters.' ,
Required: False ,
}
object ,
name:
{
Description: The Smart Detector name. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
description:
{
Description: The Smart Detector description. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
string ,
supportedResourceTypes:
{
Description: The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
imagePaths:
{
Description: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector ,
Required: False ,
}
[
string ,
]
,
}
,
scope:
{
Description: The alert rule resources scope. ,
Required: True ,
}
[
string ,
]
,
actionGroups:
{
Description: The alert rule actions. ,
Required: True ,
}
{
customEmailSubject:
{
Description: An optional custom email subject to use in email notifications. ,
Required: False ,
}
string ,
customWebhookPayload:
{
Description: An optional custom web-hook payload to use in web-hook notifications. ,
Required: False ,
}
string ,
groupIds:
{
Description: The Action Group resource IDs. ,
Required: True ,
}
[
string ,
]
,
}
,
throttling:
{
Description: The alert rule throttling information. ,
Required: False ,
}
{
duration:
{
Description: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes ,
Format: duration ,
Required: False ,
}
string ,
}
,
}
,
}
SmartDetectorAlertRules_Delete (removed)
Description :  Delete an existing Smart Detector alert rule.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
{
subscriptionId:
{
Description: The Azure subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
alertRuleName:
{
Description: The name of the alert rule. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{}

⚐ Response (204)

{}