insights.azure.com/v1api20220615

insights.azure.com/v1api20220615

Package v1api20220615 contains API Schema definitions for the insights v1api20220615 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2022-06-15"

    Actions

    (Appears on:ScheduledQueryRule_Spec)

    Actions to invoke when the alert fires.

    Field Description
    actionGroupsReferences
    []genruntime.ResourceReference

    ActionGroupsReferences: Action Group resource Ids to invoke when the alert fires.

    customProperties
    map[string]string

    CustomProperties: The properties of an alert payload.

    Actions_ARM

    (Appears on:ScheduledQueryRuleProperties_ARM)

    Actions to invoke when the alert fires.

    Field Description
    actionGroups
    []string
    customProperties
    map[string]string

    CustomProperties: The properties of an alert payload.

    Actions_STATUS

    (Appears on:ScheduledQueryRule_STATUS)

    Actions to invoke when the alert fires.

    Field Description
    actionGroups
    []string

    ActionGroups: Action Group resource Ids to invoke when the alert fires.

    customProperties
    map[string]string

    CustomProperties: The properties of an alert payload.

    Actions_STATUS_ARM

    (Appears on:ScheduledQueryRuleProperties_STATUS_ARM)

    Actions to invoke when the alert fires.

    Field Description
    actionGroups
    []string

    ActionGroups: Action Group resource Ids to invoke when the alert fires.

    customProperties
    map[string]string

    CustomProperties: The properties of an alert payload.

    Condition

    (Appears on:ScheduledQueryRuleCriteria)

    A condition of the scheduled query rule.

    Field Description
    dimensions
    []Dimension

    Dimensions: List of Dimensions conditions

    failingPeriods
    Condition_FailingPeriods

    FailingPeriods: 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

    MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.

    metricName
    string

    MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.

    operator
    Condition_Operator

    Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.

    query
    string

    Query: Log query alert

    resourceIdColumnReference
    genruntime.ResourceReference

    ResourceIdColumnReference: 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

    Threshold: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.

    timeAggregation
    Condition_TimeAggregation

    TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

    Condition_ARM

    (Appears on:ScheduledQueryRuleCriteria_ARM)

    A condition of the scheduled query rule.

    Field Description
    dimensions
    []Dimension_ARM

    Dimensions: List of Dimensions conditions

    failingPeriods
    Condition_FailingPeriods_ARM

    FailingPeriods: 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

    MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.

    metricName
    string

    MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.

    operator
    Condition_Operator

    Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.

    query
    string

    Query: Log query alert

    resourceIdColumn
    string
    threshold
    float64

    Threshold: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.

    timeAggregation
    Condition_TimeAggregation

    TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

    Condition_FailingPeriods

    (Appears on:Condition)

    Field Description
    minFailingPeriodsToAlert
    int

    MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1

    numberOfEvaluationPeriods
    int

    NumberOfEvaluationPeriods: 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

    Condition_FailingPeriods_ARM

    (Appears on:Condition_ARM)

    Field Description
    minFailingPeriodsToAlert
    int

    MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1

    numberOfEvaluationPeriods
    int

    NumberOfEvaluationPeriods: 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

    Condition_FailingPeriods_STATUS

    (Appears on:Condition_STATUS)

    Field Description
    minFailingPeriodsToAlert
    int

    MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1

    numberOfEvaluationPeriods
    int

    NumberOfEvaluationPeriods: 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

    Condition_FailingPeriods_STATUS_ARM

    (Appears on:Condition_STATUS_ARM)

    Field Description
    minFailingPeriodsToAlert
    int

    MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1

    numberOfEvaluationPeriods
    int

    NumberOfEvaluationPeriods: 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

    Condition_Operator (string alias)

    (Appears on:Condition, Condition_ARM)

    Value Description

    "Equals"

    "GreaterThan"

    "GreaterThanOrEqual"

    "LessThan"

    "LessThanOrEqual"

    Condition_Operator_STATUS (string alias)

    (Appears on:Condition_STATUS, Condition_STATUS_ARM)

    Value Description

    "Equals"

    "GreaterThan"

    "GreaterThanOrEqual"

    "LessThan"

    "LessThanOrEqual"

    Condition_STATUS

    (Appears on:ScheduledQueryRuleCriteria_STATUS)

    A condition of the scheduled query rule.

    Field Description
    dimensions
    []Dimension_STATUS

    Dimensions: List of Dimensions conditions

    failingPeriods
    Condition_FailingPeriods_STATUS

    FailingPeriods: 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

    MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.

    metricName
    string

    MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.

    operator
    Condition_Operator_STATUS

    Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.

    query
    string

    Query: Log query alert

    resourceIdColumn
    string

    ResourceIdColumn: 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

    Threshold: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.

    timeAggregation
    Condition_TimeAggregation_STATUS

    TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

    Condition_STATUS_ARM

    (Appears on:ScheduledQueryRuleCriteria_STATUS_ARM)

    A condition of the scheduled query rule.

    Field Description
    dimensions
    []Dimension_STATUS_ARM

    Dimensions: List of Dimensions conditions

    failingPeriods
    Condition_FailingPeriods_STATUS_ARM

    FailingPeriods: 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

    MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert.

    metricName
    string

    MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric.

    operator
    Condition_Operator_STATUS

    Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert.

    query
    string

    Query: Log query alert

    resourceIdColumn
    string

    ResourceIdColumn: 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

    Threshold: the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert.

    timeAggregation
    Condition_TimeAggregation_STATUS

    TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert.

    Condition_TimeAggregation (string alias)

    (Appears on:Condition, Condition_ARM)

    Value Description

    "Average"

    "Count"

    "Maximum"

    "Minimum"

    "Total"

    Condition_TimeAggregation_STATUS (string alias)

    (Appears on:Condition_STATUS, Condition_STATUS_ARM)

    Value Description

    "Average"

    "Count"

    "Maximum"

    "Minimum"

    "Total"

    Dimension

    (Appears on:Condition)

    Dimension splitting and filtering definition

    Field Description
    name
    string

    Name: Name of the dimension

    operator
    Dimension_Operator

    Operator: Operator for dimension values

    values
    []string

    Values: List of dimension values

    Dimension_ARM

    (Appears on:Condition_ARM)

    Dimension splitting and filtering definition

    Field Description
    name
    string

    Name: Name of the dimension

    operator
    Dimension_Operator

    Operator: Operator for dimension values

    values
    []string

    Values: List of dimension values

    Dimension_Operator (string alias)

    (Appears on:Dimension, Dimension_ARM)

    Value Description

    "Exclude"

    "Include"

    Dimension_Operator_STATUS (string alias)

    (Appears on:Dimension_STATUS, Dimension_STATUS_ARM)

    Value Description

    "Exclude"

    "Include"

    Dimension_STATUS

    (Appears on:Condition_STATUS)

    Dimension splitting and filtering definition

    Field Description
    name
    string

    Name: Name of the dimension

    operator
    Dimension_Operator_STATUS

    Operator: Operator for dimension values

    values
    []string

    Values: List of dimension values

    Dimension_STATUS_ARM

    (Appears on:Condition_STATUS_ARM)

    Dimension splitting and filtering definition

    Field Description
    name
    string

    Name: Name of the dimension

    operator
    Dimension_Operator_STATUS

    Operator: Operator for dimension values

    values
    []string

    Values: List of dimension values

    ScheduledQueryRule

    Generator information: - Generated from: /monitor/resource-manager/Microsoft.Insights/stable/2022-06-15/scheduledQueryRule_API.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Insights/​scheduledQueryRules/​{ruleName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    ScheduledQueryRule_Spec


    actions
    Actions

    Actions: Actions to invoke when the alert fires.

    autoMitigate
    bool

    AutoMitigate: 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.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    checkWorkspaceAlertsStorageConfigured
    bool

    CheckWorkspaceAlertsStorageConfigured: 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.

    criteria
    ScheduledQueryRuleCriteria

    Criteria: The rule criteria that defines the conditions of the scheduled query rule.

    description
    string

    Description: The description of the scheduled query rule.

    displayName
    string

    DisplayName: The display name of the alert rule

    enabled
    bool

    Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

    evaluationFrequency
    string

    EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

    kind
    ScheduledQueryRule_Kind_Spec

    Kind: Indicates the type of scheduled query rule. The default is LogAlert.

    location
    string

    Location: The geo-location where the resource lives

    muteActionsDuration
    string

    MuteActionsDuration: 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

    OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    scopesReferences
    []genruntime.ResourceReference

    ScopesReferences: The list of resource id’s that this scheduled query rule is scoped to.

    severity
    ScheduledQueryRuleProperties_Severity

    Severity: 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

    SkipQueryValidation: 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

    Tags: Resource tags.

    targetResourceTypes
    []string

    TargetResourceTypes: 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

    WindowSize: 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.

    status
    ScheduledQueryRule_STATUS

    ScheduledQueryRuleCriteria

    (Appears on:ScheduledQueryRule_Spec)

    The rule criteria that defines the conditions of the scheduled query rule.

    Field Description
    allOf
    []Condition

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

    ScheduledQueryRuleCriteria_ARM

    (Appears on:ScheduledQueryRuleProperties_ARM)

    The rule criteria that defines the conditions of the scheduled query rule.

    Field Description
    allOf
    []Condition_ARM

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

    ScheduledQueryRuleCriteria_STATUS

    (Appears on:ScheduledQueryRule_STATUS)

    The rule criteria that defines the conditions of the scheduled query rule.

    Field Description
    allOf
    []Condition_STATUS

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

    ScheduledQueryRuleCriteria_STATUS_ARM

    (Appears on:ScheduledQueryRuleProperties_STATUS_ARM)

    The rule criteria that defines the conditions of the scheduled query rule.

    Field Description
    allOf
    []Condition_STATUS_ARM

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

    ScheduledQueryRuleProperties_ARM

    (Appears on:ScheduledQueryRule_Spec_ARM)

    scheduled query rule Definition

    Field Description
    actions
    Actions_ARM

    Actions: Actions to invoke when the alert fires.

    autoMitigate
    bool

    AutoMitigate: 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

    CheckWorkspaceAlertsStorageConfigured: 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.

    criteria
    ScheduledQueryRuleCriteria_ARM

    Criteria: The rule criteria that defines the conditions of the scheduled query rule.

    description
    string

    Description: The description of the scheduled query rule.

    displayName
    string

    DisplayName: The display name of the alert rule

    enabled
    bool

    Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

    evaluationFrequency
    string

    EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

    muteActionsDuration
    string

    MuteActionsDuration: 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

    OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

    scopes
    []string
    severity
    ScheduledQueryRuleProperties_Severity

    Severity: 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

    SkipQueryValidation: 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.

    targetResourceTypes
    []string

    TargetResourceTypes: 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

    WindowSize: 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.

    ScheduledQueryRuleProperties_STATUS_ARM

    (Appears on:ScheduledQueryRule_STATUS_ARM)

    scheduled query rule Definition

    Field Description
    actions
    Actions_STATUS_ARM

    Actions: Actions to invoke when the alert fires.

    autoMitigate
    bool

    AutoMitigate: 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

    CheckWorkspaceAlertsStorageConfigured: 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.

    createdWithApiVersion
    string

    CreatedWithApiVersion: The api-version used when creating this alert rule

    criteria
    ScheduledQueryRuleCriteria_STATUS_ARM

    Criteria: The rule criteria that defines the conditions of the scheduled query rule.

    description
    string

    Description: The description of the scheduled query rule.

    displayName
    string

    DisplayName: The display name of the alert rule

    enabled
    bool

    Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

    evaluationFrequency
    string

    EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

    isLegacyLogAnalyticsRule
    bool

    IsLegacyLogAnalyticsRule: True if alert rule is legacy Log Analytic rule

    isWorkspaceAlertsStorageConfigured
    bool

    IsWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer’s storage. The default is false.

    muteActionsDuration
    string

    MuteActionsDuration: 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

    OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

    scopes
    []string

    Scopes: The list of resource id’s that this scheduled query rule is scoped to.

    severity
    ScheduledQueryRuleProperties_Severity_STATUS

    Severity: 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

    SkipQueryValidation: 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.

    targetResourceTypes
    []string

    TargetResourceTypes: 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

    WindowSize: 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.

    ScheduledQueryRuleProperties_Severity (int alias)

    (Appears on:ScheduledQueryRuleProperties_ARM, ScheduledQueryRule_Spec)

    Value Description

    0

    1

    2

    3

    4

    ScheduledQueryRuleProperties_Severity_STATUS (int alias)

    (Appears on:ScheduledQueryRuleProperties_STATUS_ARM, ScheduledQueryRule_STATUS)

    Value Description

    0

    1

    2

    3

    4

    ScheduledQueryRule_Kind_STATUS (string alias)

    (Appears on:ScheduledQueryRule_STATUS, ScheduledQueryRule_STATUS_ARM)

    Value Description

    "LogAlert"

    "LogToMetric"

    ScheduledQueryRule_Kind_Spec (string alias)

    (Appears on:ScheduledQueryRule_Spec, ScheduledQueryRule_Spec_ARM)

    Value Description

    "LogAlert"

    "LogToMetric"

    ScheduledQueryRule_STATUS

    (Appears on:ScheduledQueryRule)

    Field Description
    actions
    Actions_STATUS

    Actions: Actions to invoke when the alert fires.

    autoMitigate
    bool

    AutoMitigate: 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

    CheckWorkspaceAlertsStorageConfigured: 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.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    createdWithApiVersion
    string

    CreatedWithApiVersion: The api-version used when creating this alert rule

    criteria
    ScheduledQueryRuleCriteria_STATUS

    Criteria: The rule criteria that defines the conditions of the scheduled query rule.

    description
    string

    Description: The description of the scheduled query rule.

    displayName
    string

    DisplayName: The display name of the alert rule

    enabled
    bool

    Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

    etag
    string

    Etag: 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.

    evaluationFrequency
    string

    EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

    id
    string

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    isLegacyLogAnalyticsRule
    bool

    IsLegacyLogAnalyticsRule: True if alert rule is legacy Log Analytic rule

    isWorkspaceAlertsStorageConfigured
    bool

    IsWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule has been configured to be stored in the customer’s storage. The default is false.

    kind
    ScheduledQueryRule_Kind_STATUS

    Kind: Indicates the type of scheduled query rule. The default is LogAlert.

    location
    string

    Location: The geo-location where the resource lives

    muteActionsDuration
    string

    MuteActionsDuration: 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.

    name
    string

    Name: The name of the resource

    overrideQueryTimeRange
    string

    OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

    scopes
    []string

    Scopes: The list of resource id’s that this scheduled query rule is scoped to.

    severity
    ScheduledQueryRuleProperties_Severity_STATUS

    Severity: 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

    SkipQueryValidation: 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.

    systemData
    SystemData_STATUS

    SystemData: SystemData of ScheduledQueryRule.

    tags
    map[string]string

    Tags: Resource tags.

    targetResourceTypes
    []string

    TargetResourceTypes: 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

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    windowSize
    string

    WindowSize: 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.

    ScheduledQueryRule_STATUS_ARM

    Field Description
    etag
    string

    Etag: 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

    Id: Fully qualified resource ID for the resource. Ex - /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}

    kind
    ScheduledQueryRule_Kind_STATUS

    Kind: Indicates the type of scheduled query rule. The default is LogAlert.

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    ScheduledQueryRuleProperties_STATUS_ARM

    Properties: The rule properties of the resource.

    systemData
    SystemData_STATUS_ARM

    SystemData: SystemData of ScheduledQueryRule.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    ScheduledQueryRule_Spec

    (Appears on:ScheduledQueryRule)

    Field Description
    actions
    Actions

    Actions: Actions to invoke when the alert fires.

    autoMitigate
    bool

    AutoMitigate: 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.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    checkWorkspaceAlertsStorageConfigured
    bool

    CheckWorkspaceAlertsStorageConfigured: 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.

    criteria
    ScheduledQueryRuleCriteria

    Criteria: The rule criteria that defines the conditions of the scheduled query rule.

    description
    string

    Description: The description of the scheduled query rule.

    displayName
    string

    DisplayName: The display name of the alert rule

    enabled
    bool

    Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false

    evaluationFrequency
    string

    EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert.

    kind
    ScheduledQueryRule_Kind_Spec

    Kind: Indicates the type of scheduled query rule. The default is LogAlert.

    location
    string

    Location: The geo-location where the resource lives

    muteActionsDuration
    string

    MuteActionsDuration: 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

    OverrideQueryTimeRange: If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    scopesReferences
    []genruntime.ResourceReference

    ScopesReferences: The list of resource id’s that this scheduled query rule is scoped to.

    severity
    ScheduledQueryRuleProperties_Severity

    Severity: 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

    SkipQueryValidation: 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

    Tags: Resource tags.

    targetResourceTypes
    []string

    TargetResourceTypes: 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

    WindowSize: 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.

    ScheduledQueryRule_Spec_ARM

    Field Description
    kind
    ScheduledQueryRule_Kind_Spec

    Kind: Indicates the type of scheduled query rule. The default is LogAlert.

    location
    string

    Location: The geo-location where the resource lives

    name
    string
    properties
    ScheduledQueryRuleProperties_ARM

    Properties: The rule properties of the resource.

    tags
    map[string]string

    Tags: Resource tags.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:ScheduledQueryRule_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:ScheduledQueryRule_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.