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

2024/12/16 • 6 deleted methods

AlertProcessingRules_ListBySubscription (removed)
Description :  List all alert processing rules in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.AlertsManagement/actionRules
{
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 ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of alert processing rules. ,
}
{
nextLink:
{
Description: URL to fetch the next set of alert processing rules. ,
Required: False ,
}
string ,
value:
{
Description: List of alert processing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
]
,
}
,
}
AlertProcessingRules_ListByResourceGroup (removed)
Description :  List all alert processing rules in a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: List of alert processing rules. ,
}
{
nextLink:
{
Description: URL to fetch the next set of alert processing rules. ,
Required: False ,
}
string ,
value:
{
Description: List of alert processing rules. ,
Required: False ,
}
[
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
]
,
}
,
}
AlertProcessingRules_GetByName (removed)
Description :  Get an alert processing rule by name.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Alert processing rule object containing target scopes, conditions and scheduling logic. ,
}
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
]
,
}
,
}
AlertProcessingRules_CreateOrUpdate (removed)
Description :  Create or update an alert processing rule.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
alertProcessingRuleName:
{
Description: The name of the alert processing rule that needs to be created/updated. ,
Required: True ,
}
string ,
alertProcessingRule:
{
Description: Alert processing rule to be created/updated. ,
Required: True ,
}
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Alert processing rule object containing target scopes, conditions and scheduling logic. ,
}
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Alert processing rule object containing target scopes, conditions and scheduling logic. ,
}
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
]
,
}
,
}
AlertProcessingRules_Delete (removed)
Description :  Delete an alert processing rule.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (204)

{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
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 ,
]
,
}
,
}
AlertProcessingRules_Update (removed)
Description :  Enable, disable, or update tags for an alert processing rule.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AlertsManagement/actionRules/{alertProcessingRuleName}
{
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: Resource group name where the resource is created. ,
Required: True ,
}
string ,
alertProcessingRuleName:
{
Description: The name that needs to be updated. ,
Required: True ,
}
string ,
alertProcessingRulePatch:
{
Description: Parameters supplied to the operation. ,
Required: True ,
}
{
properties:
{
Description: Properties supported by patch operation. ,
Required: False ,
}
{
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Tags to be updated. ,
Required: False ,
}
object ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-request-id:
{
Description: Service generated Request ID. ,
}
string ,
}
,
$schema:
{
Description: Alert processing rule object containing target scopes, conditions and scheduling logic. ,
}
{
properties:
{
Description: Alert processing rule properties. ,
Required: False ,
}
{
scopes:
{
Description: Scopes on which alert processing rule will apply. ,
Required: True ,
}
[
string ,
]
,
conditions:
{
Description: Conditions on which alerts will be filtered. ,
Required: False ,
}
[
{
field:
{
Description: Field for a given condition. ,
Enum:
{
Severity: No description available. ,
MonitorService: No description available. ,
MonitorCondition: No description available. ,
SignalType: No description available. ,
TargetResourceType: No description available. ,
TargetResource: No description available. ,
TargetResourceGroup: No description available. ,
AlertRuleId: No description available. ,
AlertRuleName: No description available. ,
Description: No description available. ,
AlertContext: No description available. ,
}
,
Required: False ,
}
enum ,
operator:
{
Description: Operator for a given condition. ,
Enum:
{
Equals: No description available. ,
NotEquals: No description available. ,
Contains: No description available. ,
DoesNotContain: No description available. ,
}
,
Required: False ,
}
enum ,
values:
{
Description: List of values to match for a given condition. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
schedule:
{
Description: Scheduling for alert processing rule. ,
Required: False ,
}
{
effectiveFrom:
{
Description: Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
effectiveUntil:
{
Description: Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. ,
Required: False ,
}
string ,
timeZone:
{
Description: Scheduling time zone. ,
Required: False ,
}
string ,
recurrences:
{
Description: List of recurrences. ,
Required: False ,
}
[
{
recurrenceType:
{
Description: Specifies when the recurrence should be applied. ,
Enum:
{
Daily: No description available. ,
Weekly: No description available. ,
Monthly: No description available. ,
}
,
Required: True ,
}
enum ,
startTime:
{
Description: Start time for recurrence. ,
Required: False ,
}
string ,
endTime:
{
Description: End time for recurrence. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actions:
{
Description: Actions to be applied. ,
Required: True ,
}
[
{
actionType:
{
Description: Action that should be applied. ,
Enum:
{
AddActionGroups: No description available. ,
RemoveAllActionGroups: No description available. ,
CorrelateAlerts: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
description:
{
Description: Description of alert processing rule. ,
Required: False ,
}
string ,
enabled:
{
Description: Indicates if the given alert processing rule is enabled or disabled. ,
Required: False ,
}
boolean ,
}
,
systemData:
{
Description: Alert processing rule system data. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 ,
]
,
}
,
}