Microsoft.AlertsManagement (preview:2023-08-01)

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

AlertRuleRecommendations_ListByResource (new)
Description :  Retrieve alert rule recommendations for a resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AlertsManagement/alertRuleRecommendations
{
resourceUri:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule recommendations. ,
Required: True ,
}
[
{
properties:
{
Description: recommendation properties. ,
Required: True ,
}
{
alertRuleType:
{
Description: The recommendation alert rule type. ,
Required: True ,
}
string ,
category:
{
Description: The recommendation alert rule category. ,
Required: False ,
}
string ,
displayInformation:
{
Description: A dictionary that provides the display information for an alert rule recommendation. ,
Required: True ,
}
object ,
ruleArmTemplate:
{
Description: A complete ARM template to deploy the alert rules. ,
Required: True ,
}
{
$schema:
{
Description: JSON schema reference ,
Required: True ,
}
string ,
contentVersion:
{
Description: A 4 number format for the version number of this template file. For example, 1.0.0.0 ,
Required: True ,
}
string ,
variables:
{
Description: Variable definitions ,
Required: True ,
}
object ,
parameters:
{
Description: Input parameter definitions ,
Required: True ,
}
object ,
resources:
{
Description: Alert rule resource definitions ,
Required: True ,
}
[
object ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of recommendations. ,
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 ,
}
,
]
,
}
,
}
AlertRuleRecommendations_ListByTargetType (new)
Description :  Retrieve alert rule recommendations for a target type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertRuleRecommendations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
targetType:
{
Description: The recommendations target type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule recommendations. ,
Required: True ,
}
[
{
properties:
{
Description: recommendation properties. ,
Required: True ,
}
{
alertRuleType:
{
Description: The recommendation alert rule type. ,
Required: True ,
}
string ,
category:
{
Description: The recommendation alert rule category. ,
Required: False ,
}
string ,
displayInformation:
{
Description: A dictionary that provides the display information for an alert rule recommendation. ,
Required: True ,
}
object ,
ruleArmTemplate:
{
Description: A complete ARM template to deploy the alert rules. ,
Required: True ,
}
{
$schema:
{
Description: JSON schema reference ,
Required: True ,
}
string ,
contentVersion:
{
Description: A 4 number format for the version number of this template file. For example, 1.0.0.0 ,
Required: True ,
}
string ,
variables:
{
Description: Variable definitions ,
Required: True ,
}
object ,
parameters:
{
Description: Input parameter definitions ,
Required: True ,
}
object ,
resources:
{
Description: Alert rule resource definitions ,
Required: True ,
}
[
object ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of recommendations. ,
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 ,
}
,
]
,
}
,
}
AlertRuleRecommendations_ListByResource (removed)
Description :  Retrieve alert rule recommendations for a resource.
Reference :  Link ¶

⚼ Request

GET:  /{resourceUri}/providers/Microsoft.AlertsManagement/alertRuleRecommendations
{
resourceUri:
{
Description: The identifier of the resource. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule recommendations. ,
Required: True ,
}
[
{
properties:
{
Description: recommendation properties. ,
Required: True ,
}
{
alertRuleType:
{
Description: The recommendation alert rule type. ,
Required: True ,
}
string ,
category:
{
Description: The recommendation alert rule category. ,
Required: False ,
}
string ,
displayInformation:
{
Description: A dictionary that provides the display information for an alert rule recommendation. ,
Required: True ,
}
object ,
ruleArmTemplate:
{
Description: A complete ARM template to deploy the alert rules. ,
Required: True ,
}
{
$schema:
{
Description: JSON schema reference ,
Required: True ,
}
string ,
contentVersion:
{
Description: A 4 number format for the version number of this template file. For example, 1.0.0.0 ,
Required: True ,
}
string ,
variables:
{
Description: Variable definitions ,
Required: True ,
}
object ,
parameters:
{
Description: Input parameter definitions ,
Required: True ,
}
object ,
resources:
{
Description: Alert rule resource definitions ,
Required: True ,
}
[
object ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of recommendations. ,
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 ,
}
,
]
,
}
,
}
AlertRuleRecommendations_ListByTargetType (removed)
Description :  Retrieve alert rule recommendations for a target type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/alertRuleRecommendations
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
targetType:
{
Description: The recommendations target type. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: the values for the alert rule recommendations. ,
Required: True ,
}
[
{
properties:
{
Description: recommendation properties. ,
Required: True ,
}
{
alertRuleType:
{
Description: The recommendation alert rule type. ,
Required: True ,
}
string ,
category:
{
Description: The recommendation alert rule category. ,
Required: False ,
}
string ,
displayInformation:
{
Description: A dictionary that provides the display information for an alert rule recommendation. ,
Required: True ,
}
object ,
ruleArmTemplate:
{
Description: A complete ARM template to deploy the alert rules. ,
Required: True ,
}
{
$schema:
{
Description: JSON schema reference ,
Required: True ,
}
string ,
contentVersion:
{
Description: A 4 number format for the version number of this template file. For example, 1.0.0.0 ,
Required: True ,
}
string ,
variables:
{
Description: Variable definitions ,
Required: True ,
}
object ,
parameters:
{
Description: Input parameter definitions ,
Required: True ,
}
object ,
resources:
{
Description: Alert rule resource definitions ,
Required: True ,
}
[
object ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: URL to fetch the next set of recommendations. ,
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 ,
}
,
]
,
}
,
}