Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. alertsmanagement
  5. getAlertProcessingRuleByName
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.alertsmanagement.getAlertProcessingRuleByName

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get an alert processing rule by name. Azure REST API version: 2021-08-08.

Using getAlertProcessingRuleByName

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAlertProcessingRuleByName(args: GetAlertProcessingRuleByNameArgs, opts?: InvokeOptions): Promise<GetAlertProcessingRuleByNameResult>
function getAlertProcessingRuleByNameOutput(args: GetAlertProcessingRuleByNameOutputArgs, opts?: InvokeOptions): Output<GetAlertProcessingRuleByNameResult>
Copy
def get_alert_processing_rule_by_name(alert_processing_rule_name: Optional[str] = None,
                                      resource_group_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetAlertProcessingRuleByNameResult
def get_alert_processing_rule_by_name_output(alert_processing_rule_name: Optional[pulumi.Input[str]] = None,
                                      resource_group_name: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetAlertProcessingRuleByNameResult]
Copy
func LookupAlertProcessingRuleByName(ctx *Context, args *LookupAlertProcessingRuleByNameArgs, opts ...InvokeOption) (*LookupAlertProcessingRuleByNameResult, error)
func LookupAlertProcessingRuleByNameOutput(ctx *Context, args *LookupAlertProcessingRuleByNameOutputArgs, opts ...InvokeOption) LookupAlertProcessingRuleByNameResultOutput
Copy

> Note: This function is named LookupAlertProcessingRuleByName in the Go SDK.

public static class GetAlertProcessingRuleByName 
{
    public static Task<GetAlertProcessingRuleByNameResult> InvokeAsync(GetAlertProcessingRuleByNameArgs args, InvokeOptions? opts = null)
    public static Output<GetAlertProcessingRuleByNameResult> Invoke(GetAlertProcessingRuleByNameInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAlertProcessingRuleByNameResult> getAlertProcessingRuleByName(GetAlertProcessingRuleByNameArgs args, InvokeOptions options)
public static Output<GetAlertProcessingRuleByNameResult> getAlertProcessingRuleByName(GetAlertProcessingRuleByNameArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:alertsmanagement:getAlertProcessingRuleByName
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AlertProcessingRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the alert processing rule that needs to be fetched.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name where the resource is created.
AlertProcessingRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the alert processing rule that needs to be fetched.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name where the resource is created.
alertProcessingRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the alert processing rule that needs to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource group name where the resource is created.
alertProcessingRuleName
This property is required.
Changes to this property will trigger replacement.
string
The name of the alert processing rule that needs to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Resource group name where the resource is created.
alert_processing_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the alert processing rule that needs to be fetched.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Resource group name where the resource is created.
alertProcessingRuleName
This property is required.
Changes to this property will trigger replacement.
String
The name of the alert processing rule that needs to be fetched.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Resource group name where the resource is created.

getAlertProcessingRuleByName Result

The following output properties are available:

Id string
Azure resource Id
Location string
Resource location
Name string
Azure resource name
Properties Pulumi.AzureNative.AlertsManagement.Outputs.AlertProcessingRulePropertiesResponse
Alert processing rule properties.
SystemData Pulumi.AzureNative.AlertsManagement.Outputs.SystemDataResponse
Alert processing rule system data.
Type string
Azure resource type
Tags Dictionary<string, string>
Resource tags
Id string
Azure resource Id
Location string
Resource location
Name string
Azure resource name
Properties AlertProcessingRulePropertiesResponse
Alert processing rule properties.
SystemData SystemDataResponse
Alert processing rule system data.
Type string
Azure resource type
Tags map[string]string
Resource tags
id String
Azure resource Id
location String
Resource location
name String
Azure resource name
properties AlertProcessingRulePropertiesResponse
Alert processing rule properties.
systemData SystemDataResponse
Alert processing rule system data.
type String
Azure resource type
tags Map<String,String>
Resource tags
id string
Azure resource Id
location string
Resource location
name string
Azure resource name
properties AlertProcessingRulePropertiesResponse
Alert processing rule properties.
systemData SystemDataResponse
Alert processing rule system data.
type string
Azure resource type
tags {[key: string]: string}
Resource tags
id str
Azure resource Id
location str
Resource location
name str
Azure resource name
properties AlertProcessingRulePropertiesResponse
Alert processing rule properties.
system_data SystemDataResponse
Alert processing rule system data.
type str
Azure resource type
tags Mapping[str, str]
Resource tags
id String
Azure resource Id
location String
Resource location
name String
Azure resource name
properties Property Map
Alert processing rule properties.
systemData Property Map
Alert processing rule system data.
type String
Azure resource type
tags Map<String>
Resource tags

Supporting Types

AddActionGroupsResponse

ActionGroupIds This property is required. List<string>
List of action group Ids to add to alert processing rule.
ActionGroupIds This property is required. []string
List of action group Ids to add to alert processing rule.
actionGroupIds This property is required. List<String>
List of action group Ids to add to alert processing rule.
actionGroupIds This property is required. string[]
List of action group Ids to add to alert processing rule.
action_group_ids This property is required. Sequence[str]
List of action group Ids to add to alert processing rule.
actionGroupIds This property is required. List<String>
List of action group Ids to add to alert processing rule.

AlertProcessingRulePropertiesResponse

Actions This property is required. List<Union<Pulumi.AzureNative.AlertsManagement.Inputs.AddActionGroupsResponse, Pulumi.AzureNative.AlertsManagement.Inputs.RemoveAllActionGroupsResponse>>
Actions to be applied.
Scopes This property is required. List<string>
Scopes on which alert processing rule will apply.
Conditions List<Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse>
Conditions on which alerts will be filtered.
Description string
Description of alert processing rule.
Enabled bool
Indicates if the given alert processing rule is enabled or disabled.
Schedule Pulumi.AzureNative.AlertsManagement.Inputs.ScheduleResponse
Scheduling for alert processing rule.
Actions This property is required. []interface{}
Actions to be applied.
Scopes This property is required. []string
Scopes on which alert processing rule will apply.
Conditions []ConditionResponse
Conditions on which alerts will be filtered.
Description string
Description of alert processing rule.
Enabled bool
Indicates if the given alert processing rule is enabled or disabled.
Schedule ScheduleResponse
Scheduling for alert processing rule.
actions This property is required. List<Either<AddActionGroupsResponse,RemoveAllActionGroupsResponse>>
Actions to be applied.
scopes This property is required. List<String>
Scopes on which alert processing rule will apply.
conditions List<ConditionResponse>
Conditions on which alerts will be filtered.
description String
Description of alert processing rule.
enabled Boolean
Indicates if the given alert processing rule is enabled or disabled.
schedule ScheduleResponse
Scheduling for alert processing rule.
actions This property is required. (AddActionGroupsResponse | RemoveAllActionGroupsResponse)[]
Actions to be applied.
scopes This property is required. string[]
Scopes on which alert processing rule will apply.
conditions ConditionResponse[]
Conditions on which alerts will be filtered.
description string
Description of alert processing rule.
enabled boolean
Indicates if the given alert processing rule is enabled or disabled.
schedule ScheduleResponse
Scheduling for alert processing rule.
actions This property is required. Sequence[Union[AddActionGroupsResponse, RemoveAllActionGroupsResponse]]
Actions to be applied.
scopes This property is required. Sequence[str]
Scopes on which alert processing rule will apply.
conditions Sequence[ConditionResponse]
Conditions on which alerts will be filtered.
description str
Description of alert processing rule.
enabled bool
Indicates if the given alert processing rule is enabled or disabled.
schedule ScheduleResponse
Scheduling for alert processing rule.
actions This property is required. List<Property Map | Property Map>
Actions to be applied.
scopes This property is required. List<String>
Scopes on which alert processing rule will apply.
conditions List<Property Map>
Conditions on which alerts will be filtered.
description String
Description of alert processing rule.
enabled Boolean
Indicates if the given alert processing rule is enabled or disabled.
schedule Property Map
Scheduling for alert processing rule.

ConditionResponse

Field string
Field for a given condition.
Operator string
Operator for a given condition.
Values List<string>
List of values to match for a given condition.
Field string
Field for a given condition.
Operator string
Operator for a given condition.
Values []string
List of values to match for a given condition.
field String
Field for a given condition.
operator String
Operator for a given condition.
values List<String>
List of values to match for a given condition.
field string
Field for a given condition.
operator string
Operator for a given condition.
values string[]
List of values to match for a given condition.
field str
Field for a given condition.
operator str
Operator for a given condition.
values Sequence[str]
List of values to match for a given condition.
field String
Field for a given condition.
operator String
Operator for a given condition.
values List<String>
List of values to match for a given condition.

DailyRecurrenceResponse

EndTime This property is required. string
End time for recurrence.
StartTime This property is required. string
Start time for recurrence.
EndTime This property is required. string
End time for recurrence.
StartTime This property is required. string
Start time for recurrence.
endTime This property is required. String
End time for recurrence.
startTime This property is required. String
Start time for recurrence.
endTime This property is required. string
End time for recurrence.
startTime This property is required. string
Start time for recurrence.
end_time This property is required. str
End time for recurrence.
start_time This property is required. str
Start time for recurrence.
endTime This property is required. String
End time for recurrence.
startTime This property is required. String
Start time for recurrence.

MonthlyRecurrenceResponse

DaysOfMonth This property is required. List<int>
Specifies the values for monthly recurrence pattern.
EndTime string
End time for recurrence.
StartTime string
Start time for recurrence.
DaysOfMonth This property is required. []int
Specifies the values for monthly recurrence pattern.
EndTime string
End time for recurrence.
StartTime string
Start time for recurrence.
daysOfMonth This property is required. List<Integer>
Specifies the values for monthly recurrence pattern.
endTime String
End time for recurrence.
startTime String
Start time for recurrence.
daysOfMonth This property is required. number[]
Specifies the values for monthly recurrence pattern.
endTime string
End time for recurrence.
startTime string
Start time for recurrence.
days_of_month This property is required. Sequence[int]
Specifies the values for monthly recurrence pattern.
end_time str
End time for recurrence.
start_time str
Start time for recurrence.
daysOfMonth This property is required. List<Number>
Specifies the values for monthly recurrence pattern.
endTime String
End time for recurrence.
startTime String
Start time for recurrence.

RemoveAllActionGroupsResponse

ScheduleResponse

EffectiveFrom string
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
EffectiveUntil string
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
Recurrences List<object>
List of recurrences.
TimeZone string
Scheduling time zone.
EffectiveFrom string
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
EffectiveUntil string
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
Recurrences []interface{}
List of recurrences.
TimeZone string
Scheduling time zone.
effectiveFrom String
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
effectiveUntil String
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
recurrences List<Object>
List of recurrences.
timeZone String
Scheduling time zone.
effectiveFrom string
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
effectiveUntil string
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
recurrences (DailyRecurrenceResponse | MonthlyRecurrenceResponse | WeeklyRecurrenceResponse)[]
List of recurrences.
timeZone string
Scheduling time zone.
effective_from str
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
effective_until str
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
recurrences Sequence[Union[DailyRecurrenceResponse, MonthlyRecurrenceResponse, WeeklyRecurrenceResponse]]
List of recurrences.
time_zone str
Scheduling time zone.
effectiveFrom String
Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix.
effectiveUntil String
Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix.
recurrences List<Property Map | Property Map | Property Map>
List of recurrences.
timeZone String
Scheduling time zone.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

WeeklyRecurrenceResponse

DaysOfWeek This property is required. List<string>
Specifies the values for weekly recurrence pattern.
EndTime string
End time for recurrence.
StartTime string
Start time for recurrence.
DaysOfWeek This property is required. []string
Specifies the values for weekly recurrence pattern.
EndTime string
End time for recurrence.
StartTime string
Start time for recurrence.
daysOfWeek This property is required. List<String>
Specifies the values for weekly recurrence pattern.
endTime String
End time for recurrence.
startTime String
Start time for recurrence.
daysOfWeek This property is required. string[]
Specifies the values for weekly recurrence pattern.
endTime string
End time for recurrence.
startTime string
Start time for recurrence.
days_of_week This property is required. Sequence[str]
Specifies the values for weekly recurrence pattern.
end_time str
End time for recurrence.
start_time str
Start time for recurrence.
daysOfWeek This property is required. List<String>
Specifies the values for weekly recurrence pattern.
endTime String
End time for recurrence.
startTime String
Start time for recurrence.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native