1. Packages
  2. Azure Native
  3. API Docs
  4. alertsmanagement
  5. getActionRuleByName
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.alertsmanagement.getActionRuleByName

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Get a specific action rule Azure REST API version: 2019-05-05-preview.

    Other available API versions: 2018-11-02-privatepreview.

    Using getActionRuleByName

    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 getActionRuleByName(args: GetActionRuleByNameArgs, opts?: InvokeOptions): Promise<GetActionRuleByNameResult>
    function getActionRuleByNameOutput(args: GetActionRuleByNameOutputArgs, opts?: InvokeOptions): Output<GetActionRuleByNameResult>
    def get_action_rule_by_name(action_rule_name: Optional[str] = None,
                                resource_group_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetActionRuleByNameResult
    def get_action_rule_by_name_output(action_rule_name: Optional[pulumi.Input[str]] = None,
                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetActionRuleByNameResult]
    func LookupActionRuleByName(ctx *Context, args *LookupActionRuleByNameArgs, opts ...InvokeOption) (*LookupActionRuleByNameResult, error)
    func LookupActionRuleByNameOutput(ctx *Context, args *LookupActionRuleByNameOutputArgs, opts ...InvokeOption) LookupActionRuleByNameResultOutput

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

    public static class GetActionRuleByName 
    {
        public static Task<GetActionRuleByNameResult> InvokeAsync(GetActionRuleByNameArgs args, InvokeOptions? opts = null)
        public static Output<GetActionRuleByNameResult> Invoke(GetActionRuleByNameInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetActionRuleByNameResult> getActionRuleByName(GetActionRuleByNameArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:alertsmanagement:getActionRuleByName
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ActionRuleName string
    The name of action rule that needs to be fetched
    ResourceGroupName string
    Resource group name where the resource is created.
    ActionRuleName string
    The name of action rule that needs to be fetched
    ResourceGroupName string
    Resource group name where the resource is created.
    actionRuleName String
    The name of action rule that needs to be fetched
    resourceGroupName String
    Resource group name where the resource is created.
    actionRuleName string
    The name of action rule that needs to be fetched
    resourceGroupName string
    Resource group name where the resource is created.
    action_rule_name str
    The name of action rule that needs to be fetched
    resource_group_name str
    Resource group name where the resource is created.
    actionRuleName String
    The name of action rule that needs to be fetched
    resourceGroupName String
    Resource group name where the resource is created.

    getActionRuleByName 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.ActionGroupResponse | Pulumi.AzureNative.AlertsManagement.Outputs.DiagnosticsResponse | Pulumi.AzureNative.AlertsManagement.Outputs.SuppressionResponse
    action rule properties
    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 ActionGroupResponse | DiagnosticsResponse | SuppressionResponse
    action rule properties
    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 ActionGroupResponse | DiagnosticsResponse | SuppressionResponse
    action rule properties
    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 ActionGroupResponse | DiagnosticsResponse | SuppressionResponse
    action rule properties
    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 ActionGroupResponse | DiagnosticsResponse | SuppressionResponse
    action rule properties
    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 | Property Map | Property Map
    action rule properties
    type String
    Azure resource type
    tags Map<String>
    Resource tags

    Supporting Types

    ActionGroupResponse

    ActionGroupId string
    Action group to trigger if action rule matches
    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    Conditions Pulumi.AzureNative.AlertsManagement.Inputs.ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope Pulumi.AzureNative.AlertsManagement.Inputs.ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    ActionGroupId string
    Action group to trigger if action rule matches
    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    Conditions ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    actionGroupId String
    Action group to trigger if action rule matches
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled
    actionGroupId string
    Action group to trigger if action rule matches
    createdAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy string
    Created by user name.
    lastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy string
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description string
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status string
    Indicates if the given action rule is enabled or disabled
    action_group_id str
    Action group to trigger if action rule matches
    created_at str
    Creation time of action rule. Date-Time in ISO-8601 format.
    created_by str
    Created by user name.
    last_modified_at str
    Last updated time of action rule. Date-Time in ISO-8601 format.
    last_modified_by str
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description str
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status str
    Indicates if the given action rule is enabled or disabled
    actionGroupId String
    Action group to trigger if action rule matches
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    conditions Property Map
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope Property Map
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled

    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.

    ConditionsResponse

    AlertContext Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by alert context (payload)
    AlertRuleId Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by alert rule id
    AlertRuleName Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by alert rule name
    Description Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by alert rule description
    MonitorCondition Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by monitor condition
    MonitorService Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by monitor service
    Severity Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by severity
    TargetResourceType Pulumi.AzureNative.AlertsManagement.Inputs.ConditionResponse
    filter alerts by target resource type
    AlertContext ConditionResponse
    filter alerts by alert context (payload)
    AlertRuleId ConditionResponse
    filter alerts by alert rule id
    AlertRuleName ConditionResponse
    filter alerts by alert rule name
    Description ConditionResponse
    filter alerts by alert rule description
    MonitorCondition ConditionResponse
    filter alerts by monitor condition
    MonitorService ConditionResponse
    filter alerts by monitor service
    Severity ConditionResponse
    filter alerts by severity
    TargetResourceType ConditionResponse
    filter alerts by target resource type
    alertContext ConditionResponse
    filter alerts by alert context (payload)
    alertRuleId ConditionResponse
    filter alerts by alert rule id
    alertRuleName ConditionResponse
    filter alerts by alert rule name
    description ConditionResponse
    filter alerts by alert rule description
    monitorCondition ConditionResponse
    filter alerts by monitor condition
    monitorService ConditionResponse
    filter alerts by monitor service
    severity ConditionResponse
    filter alerts by severity
    targetResourceType ConditionResponse
    filter alerts by target resource type
    alertContext ConditionResponse
    filter alerts by alert context (payload)
    alertRuleId ConditionResponse
    filter alerts by alert rule id
    alertRuleName ConditionResponse
    filter alerts by alert rule name
    description ConditionResponse
    filter alerts by alert rule description
    monitorCondition ConditionResponse
    filter alerts by monitor condition
    monitorService ConditionResponse
    filter alerts by monitor service
    severity ConditionResponse
    filter alerts by severity
    targetResourceType ConditionResponse
    filter alerts by target resource type
    alert_context ConditionResponse
    filter alerts by alert context (payload)
    alert_rule_id ConditionResponse
    filter alerts by alert rule id
    alert_rule_name ConditionResponse
    filter alerts by alert rule name
    description ConditionResponse
    filter alerts by alert rule description
    monitor_condition ConditionResponse
    filter alerts by monitor condition
    monitor_service ConditionResponse
    filter alerts by monitor service
    severity ConditionResponse
    filter alerts by severity
    target_resource_type ConditionResponse
    filter alerts by target resource type
    alertContext Property Map
    filter alerts by alert context (payload)
    alertRuleId Property Map
    filter alerts by alert rule id
    alertRuleName Property Map
    filter alerts by alert rule name
    description Property Map
    filter alerts by alert rule description
    monitorCondition Property Map
    filter alerts by monitor condition
    monitorService Property Map
    filter alerts by monitor service
    severity Property Map
    filter alerts by severity
    targetResourceType Property Map
    filter alerts by target resource type

    DiagnosticsResponse

    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    Conditions Pulumi.AzureNative.AlertsManagement.Inputs.ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope Pulumi.AzureNative.AlertsManagement.Inputs.ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    Conditions ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled
    createdAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy string
    Created by user name.
    lastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy string
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description string
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status string
    Indicates if the given action rule is enabled or disabled
    created_at str
    Creation time of action rule. Date-Time in ISO-8601 format.
    created_by str
    Created by user name.
    last_modified_at str
    Last updated time of action rule. Date-Time in ISO-8601 format.
    last_modified_by str
    Last modified by user name.
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description str
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status str
    Indicates if the given action rule is enabled or disabled
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    conditions Property Map
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope Property Map
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled

    ScopeResponse

    ScopeType string
    type of target scope
    Values List<string>
    list of ARM IDs of the given scope type which will be the target of the given action rule.
    ScopeType string
    type of target scope
    Values []string
    list of ARM IDs of the given scope type which will be the target of the given action rule.
    scopeType String
    type of target scope
    values List<String>
    list of ARM IDs of the given scope type which will be the target of the given action rule.
    scopeType string
    type of target scope
    values string[]
    list of ARM IDs of the given scope type which will be the target of the given action rule.
    scope_type str
    type of target scope
    values Sequence[str]
    list of ARM IDs of the given scope type which will be the target of the given action rule.
    scopeType String
    type of target scope
    values List<String>
    list of ARM IDs of the given scope type which will be the target of the given action rule.

    SuppressionConfigResponse

    RecurrenceType string
    Specifies when the suppression should be applied
    Schedule Pulumi.AzureNative.AlertsManagement.Inputs.SuppressionScheduleResponse
    suppression schedule configuration
    RecurrenceType string
    Specifies when the suppression should be applied
    Schedule SuppressionScheduleResponse
    suppression schedule configuration
    recurrenceType String
    Specifies when the suppression should be applied
    schedule SuppressionScheduleResponse
    suppression schedule configuration
    recurrenceType string
    Specifies when the suppression should be applied
    schedule SuppressionScheduleResponse
    suppression schedule configuration
    recurrence_type str
    Specifies when the suppression should be applied
    schedule SuppressionScheduleResponse
    suppression schedule configuration
    recurrenceType String
    Specifies when the suppression should be applied
    schedule Property Map
    suppression schedule configuration

    SuppressionResponse

    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    SuppressionConfig Pulumi.AzureNative.AlertsManagement.Inputs.SuppressionConfigResponse
    suppression configuration for the action rule
    Conditions Pulumi.AzureNative.AlertsManagement.Inputs.ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope Pulumi.AzureNative.AlertsManagement.Inputs.ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    CreatedAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    CreatedBy string
    Created by user name.
    LastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    LastModifiedBy string
    Last modified by user name.
    SuppressionConfig SuppressionConfigResponse
    suppression configuration for the action rule
    Conditions ConditionsResponse
    conditions on which alerts will be filtered
    Description string
    Description of action rule
    Scope ScopeResponse
    scope on which action rule will apply
    Status string
    Indicates if the given action rule is enabled or disabled
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    suppressionConfig SuppressionConfigResponse
    suppression configuration for the action rule
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled
    createdAt string
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy string
    Created by user name.
    lastModifiedAt string
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy string
    Last modified by user name.
    suppressionConfig SuppressionConfigResponse
    suppression configuration for the action rule
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description string
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status string
    Indicates if the given action rule is enabled or disabled
    created_at str
    Creation time of action rule. Date-Time in ISO-8601 format.
    created_by str
    Created by user name.
    last_modified_at str
    Last updated time of action rule. Date-Time in ISO-8601 format.
    last_modified_by str
    Last modified by user name.
    suppression_config SuppressionConfigResponse
    suppression configuration for the action rule
    conditions ConditionsResponse
    conditions on which alerts will be filtered
    description str
    Description of action rule
    scope ScopeResponse
    scope on which action rule will apply
    status str
    Indicates if the given action rule is enabled or disabled
    createdAt String
    Creation time of action rule. Date-Time in ISO-8601 format.
    createdBy String
    Created by user name.
    lastModifiedAt String
    Last updated time of action rule. Date-Time in ISO-8601 format.
    lastModifiedBy String
    Last modified by user name.
    suppressionConfig Property Map
    suppression configuration for the action rule
    conditions Property Map
    conditions on which alerts will be filtered
    description String
    Description of action rule
    scope Property Map
    scope on which action rule will apply
    status String
    Indicates if the given action rule is enabled or disabled

    SuppressionScheduleResponse

    EndDate string
    End date for suppression
    EndTime string
    End date for suppression
    RecurrenceValues List<int>
    Specifies the values for recurrence pattern
    StartDate string
    Start date for suppression
    StartTime string
    Start time for suppression
    EndDate string
    End date for suppression
    EndTime string
    End date for suppression
    RecurrenceValues []int
    Specifies the values for recurrence pattern
    StartDate string
    Start date for suppression
    StartTime string
    Start time for suppression
    endDate String
    End date for suppression
    endTime String
    End date for suppression
    recurrenceValues List<Integer>
    Specifies the values for recurrence pattern
    startDate String
    Start date for suppression
    startTime String
    Start time for suppression
    endDate string
    End date for suppression
    endTime string
    End date for suppression
    recurrenceValues number[]
    Specifies the values for recurrence pattern
    startDate string
    Start date for suppression
    startTime string
    Start time for suppression
    end_date str
    End date for suppression
    end_time str
    End date for suppression
    recurrence_values Sequence[int]
    Specifies the values for recurrence pattern
    start_date str
    Start date for suppression
    start_time str
    Start time for suppression
    endDate String
    End date for suppression
    endTime String
    End date for suppression
    recurrenceValues List<Number>
    Specifies the values for recurrence pattern
    startDate String
    Start date for suppression
    startTime String
    Start time for suppression

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi