Azure Native v1.102.0, May 2 23
Azure Native v1.102.0, May 2 23
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:
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- Rule
Id string Alert rule ID
- Workspace
Name string The name of the workspace.
- Resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- Rule
Id string Alert rule ID
- Workspace
Name string The name of the workspace.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
- rule
Id String Alert rule ID
- workspace
Name String The name of the workspace.
- resource
Group stringName The name of the resource group within the user's subscription. The name is case insensitive.
- rule
Id string Alert rule ID
- workspace
Name string The name of the workspace.
- resource_
group_ strname 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.
- resource
Group StringName The name of the resource group within the user's subscription. The name is case insensitive.
- rule
Id String Alert rule ID
- workspace
Name String The name of the workspace.
getScheduledAlertRule Result
The following output properties are available:
- Display
Name 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
- Last
Modified stringUtc 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.
- Query
Frequency string The frequency (in ISO 8601 duration format) for this alert rule to run.
- Query
Period 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.
- Suppression
Duration string 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 string The operation against the threshold that triggers alert rule.
- Trigger
Threshold int The threshold triggers this alert rule.
- Type string
Azure resource type
- Alert
Rule stringTemplate Name 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
- Display
Name 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
- Last
Modified stringUtc 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.
- Query
Frequency string The frequency (in ISO 8601 duration format) for this alert rule to run.
- Query
Period 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.
- Suppression
Duration string 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 string The operation against the threshold that triggers alert rule.
- Trigger
Threshold int The threshold triggers this alert rule.
- Type string
Azure resource type
- Alert
Rule stringTemplate Name 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 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
- last
Modified StringUtc 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.
- query
Frequency String The frequency (in ISO 8601 duration format) for this alert rule to run.
- query
Period 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.
- suppression
Duration String The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
- suppression
Enabled Boolean Determines whether the suppression for this alert rule is enabled or disabled.
- trigger
Operator String The operation against the threshold that triggers alert rule.
- trigger
Threshold Integer The threshold triggers this alert rule.
- type String
Azure resource type
- alert
Rule StringTemplate Name 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
- display
Name 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
- last
Modified stringUtc 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.
- query
Frequency string The frequency (in ISO 8601 duration format) for this alert rule to run.
- query
Period 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.
- suppression
Duration string The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
- suppression
Enabled boolean Determines whether the suppression for this alert rule is enabled or disabled.
- trigger
Operator string The operation against the threshold that triggers alert rule.
- trigger
Threshold number The threshold triggers this alert rule.
- type string
Azure resource type
- alert
Rule stringTemplate Name 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_ strutc 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_ strtemplate_ name 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
- display
Name 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
- last
Modified StringUtc 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.
- query
Frequency String The frequency (in ISO 8601 duration format) for this alert rule to run.
- query
Period 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.
- suppression
Duration String The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.
- suppression
Enabled Boolean Determines whether the suppression for this alert rule is enabled or disabled.
- trigger
Operator String The operation against the threshold that triggers alert rule.
- trigger
Threshold Number The threshold triggers this alert rule.
- type String
Azure resource type
- alert
Rule StringTemplate Name 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