Azure Native v1 v1.104.0, Jul 6 23

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getScheduledQueryRule

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 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:

Action Pulumi.AzureNative.Insights.Outputs.AlertingActionResponse | Pulumi.AzureNative.Insights.Outputs.LogToMetricActionResponse: Action needs to be taken on rule execution.
CreatedWithApiVersion string: The api-version used when creating this alert rule
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: Azure resource Id
IsLegacyLogAnalyticsRule bool: True if alert rule is legacy Log Analytic rule
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
LastUpdatedTime string: Last time the rule was updated in IS08601 format.
Location string: Resource location
Name string: Azure resource name
ProvisioningState string: Provisioning state of the scheduled query rule
Source Pulumi.AzureNative.Insights.Outputs.SourceResponse: Data Source against which rule will Query Data
Type string: Azure resource type
AutoMitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
Description string: The description of the Log Search rule.
DisplayName string: The display name of the alert rule
Enabled string: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
Schedule Pulumi.AzureNative.Insights.Outputs.ScheduleResponse: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
Tags Dictionary<string, string>: Resource tags

Action AlertingActionResponse | LogToMetricActionResponse: Action needs to be taken on rule execution.
CreatedWithApiVersion string: The api-version used when creating this alert rule
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: Azure resource Id
IsLegacyLogAnalyticsRule bool: True if alert rule is legacy Log Analytic rule
Kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
LastUpdatedTime string: Last time the rule was updated in IS08601 format.
Location string: Resource location
Name string: Azure resource name
ProvisioningState string: Provisioning state of the scheduled query rule
Source SourceResponse: Data Source against which rule will Query Data
Type string: Azure resource type
AutoMitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
Description string: The description of the Log Search rule.
DisplayName string: The display name of the alert rule
Enabled string: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
Schedule ScheduleResponse: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
Tags map[string]string: Resource tags

action AlertingActionResponse | LogToMetricActionResponse: Action needs to be taken on rule execution.
createdWithApiVersion String: The api-version used when creating this alert rule
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: Azure resource Id
isLegacyLogAnalyticsRule Boolean: True if alert rule is legacy Log Analytic rule
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
lastUpdatedTime String: Last time the rule was updated in IS08601 format.
location String: Resource location
name String: Azure resource name
provisioningState String: Provisioning state of the scheduled query rule
source SourceResponse: Data Source against which rule will Query Data
type String: Azure resource type
autoMitigate Boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
description String: The description of the Log Search rule.
displayName String: The display name of the alert rule
enabled String: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
schedule ScheduleResponse: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
tags Map<String,String>: Resource tags

action AlertingActionResponse | LogToMetricActionResponse: Action needs to be taken on rule execution.
createdWithApiVersion string: The api-version used when creating this alert rule
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: Azure resource Id
isLegacyLogAnalyticsRule boolean: True if alert rule is legacy Log Analytic rule
kind string: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
lastUpdatedTime string: Last time the rule was updated in IS08601 format.
location string: Resource location
name string: Azure resource name
provisioningState string: Provisioning state of the scheduled query rule
source SourceResponse: Data Source against which rule will Query Data
type string: Azure resource type
autoMitigate boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
description string: The description of the Log Search rule.
displayName string: The display name of the alert rule
enabled string: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
schedule ScheduleResponse: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
tags {[key: string]: string}: Resource tags

action AlertingActionResponse | LogToMetricActionResponse: Action needs to be taken on rule execution.
created_with_api_version str: The api-version used when creating this alert rule
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: Azure resource Id
is_legacy_log_analytics_rule bool: True if alert rule is legacy Log Analytic rule
kind str: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
last_updated_time str: Last time the rule was updated in IS08601 format.
location str: Resource location
name str: Azure resource name
provisioning_state str: Provisioning state of the scheduled query rule
source SourceResponse: Data Source against which rule will Query Data
type str: Azure resource type
auto_mitigate bool: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
description str: The description of the Log Search rule.
display_name str: The display name of the alert rule
enabled str: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
schedule ScheduleResponse: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
tags Mapping[str, str]: Resource tags

action Property Map | Property Map: Action needs to be taken on rule execution.
createdWithApiVersion String: The api-version used when creating this alert rule
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: Azure resource Id
isLegacyLogAnalyticsRule Boolean: True if alert rule is legacy Log Analytic rule
kind String: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
lastUpdatedTime String: Last time the rule was updated in IS08601 format.
location String: Resource location
name String: Azure resource name
provisioningState String: Provisioning state of the scheduled query rule
source Property Map: Data Source against which rule will Query Data
type String: Azure resource type
autoMitigate Boolean: The flag that indicates whether the alert should be automatically resolved or not. The default is false.
description String: The description of the Log Search rule.
displayName String: The display name of the alert rule
enabled String: The flag which indicates whether the Log Search rule is enabled. Value should be true or false
schedule Property Map: Schedule (Frequency, Time Window) for rule. Required for action type - AlertingAction
tags Map<String>: Resource tags

