Azure Native v2.63.0, Sep 24 24

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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getScheduledQueryRule

Explore with Pulumi AI

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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getScheduledQueryRule

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 getScheduledQueryRule(args: GetScheduledQueryRuleArgs, opts?: InvokeOptions): Promise<GetScheduledQueryRuleResult>
function getScheduledQueryRuleOutput(args: GetScheduledQueryRuleOutputArgs, opts?: InvokeOptions): Output<GetScheduledQueryRuleResult>

def get_scheduled_query_rule(resource_group_name: Optional[str] = None,
                             rule_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetScheduledQueryRuleResult
def get_scheduled_query_rule_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                             rule_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetScheduledQueryRuleResult]

func LookupScheduledQueryRule(ctx *Context, args *LookupScheduledQueryRuleArgs, opts ...InvokeOption) (*LookupScheduledQueryRuleResult, error)
func LookupScheduledQueryRuleOutput(ctx *Context, args *LookupScheduledQueryRuleOutputArgs, opts ...InvokeOption) LookupScheduledQueryRuleResultOutput

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

public static class GetScheduledQueryRule 
{
    public static Task<GetScheduledQueryRuleResult> InvokeAsync(GetScheduledQueryRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduledQueryRuleResult> Invoke(GetScheduledQueryRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetScheduledQueryRuleResult> getScheduledQueryRule(GetScheduledQueryRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:insights:getScheduledQueryRule
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
RuleName string: The name of the rule.

ResourceGroupName string: The name of the resource group. The name is case insensitive.
RuleName string: The name of the rule.

resourceGroupName String: The name of the resource group. The name is case insensitive.
ruleName String: The name of the rule.

resourceGroupName string: The name of the resource group. The name is case insensitive.
ruleName string: The name of the rule.

resource_group_name str: The name of the resource group. The name is case insensitive.
rule_name str: The name of the rule.

resourceGroupName String: The name of the resource group. The name is case insensitive.
ruleName String: The name of the rule.

getScheduledQueryRule Result

The following output properties are available:

CreatedWithApiVersion string: The api-version used when creating this alert rule
Criteria Pulumi.AzureNative.Insights.Outputs.ScheduledQueryRuleCriteriaResponse: The rule criteria that defines the conditions of the scheduled query rule.
Enabled bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
Etag string: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IsLegacyLogAnalyticsRule bool: True if alert rule is legacy Log Analytic rule
IsWorkspaceAlertsStorageConfigured bool: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
Location string: The geo-location where the resource lives
Name string: The name of the resource
Scopes List<string>: The list of resource id's that this scheduled query rule is scoped to.
SystemData Pulumi.AzureNative.Insights.Outputs.SystemDataResponse: SystemData of ScheduledQueryRule.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Actions Pulumi.AzureNative.Insights.Outputs.ActionsResponse: Actions to invoke when the alert fires.
AutoMitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
CheckWorkspaceAlertsStorageConfigured bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
Description string: The description of the scheduled query rule.
DisplayName string: The display name of the alert rule
EvaluationFrequency string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
Identity Pulumi.AzureNative.Insights.Outputs.IdentityResponse: The identity of the resource.
Kind string: Indicates the type of scheduled query rule. The default is LogAlert.
MuteActionsDuration string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
OverrideQueryTimeRange string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
ResolveConfiguration Pulumi.AzureNative.Insights.Outputs.RuleResolveConfigurationResponse: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
Severity double: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
SkipQueryValidation bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
Tags Dictionary<string, string>: Resource tags.
TargetResourceTypes List<string>: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
WindowSize string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

CreatedWithApiVersion string: The api-version used when creating this alert rule
Criteria ScheduledQueryRuleCriteriaResponse: The rule criteria that defines the conditions of the scheduled query rule.
Enabled bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
Etag string: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
IsLegacyLogAnalyticsRule bool: True if alert rule is legacy Log Analytic rule
IsWorkspaceAlertsStorageConfigured bool: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
Location string: The geo-location where the resource lives
Name string: The name of the resource
Scopes []string: The list of resource id's that this scheduled query rule is scoped to.
SystemData SystemDataResponse: SystemData of ScheduledQueryRule.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Actions ActionsResponse: Actions to invoke when the alert fires.
AutoMitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
CheckWorkspaceAlertsStorageConfigured bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
Description string: The description of the scheduled query rule.
DisplayName string: The display name of the alert rule
EvaluationFrequency string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
Identity IdentityResponse: The identity of the resource.
Kind string: Indicates the type of scheduled query rule. The default is LogAlert.
MuteActionsDuration string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
OverrideQueryTimeRange string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
ResolveConfiguration RuleResolveConfigurationResponse: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
Severity float64: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
SkipQueryValidation bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
Tags map[string]string: Resource tags.
TargetResourceTypes []string: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
WindowSize string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

createdWithApiVersion String: The api-version used when creating this alert rule
criteria ScheduledQueryRuleCriteriaResponse: The rule criteria that defines the conditions of the scheduled query rule.
enabled Boolean: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
etag String: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isLegacyLogAnalyticsRule Boolean: True if alert rule is legacy Log Analytic rule
isWorkspaceAlertsStorageConfigured Boolean: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
location String: The geo-location where the resource lives
name String: The name of the resource
scopes List<String>: The list of resource id's that this scheduled query rule is scoped to.
systemData SystemDataResponse: SystemData of ScheduledQueryRule.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actions ActionsResponse: Actions to invoke when the alert fires.
autoMitigate Boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
checkWorkspaceAlertsStorageConfigured Boolean: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
description String: The description of the scheduled query rule.
displayName String: The display name of the alert rule
evaluationFrequency String: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
identity IdentityResponse: The identity of the resource.
kind String: Indicates the type of scheduled query rule. The default is LogAlert.
muteActionsDuration String: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
overrideQueryTimeRange String: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
resolveConfiguration RuleResolveConfigurationResponse: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
severity Double: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
skipQueryValidation Boolean: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
tags Map<String,String>: Resource tags.
targetResourceTypes List<String>: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
windowSize String: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

createdWithApiVersion string: The api-version used when creating this alert rule
criteria ScheduledQueryRuleCriteriaResponse: The rule criteria that defines the conditions of the scheduled query rule.
enabled boolean: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
etag string: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isLegacyLogAnalyticsRule boolean: True if alert rule is legacy Log Analytic rule
isWorkspaceAlertsStorageConfigured boolean: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
location string: The geo-location where the resource lives
name string: The name of the resource
scopes string[]: The list of resource id's that this scheduled query rule is scoped to.
systemData SystemDataResponse: SystemData of ScheduledQueryRule.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actions ActionsResponse: Actions to invoke when the alert fires.
autoMitigate boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
checkWorkspaceAlertsStorageConfigured boolean: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
description string: The description of the scheduled query rule.
displayName string: The display name of the alert rule
evaluationFrequency string: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
identity IdentityResponse: The identity of the resource.
kind string: Indicates the type of scheduled query rule. The default is LogAlert.
muteActionsDuration string: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
overrideQueryTimeRange string: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
resolveConfiguration RuleResolveConfigurationResponse: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
severity number: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
skipQueryValidation boolean: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
tags {[key: string]: string}: Resource tags.
targetResourceTypes string[]: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
windowSize string: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

created_with_api_version str: The api-version used when creating this alert rule
criteria ScheduledQueryRuleCriteriaResponse: The rule criteria that defines the conditions of the scheduled query rule.
enabled bool: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
etag str: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
is_legacy_log_analytics_rule bool: True if alert rule is legacy Log Analytic rule
is_workspace_alerts_storage_configured bool: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
location str: The geo-location where the resource lives
name str: The name of the resource
scopes Sequence[str]: The list of resource id's that this scheduled query rule is scoped to.
system_data SystemDataResponse: SystemData of ScheduledQueryRule.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actions ActionsResponse: Actions to invoke when the alert fires.
auto_mitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
check_workspace_alerts_storage_configured bool: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
description str: The description of the scheduled query rule.
display_name str: The display name of the alert rule
evaluation_frequency str: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
identity IdentityResponse: The identity of the resource.
kind str: Indicates the type of scheduled query rule. The default is LogAlert.
mute_actions_duration str: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
override_query_time_range str: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
resolve_configuration RuleResolveConfigurationResponse: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
severity float: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
skip_query_validation bool: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
tags Mapping[str, str]: Resource tags.
target_resource_types Sequence[str]: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
window_size str: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

createdWithApiVersion String: The api-version used when creating this alert rule
criteria Property Map: The rule criteria that defines the conditions of the scheduled query rule.
enabled Boolean: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false
etag String: The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
isLegacyLogAnalyticsRule Boolean: True if alert rule is legacy Log Analytic rule
isWorkspaceAlertsStorageConfigured Boolean: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false.
location String: The geo-location where the resource lives
name String: The name of the resource
scopes List<String>: The list of resource id's that this scheduled query rule is scoped to.
systemData Property Map: SystemData of ScheduledQueryRule.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
actions Property Map: Actions to invoke when the alert fires.
autoMitigate Boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert.
checkWorkspaceAlertsStorageConfigured Boolean: The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert.
description String: The description of the scheduled query rule.
displayName String: The display name of the alert rule
evaluationFrequency String: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.
identity Property Map: The identity of the resource.
kind String: Indicates the type of scheduled query rule. The default is LogAlert.
muteActionsDuration String: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert.
overrideQueryTimeRange String: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.
resolveConfiguration Property Map: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert.
severity Number: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.
skipQueryValidation Boolean: The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert.
tags Map<String>: Resource tags.
targetResourceTypes List<String>: List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert
windowSize String: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert.

Supporting Types

ActionsResponse

ActionGroups List<string>: Action Group resource Ids to invoke when the alert fires.
ActionProperties Dictionary<string, string>: The properties of an action properties.
CustomProperties Dictionary<string, string>: The properties of an alert payload.

ActionGroups []string: Action Group resource Ids to invoke when the alert fires.
ActionProperties map[string]string: The properties of an action properties.
CustomProperties map[string]string: The properties of an alert payload.

actionGroups List<String>: Action Group resource Ids to invoke when the alert fires.
actionProperties Map<String,String>: The properties of an action properties.
customProperties Map<String,String>: The properties of an alert payload.

actionGroups string[]: Action Group resource Ids to invoke when the alert fires.
actionProperties {[key: string]: string}: The properties of an action properties.
customProperties {[key: string]: string}: The properties of an alert payload.

action_groups Sequence[str]: Action Group resource Ids to invoke when the alert fires.
action_properties Mapping[str, str]: The properties of an action properties.
custom_properties Mapping[str, str]: The properties of an alert payload.

actionGroups List<String>: Action Group resource Ids to invoke when the alert fires.
actionProperties Map<String>: The properties of an action properties.
customProperties Map<String>: The properties of an alert payload.

ConditionResponse

Dimensions List<Pulumi.AzureNative.Insights.Inputs.DimensionResponse>: List of Dimensions conditions
FailingPeriods Pulumi.AzureNative.Insights.Inputs.ConditionResponseFailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
MetricMeasureColumn string: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
MetricName string: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
Operator string: The criteria operator. Relevant and required only for rules of the kind LogAlert.
Query string: Log query alert
ResourceIdColumn string: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
Threshold double: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
TimeAggregation string: Aggregation type. Relevant and required only for rules of the kind LogAlert.

Dimensions []DimensionResponse: List of Dimensions conditions
FailingPeriods ConditionResponseFailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
MetricMeasureColumn string: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
MetricName string: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
Operator string: The criteria operator. Relevant and required only for rules of the kind LogAlert.
Query string: Log query alert
ResourceIdColumn string: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
Threshold float64: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
TimeAggregation string: Aggregation type. Relevant and required only for rules of the kind LogAlert.

dimensions List<DimensionResponse>: List of Dimensions conditions
failingPeriods ConditionResponseFailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
metricMeasureColumn String: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
metricName String: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
operator String: The criteria operator. Relevant and required only for rules of the kind LogAlert.
query String: Log query alert
resourceIdColumn String: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
threshold Double: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
timeAggregation String: Aggregation type. Relevant and required only for rules of the kind LogAlert.

dimensions DimensionResponse[]: List of Dimensions conditions
failingPeriods ConditionResponseFailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
metricMeasureColumn string: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
metricName string: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
operator string: The criteria operator. Relevant and required only for rules of the kind LogAlert.
query string: Log query alert
resourceIdColumn string: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
threshold number: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
timeAggregation string: Aggregation type. Relevant and required only for rules of the kind LogAlert.

dimensions Sequence[DimensionResponse]: List of Dimensions conditions
failing_periods ConditionResponseFailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
metric_measure_column str: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
metric_name str: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
operator str: The criteria operator. Relevant and required only for rules of the kind LogAlert.
query str: Log query alert
resource_id_column str: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
threshold float: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
time_aggregation str: Aggregation type. Relevant and required only for rules of the kind LogAlert.

dimensions List<Property Map>: List of Dimensions conditions
failingPeriods Property Map: The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.
metricMeasureColumn String: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.
metricName String: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.
operator String: The criteria operator. Relevant and required only for rules of the kind LogAlert.
query String: Log query alert
resourceIdColumn String: The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert.
threshold Number: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.
timeAggregation String: Aggregation type. Relevant and required only for rules of the kind LogAlert.

ConditionResponseFailingPeriods

MinFailingPeriodsToAlert double: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
NumberOfEvaluationPeriods double: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

MinFailingPeriodsToAlert float64: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
NumberOfEvaluationPeriods float64: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

minFailingPeriodsToAlert Double: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
numberOfEvaluationPeriods Double: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

minFailingPeriodsToAlert number: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
numberOfEvaluationPeriods number: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

min_failing_periods_to_alert float: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
number_of_evaluation_periods float: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

minFailingPeriodsToAlert Number: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1
numberOfEvaluationPeriods Number: The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1

DimensionResponse

Name string: Name of the dimension
Operator string: Operator for dimension values
Values List<string>: List of dimension values

Name string: Name of the dimension
Operator string: Operator for dimension values
Values []string: List of dimension values

name String: Name of the dimension
operator String: Operator for dimension values
values List<String>: List of dimension values

name string: Name of the dimension
operator string: Operator for dimension values
values string[]: List of dimension values

name str: Name of the dimension
operator str: Operator for dimension values
values Sequence[str]: List of dimension values

name String: Name of the dimension
operator String: Operator for dimension values
values List<String>: List of dimension values

IdentityResponse

PrincipalId string: The principal ID of resource identity.
TenantId string: The tenant ID of resource.
Type string: Type of managed service identity.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Insights.Inputs.UserIdentityPropertiesResponse>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

PrincipalId string: The principal ID of resource identity.
TenantId string: The tenant ID of resource.
Type string: Type of managed service identity.
UserAssignedIdentities map[string]UserIdentityPropertiesResponse: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String: The principal ID of resource identity.
tenantId String: The tenant ID of resource.
type String: Type of managed service identity.
userAssignedIdentities Map<String,UserIdentityPropertiesResponse>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId string: The principal ID of resource identity.
tenantId string: The tenant ID of resource.
type string: Type of managed service identity.
userAssignedIdentities {[key: string]: UserIdentityPropertiesResponse}: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principal_id str: The principal ID of resource identity.
tenant_id str: The tenant ID of resource.
type str: Type of managed service identity.
user_assigned_identities Mapping[str, UserIdentityPropertiesResponse]: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

principalId String: The principal ID of resource identity.
tenantId String: The tenant ID of resource.
type String: Type of managed service identity.
userAssignedIdentities Map<Property Map>: The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

RuleResolveConfigurationResponse

AutoResolved bool: The flag that indicates whether or not to auto resolve a fired alert.
TimeToResolve string: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

AutoResolved bool: The flag that indicates whether or not to auto resolve a fired alert.
TimeToResolve string: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

autoResolved Boolean: The flag that indicates whether or not to auto resolve a fired alert.
timeToResolve String: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

autoResolved boolean: The flag that indicates whether or not to auto resolve a fired alert.
timeToResolve string: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

auto_resolved bool: The flag that indicates whether or not to auto resolve a fired alert.
time_to_resolve str: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

autoResolved Boolean: The flag that indicates whether or not to auto resolve a fired alert.
timeToResolve String: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format.

ScheduledQueryRuleCriteriaResponse

AllOf List<Pulumi.AzureNative.Insights.Inputs.ConditionResponse>: A list of conditions to evaluate against the specified scopes

AllOf []ConditionResponse: A list of conditions to evaluate against the specified scopes

allOf List<ConditionResponse>: A list of conditions to evaluate against the specified scopes

allOf ConditionResponse[]: A list of conditions to evaluate against the specified scopes

all_of Sequence[ConditionResponse]: A list of conditions to evaluate against the specified scopes

allOf List<Property Map>: A list of conditions to evaluate against the specified scopes

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.

UserIdentityPropertiesResponse

ClientId string: The client id of user assigned identity.
PrincipalId string: The principal id of user assigned identity.

ClientId string: The client id of user assigned identity.
PrincipalId string: The principal id of user assigned identity.

clientId String: The client id of user assigned identity.
principalId String: The principal id of user assigned identity.

clientId string: The client id of user assigned identity.
principalId string: The principal id of user assigned identity.

client_id str: The client id of user assigned identity.
principal_id str: The principal id of user assigned identity.

clientId String: The client id of user assigned identity.
principalId String: The principal id of user assigned identity.

Package Details

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

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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getScheduledQueryRule

On this page

On this page

Using getScheduledQueryRule

getScheduledQueryRule Result

Supporting Types

ActionsResponse

ConditionResponse

ConditionResponseFailingPeriods

DimensionResponse

IdentityResponse

RuleResolveConfigurationResponse

ScheduledQueryRuleCriteriaResponse

SystemDataResponse

UserIdentityPropertiesResponse

Package Details

On this page

On this page