Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. alertsmanagement
  5. getPrometheusRuleGroup
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.39.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.alertsmanagement.getPrometheusRuleGroup

Explore with Pulumi AI

azure-native logo
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.39.0 published on Monday, Apr 29, 2024 by Pulumi
pulumi/pulumi-azure-native

    Retrieve a Prometheus rule group definition. Azure REST API version: 2023-03-01.

    Using getPrometheusRuleGroup

    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 getPrometheusRuleGroup(args: GetPrometheusRuleGroupArgs, opts?: InvokeOptions): Promise<GetPrometheusRuleGroupResult>
function getPrometheusRuleGroupOutput(args: GetPrometheusRuleGroupOutputArgs, opts?: InvokeOptions): Output<GetPrometheusRuleGroupResult>
    def get_prometheus_rule_group(resource_group_name: Optional[str] = None,
                              rule_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPrometheusRuleGroupResult
def get_prometheus_rule_group_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                              rule_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPrometheusRuleGroupResult]
    func LookupPrometheusRuleGroup(ctx *Context, args *LookupPrometheusRuleGroupArgs, opts ...InvokeOption) (*LookupPrometheusRuleGroupResult, error)
func LookupPrometheusRuleGroupOutput(ctx *Context, args *LookupPrometheusRuleGroupOutputArgs, opts ...InvokeOption) LookupPrometheusRuleGroupResultOutput

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

    public static class GetPrometheusRuleGroup 
{
    public static Task<GetPrometheusRuleGroupResult> InvokeAsync(GetPrometheusRuleGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPrometheusRuleGroupResult> Invoke(GetPrometheusRuleGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrometheusRuleGroupResult> getPrometheusRuleGroup(GetPrometheusRuleGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:alertsmanagement:getPrometheusRuleGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RuleGroupName string
    The name of the rule group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    RuleGroupName string
    The name of the rule group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ruleGroupName String
    The name of the rule group.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    ruleGroupName string
    The name of the rule group.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    rule_group_name str
    The name of the rule group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    ruleGroupName String
    The name of the rule group.

    getPrometheusRuleGroup Result

    The following output properties are available:

    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Rules List<Pulumi.AzureNative.AlertsManagement.Outputs.PrometheusRuleResponse>
    Defines the rules in the Prometheus rule group.
    Scopes List<string>
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    SystemData Pulumi.AzureNative.AlertsManagement.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ClusterName string
    Apply rule to data from a specific cluster.
    Description string
    Rule group description.
    Enabled bool
    Enable/disable rule group.
    Interval string
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    Tags Dictionary<string, string>
    Resource tags.
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Rules []PrometheusRuleResponse
    Defines the rules in the Prometheus rule group.
    Scopes []string
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    ClusterName string
    Apply rule to data from a specific cluster.
    Description string
    Rule group description.
    Enabled bool
    Enable/disable rule group.
    Interval string
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    Tags map[string]string
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    rules List<PrometheusRuleResponse>
    Defines the rules in the Prometheus rule group.
    scopes List<String>
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterName String
    Apply rule to data from a specific cluster.
    description String
    Rule group description.
    enabled Boolean
    Enable/disable rule group.
    interval String
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    tags Map<String,String>
    Resource tags.
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    rules PrometheusRuleResponse[]
    Defines the rules in the Prometheus rule group.
    scopes string[]
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterName string
    Apply rule to data from a specific cluster.
    description string
    Rule group description.
    enabled boolean
    Enable/disable rule group.
    interval string
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    tags {[key: string]: string}
    Resource tags.
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    rules Sequence[PrometheusRuleResponse]
    Defines the rules in the Prometheus rule group.
    scopes Sequence[str]
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    cluster_name str
    Apply rule to data from a specific cluster.
    description str
    Rule group description.
    enabled bool
    Enable/disable rule group.
    interval str
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    tags Mapping[str, str]
    Resource tags.
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    rules List<Property Map>
    Defines the rules in the Prometheus rule group.
    scopes List<String>
    Target Azure Monitor workspaces resource ids. This api-version is currently limited to creating with one scope. This may change in future.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    clusterName String
    Apply rule to data from a specific cluster.
    description String
    Rule group description.
    enabled Boolean
    Enable/disable rule group.
    interval String
    The interval in which to run the Prometheus rule group represented in ISO 8601 duration format. Should be between 1 and 15 minutes
    tags Map<String>
    Resource tags.

    Supporting Types

    PrometheusRuleGroupActionResponse

    ActionGroupId string
    The resource id of the action group to use.
    ActionProperties Dictionary<string, string>
    The properties of an action group object.
    ActionGroupId string
    The resource id of the action group to use.
    ActionProperties map[string]string
    The properties of an action group object.
    actionGroupId String
    The resource id of the action group to use.
    actionProperties Map<String,String>
    The properties of an action group object.
    actionGroupId string
    The resource id of the action group to use.
    actionProperties {[key: string]: string}
    The properties of an action group object.
    action_group_id str
    The resource id of the action group to use.
    action_properties Mapping[str, str]
    The properties of an action group object.
    actionGroupId String
    The resource id of the action group to use.
    actionProperties Map<String>
    The properties of an action group object.

    PrometheusRuleResolveConfigurationResponse

    AutoResolved bool
    Enable alert auto-resolution.
    TimeToResolve string
    Alert auto-resolution timeout.
    AutoResolved bool
    Enable alert auto-resolution.
    TimeToResolve string
    Alert auto-resolution timeout.
    autoResolved Boolean
    Enable alert auto-resolution.
    timeToResolve String
    Alert auto-resolution timeout.
    autoResolved boolean
    Enable alert auto-resolution.
    timeToResolve string
    Alert auto-resolution timeout.
    auto_resolved bool
    Enable alert auto-resolution.
    time_to_resolve str
    Alert auto-resolution timeout.
    autoResolved Boolean
    Enable alert auto-resolution.
    timeToResolve String
    Alert auto-resolution timeout.

    PrometheusRuleResponse

    Expression string
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    Actions List<Pulumi.AzureNative.AlertsManagement.Inputs.PrometheusRuleGroupActionResponse>
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    Alert string
    Alert rule name.
    Annotations Dictionary<string, string>
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    Enabled bool
    Enable/disable rule.
    For string
    The amount of time alert must be active before firing.
    Labels Dictionary<string, string>
    Labels to add or overwrite before storing the result.
    Record string
    Recorded metrics name.
    ResolveConfiguration Pulumi.AzureNative.AlertsManagement.Inputs.PrometheusRuleResolveConfigurationResponse
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    Severity int
    The severity of the alerts fired by the rule. Must be between 0 and 4.
    Expression string
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    Actions []PrometheusRuleGroupActionResponse
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    Alert string
    Alert rule name.
    Annotations map[string]string
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    Enabled bool
    Enable/disable rule.
    For string
    The amount of time alert must be active before firing.
    Labels map[string]string
    Labels to add or overwrite before storing the result.
    Record string
    Recorded metrics name.
    ResolveConfiguration PrometheusRuleResolveConfigurationResponse
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    Severity int
    The severity of the alerts fired by the rule. Must be between 0 and 4.
    expression String
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    actions List<PrometheusRuleGroupActionResponse>
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    alert String
    Alert rule name.
    annotations Map<String,String>
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    enabled Boolean
    Enable/disable rule.
    for_ String
    The amount of time alert must be active before firing.
    labels Map<String,String>
    Labels to add or overwrite before storing the result.
    record String
    Recorded metrics name.
    resolveConfiguration PrometheusRuleResolveConfigurationResponse
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    severity Integer
    The severity of the alerts fired by the rule. Must be between 0 and 4.
    expression string
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    actions PrometheusRuleGroupActionResponse[]
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    alert string
    Alert rule name.
    annotations {[key: string]: string}
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    enabled boolean
    Enable/disable rule.
    for string
    The amount of time alert must be active before firing.
    labels {[key: string]: string}
    Labels to add or overwrite before storing the result.
    record string
    Recorded metrics name.
    resolveConfiguration PrometheusRuleResolveConfigurationResponse
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    severity number
    The severity of the alerts fired by the rule. Must be between 0 and 4.
    expression str
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    actions Sequence[PrometheusRuleGroupActionResponse]
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    alert str
    Alert rule name.
    annotations Mapping[str, str]
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    enabled bool
    Enable/disable rule.
    for_ str
    The amount of time alert must be active before firing.
    labels Mapping[str, str]
    Labels to add or overwrite before storing the result.
    record str
    Recorded metrics name.
    resolve_configuration PrometheusRuleResolveConfigurationResponse
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    severity int
    The severity of the alerts fired by the rule. Must be between 0 and 4.
    expression String
    The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'.
    actions List<Property Map>
    Actions that are performed when the alert rule becomes active, and when an alert condition is resolved.
    alert String
    Alert rule name.
    annotations Map<String>
    The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated.
    enabled Boolean
    Enable/disable rule.
    for String
    The amount of time alert must be active before firing.
    labels Map<String>
    Labels to add or overwrite before storing the result.
    record String
    Recorded metrics name.
    resolveConfiguration Property Map
    Defines the configuration for resolving fired alerts. Only relevant for alerts.
    severity Number
    The severity of the alerts fired by the rule. Must be between 0 and 4.

    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.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.39.0 published on Monday, Apr 29, 2024 by Pulumi
    pulumi/pulumi-azure-native