Supporting Types

AlertingActionResponse

Severity string: Severity of the alert
Trigger Pulumi.AzureNative.Insights.Inputs.TriggerConditionResponse: The trigger condition that results in the alert rule being.
AznsAction Pulumi.AzureNative.Insights.Inputs.AzNsActionGroupResponse: Azure action group reference.
ThrottlingInMin int: time (in minutes) for which Alerts should be throttled or suppressed.

Severity string: Severity of the alert
Trigger TriggerConditionResponse: The trigger condition that results in the alert rule being.
AznsAction AzNsActionGroupResponse: Azure action group reference.
ThrottlingInMin int: time (in minutes) for which Alerts should be throttled or suppressed.

severity String: Severity of the alert
trigger TriggerConditionResponse: The trigger condition that results in the alert rule being.
aznsAction AzNsActionGroupResponse: Azure action group reference.
throttlingInMin Integer: time (in minutes) for which Alerts should be throttled or suppressed.

severity string: Severity of the alert
trigger TriggerConditionResponse: The trigger condition that results in the alert rule being.
aznsAction AzNsActionGroupResponse: Azure action group reference.
throttlingInMin number: time (in minutes) for which Alerts should be throttled or suppressed.

severity str: Severity of the alert
trigger TriggerConditionResponse: The trigger condition that results in the alert rule being.
azns_action AzNsActionGroupResponse: Azure action group reference.
throttling_in_min int: time (in minutes) for which Alerts should be throttled or suppressed.

severity String: Severity of the alert
trigger Property Map: The trigger condition that results in the alert rule being.
aznsAction Property Map: Azure action group reference.
throttlingInMin Number: time (in minutes) for which Alerts should be throttled or suppressed.

AzNsActionGroupResponse

ActionGroup List<string>: Azure Action Group reference.
CustomWebhookPayload string: Custom payload to be sent for all webhook URI in Azure action group
EmailSubject string: Custom subject override for all email ids in Azure action group

ActionGroup []string: Azure Action Group reference.
CustomWebhookPayload string: Custom payload to be sent for all webhook URI in Azure action group
EmailSubject string: Custom subject override for all email ids in Azure action group

actionGroup List<String>: Azure Action Group reference.
customWebhookPayload String: Custom payload to be sent for all webhook URI in Azure action group
emailSubject String: Custom subject override for all email ids in Azure action group

actionGroup string[]: Azure Action Group reference.
customWebhookPayload string: Custom payload to be sent for all webhook URI in Azure action group
emailSubject string: Custom subject override for all email ids in Azure action group

action_group Sequence[str]: Azure Action Group reference.
custom_webhook_payload str: Custom payload to be sent for all webhook URI in Azure action group
email_subject str: Custom subject override for all email ids in Azure action group

actionGroup List<String>: Azure Action Group reference.
customWebhookPayload String: Custom payload to be sent for all webhook URI in Azure action group
emailSubject String: Custom subject override for all email ids in Azure action group

CriteriaResponse

MetricName string: Name of the metric
Dimensions List<Pulumi.AzureNative.Insights.Inputs.DimensionResponse>: List of Dimensions for creating metric

MetricName string: Name of the metric
Dimensions []DimensionResponse: List of Dimensions for creating metric

metricName String: Name of the metric
dimensions List<DimensionResponse>: List of Dimensions for creating metric

metricName string: Name of the metric
dimensions DimensionResponse[]: List of Dimensions for creating metric

metric_name str: Name of the metric
dimensions Sequence[DimensionResponse]: List of Dimensions for creating metric

metricName String: Name of the metric
dimensions List<Property Map>: List of Dimensions for creating metric

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

LogMetricTriggerResponse

MetricColumn string: Evaluation of metric on a particular column
MetricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'
Threshold double: The threshold of the metric trigger.
ThresholdOperator string: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

MetricColumn string: Evaluation of metric on a particular column
MetricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'
Threshold float64: The threshold of the metric trigger.
ThresholdOperator string: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

metricColumn String: Evaluation of metric on a particular column
metricTriggerType String: Metric Trigger Type - 'Consecutive' or 'Total'
threshold Double: The threshold of the metric trigger.
thresholdOperator String: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

metricColumn string: Evaluation of metric on a particular column
metricTriggerType string: Metric Trigger Type - 'Consecutive' or 'Total'
threshold number: The threshold of the metric trigger.
thresholdOperator string: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

