azure-native.securityinsights.getScheduledAlertRule

Explore with Pulumi AI

Gets the alert rule. API Version: 2020-01-01.

Using getScheduledAlertRule

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 getScheduledAlertRule(args: GetScheduledAlertRuleArgs, opts?: InvokeOptions): Promise<GetScheduledAlertRuleResult>
function getScheduledAlertRuleOutput(args: GetScheduledAlertRuleOutputArgs, opts?: InvokeOptions): Output<GetScheduledAlertRuleResult>
def get_scheduled_alert_rule(resource_group_name: Optional[str] = None,
                             rule_id: Optional[str] = None,
                             workspace_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetScheduledAlertRuleResult
def get_scheduled_alert_rule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                             rule_id: Optional[pulumi.Input[str]] = None,
                             workspace_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetScheduledAlertRuleResult]
func LookupScheduledAlertRule(ctx *Context, args *LookupScheduledAlertRuleArgs, opts ...InvokeOption) (*LookupScheduledAlertRuleResult, error)
func LookupScheduledAlertRuleOutput(ctx *Context, args *LookupScheduledAlertRuleOutputArgs, opts ...InvokeOption) LookupScheduledAlertRuleResultOutput

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

public static class GetScheduledAlertRule 
{
    public static Task<GetScheduledAlertRuleResult> InvokeAsync(GetScheduledAlertRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledAlertRuleResult> Invoke(GetScheduledAlertRuleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetScheduledAlertRuleResult> getScheduledAlertRule(GetScheduledAlertRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure-native:securityinsights:getScheduledAlertRule
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

RuleId string

Alert rule ID

WorkspaceName string

The name of the workspace.

ResourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

RuleId string

Alert rule ID

WorkspaceName string

The name of the workspace.

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

ruleId String

Alert rule ID

workspaceName String

The name of the workspace.

resourceGroupName string

The name of the resource group within the user's subscription. The name is case insensitive.

ruleId string

Alert rule ID

workspaceName string

The name of the workspace.

resource_group_name str

The name of the resource group within the user's subscription. The name is case insensitive.

rule_id str

Alert rule ID

workspace_name str

The name of the workspace.

resourceGroupName String

The name of the resource group within the user's subscription. The name is case insensitive.

ruleId String

Alert rule ID

workspaceName String

The name of the workspace.

getScheduledAlertRule Result

The following output properties are available:

DisplayName string

The display name for alerts created by this alert rule.

Enabled bool

Determines whether this alert rule is enabled or disabled.

Id string

Azure resource Id

LastModifiedUtc string

The last time that this alert rule has been modified.

Name string

Azure resource name

Query string

The query that creates alerts for this rule.

QueryFrequency string

The frequency (in ISO 8601 duration format) for this alert rule to run.

QueryPeriod string

The period (in ISO 8601 duration format) that this alert rule looks at.

Severity string

The severity for alerts created by this alert rule.

SuppressionDuration string

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

SuppressionEnabled bool

Determines whether the suppression for this alert rule is enabled or disabled.

TriggerOperator string

The operation against the threshold that triggers alert rule.

TriggerThreshold int

The threshold triggers this alert rule.

Type string

Azure resource type

AlertRuleTemplateName string

The Name of the alert rule template used to create this rule.

Description string

The description of the alert rule.

Etag string

Etag of the azure resource

Tactics List<string>

The tactics of the alert rule

DisplayName string

The display name for alerts created by this alert rule.

Enabled bool

Determines whether this alert rule is enabled or disabled.

Id string

Azure resource Id

LastModifiedUtc string

The last time that this alert rule has been modified.

Name string

Azure resource name

Query string

The query that creates alerts for this rule.

QueryFrequency string

The frequency (in ISO 8601 duration format) for this alert rule to run.

QueryPeriod string

The period (in ISO 8601 duration format) that this alert rule looks at.

Severity string

The severity for alerts created by this alert rule.

SuppressionDuration string

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

SuppressionEnabled bool

Determines whether the suppression for this alert rule is enabled or disabled.

TriggerOperator string

The operation against the threshold that triggers alert rule.

TriggerThreshold int

The threshold triggers this alert rule.

Type string

Azure resource type

AlertRuleTemplateName string

The Name of the alert rule template used to create this rule.

Description string

The description of the alert rule.

Etag string

Etag of the azure resource

Tactics []string

The tactics of the alert rule

displayName String

The display name for alerts created by this alert rule.

enabled Boolean

Determines whether this alert rule is enabled or disabled.

id String

Azure resource Id

lastModifiedUtc String

The last time that this alert rule has been modified.

name String

Azure resource name

query String

The query that creates alerts for this rule.

queryFrequency String

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryPeriod String

The period (in ISO 8601 duration format) that this alert rule looks at.

severity String

The severity for alerts created by this alert rule.

suppressionDuration String

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppressionEnabled Boolean

Determines whether the suppression for this alert rule is enabled or disabled.

triggerOperator String

The operation against the threshold that triggers alert rule.

triggerThreshold Integer

The threshold triggers this alert rule.

type String

Azure resource type

alertRuleTemplateName String

The Name of the alert rule template used to create this rule.

description String

The description of the alert rule.

etag String

Etag of the azure resource

tactics List<String>

The tactics of the alert rule

displayName string

The display name for alerts created by this alert rule.

enabled boolean

Determines whether this alert rule is enabled or disabled.

id string

Azure resource Id

lastModifiedUtc string

The last time that this alert rule has been modified.

name string

Azure resource name

query string

The query that creates alerts for this rule.

queryFrequency string

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryPeriod string

The period (in ISO 8601 duration format) that this alert rule looks at.

severity string

The severity for alerts created by this alert rule.

suppressionDuration string

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppressionEnabled boolean

Determines whether the suppression for this alert rule is enabled or disabled.

triggerOperator string

The operation against the threshold that triggers alert rule.

triggerThreshold number

The threshold triggers this alert rule.

type string

Azure resource type

alertRuleTemplateName string

The Name of the alert rule template used to create this rule.

description string

The description of the alert rule.

etag string

Etag of the azure resource

tactics string[]

The tactics of the alert rule

display_name str

The display name for alerts created by this alert rule.

enabled bool

Determines whether this alert rule is enabled or disabled.

id str

Azure resource Id

last_modified_utc str

The last time that this alert rule has been modified.

name str

Azure resource name

query str

The query that creates alerts for this rule.

query_frequency str

The frequency (in ISO 8601 duration format) for this alert rule to run.

query_period str

The period (in ISO 8601 duration format) that this alert rule looks at.

severity str

The severity for alerts created by this alert rule.

suppression_duration str

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppression_enabled bool

Determines whether the suppression for this alert rule is enabled or disabled.

trigger_operator str

The operation against the threshold that triggers alert rule.

trigger_threshold int

The threshold triggers this alert rule.

type str

Azure resource type

alert_rule_template_name str

The Name of the alert rule template used to create this rule.

description str

The description of the alert rule.

etag str

Etag of the azure resource

tactics Sequence[str]

The tactics of the alert rule

displayName String

The display name for alerts created by this alert rule.

enabled Boolean

Determines whether this alert rule is enabled or disabled.

id String

Azure resource Id

lastModifiedUtc String

The last time that this alert rule has been modified.

name String

Azure resource name

query String

The query that creates alerts for this rule.

queryFrequency String

The frequency (in ISO 8601 duration format) for this alert rule to run.

queryPeriod String

The period (in ISO 8601 duration format) that this alert rule looks at.

severity String

The severity for alerts created by this alert rule.

suppressionDuration String

The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.

suppressionEnabled Boolean

Determines whether the suppression for this alert rule is enabled or disabled.

triggerOperator String

The operation against the threshold that triggers alert rule.

triggerThreshold Number

The threshold triggers this alert rule.

type String

Azure resource type

alertRuleTemplateName String

The Name of the alert rule template used to create this rule.

description String

The description of the alert rule.

etag String

Etag of the azure resource

tactics List<String>

The tactics of the alert rule

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0