metric_column str: Evaluation of metric on a particular column
metric_trigger_type str: Metric Trigger Type - 'Consecutive' or 'Total'
threshold float: The threshold of the metric trigger.
threshold_operator str: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

metricColumn String: Evaluation of metric on a particular column
metricTriggerType String: Metric Trigger Type - 'Consecutive' or 'Total'
threshold Number: The threshold of the metric trigger.
thresholdOperator String: Evaluation operation for Metric -'GreaterThan' or 'LessThan' or 'Equal'.

LogToMetricActionResponse

Criteria List<Pulumi.AzureNative.Insights.Inputs.CriteriaResponse>: Criteria of Metric

Criteria []CriteriaResponse: Criteria of Metric

criteria List<CriteriaResponse>: Criteria of Metric

criteria CriteriaResponse[]: Criteria of Metric

criteria Sequence[CriteriaResponse]: Criteria of Metric

criteria List<Property Map>: Criteria of Metric

ScheduleResponse

FrequencyInMinutes int: frequency (in minutes) at which rule condition should be evaluated.
TimeWindowInMinutes int: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

FrequencyInMinutes int: frequency (in minutes) at which rule condition should be evaluated.
TimeWindowInMinutes int: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

frequencyInMinutes Integer: frequency (in minutes) at which rule condition should be evaluated.
timeWindowInMinutes Integer: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

frequencyInMinutes number: frequency (in minutes) at which rule condition should be evaluated.
timeWindowInMinutes number: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

frequency_in_minutes int: frequency (in minutes) at which rule condition should be evaluated.
time_window_in_minutes int: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

frequencyInMinutes Number: frequency (in minutes) at which rule condition should be evaluated.
timeWindowInMinutes Number: Time window for which data needs to be fetched for query (should be greater than or equal to frequencyInMinutes).

SourceResponse

DataSourceId string: The resource uri over which log search query is to be run.
AuthorizedResources List<string>: List of Resource referred into query
Query string: Log search query. Required for action type - AlertingAction
QueryType string: Set value to 'ResultCount' .

DataSourceId string: The resource uri over which log search query is to be run.
AuthorizedResources []string: List of Resource referred into query
Query string: Log search query. Required for action type - AlertingAction
QueryType string: Set value to 'ResultCount' .

dataSourceId String: The resource uri over which log search query is to be run.
authorizedResources List<String>: List of Resource referred into query
query String: Log search query. Required for action type - AlertingAction
queryType String: Set value to 'ResultCount' .

dataSourceId string: The resource uri over which log search query is to be run.
authorizedResources string[]: List of Resource referred into query
query string: Log search query. Required for action type - AlertingAction
queryType string: Set value to 'ResultCount' .

data_source_id str: The resource uri over which log search query is to be run.
authorized_resources Sequence[str]: List of Resource referred into query
query str: Log search query. Required for action type - AlertingAction
query_type str: Set value to 'ResultCount' .

dataSourceId String: The resource uri over which log search query is to be run.
authorizedResources List<String>: List of Resource referred into query
query String: Log search query. Required for action type - AlertingAction
queryType String: Set value to 'ResultCount' .

TriggerConditionResponse

Threshold double: Result or count threshold based on which rule should be triggered.
ThresholdOperator string: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
MetricTrigger Pulumi.AzureNative.Insights.Inputs.LogMetricTriggerResponse: Trigger condition for metric query rule

Threshold float64: Result or count threshold based on which rule should be triggered.
ThresholdOperator string: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
MetricTrigger LogMetricTriggerResponse: Trigger condition for metric query rule

threshold Double: Result or count threshold based on which rule should be triggered.
thresholdOperator String: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
metricTrigger LogMetricTriggerResponse: Trigger condition for metric query rule

threshold number: Result or count threshold based on which rule should be triggered.
thresholdOperator string: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
metricTrigger LogMetricTriggerResponse: Trigger condition for metric query rule

threshold float: Result or count threshold based on which rule should be triggered.
threshold_operator str: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
metric_trigger LogMetricTriggerResponse: Trigger condition for metric query rule

threshold Number: Result or count threshold based on which rule should be triggered.
thresholdOperator String: Evaluation operation for rule - 'GreaterThan' or 'LessThan.
metricTrigger Property Map: Trigger condition for metric query rule

Package Details

Repository: azure-native-v1 pulumi/pulumi-azure-native
License: Apache-2.0

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.

Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.insights.getScheduledQueryRule

On this page

On this page

Using getScheduledQueryRule

getScheduledQueryRule Result

Supporting Types

AlertingActionResponse

AzNsActionGroupResponse

CriteriaResponse

DimensionResponse

LogMetricTriggerResponse

LogToMetricActionResponse

ScheduleResponse

SourceResponse

TriggerConditionResponse

Package Details

On this page

On this page