1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. getBaselineableMetrics
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

oci.StackMonitoring.getBaselineableMetrics

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

    This data source provides the list of Baselineable Metrics in Oracle Cloud Infrastructure Stack Monitoring service.

    List of summary of baseline-able metrics for a given resource group if specified.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testBaselineableMetrics = oci.StackMonitoring.getBaselineableMetrics({
        baselineableMetricId: oci_stack_monitoring_baselineable_metric.test_baselineable_metric.id,
        compartmentId: _var.compartment_id,
        metricNamespace: _var.baselineable_metric_metric_namespace,
        name: _var.baselineable_metric_name,
        resourceGroup: _var.baselineable_metric_resource_group,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_baselineable_metrics = oci.StackMonitoring.get_baselineable_metrics(baselineable_metric_id=oci_stack_monitoring_baselineable_metric["test_baselineable_metric"]["id"],
        compartment_id=var["compartment_id"],
        metric_namespace=var["baselineable_metric_metric_namespace"],
        name=var["baselineable_metric_name"],
        resource_group=var["baselineable_metric_resource_group"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/StackMonitoring"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := StackMonitoring.GetBaselineableMetrics(ctx, &stackmonitoring.GetBaselineableMetricsArgs{
    			BaselineableMetricId: pulumi.StringRef(oci_stack_monitoring_baselineable_metric.Test_baselineable_metric.Id),
    			CompartmentId:        pulumi.StringRef(_var.Compartment_id),
    			MetricNamespace:      pulumi.StringRef(_var.Baselineable_metric_metric_namespace),
    			Name:                 pulumi.StringRef(_var.Baselineable_metric_name),
    			ResourceGroup:        pulumi.StringRef(_var.Baselineable_metric_resource_group),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testBaselineableMetrics = Oci.StackMonitoring.GetBaselineableMetrics.Invoke(new()
        {
            BaselineableMetricId = oci_stack_monitoring_baselineable_metric.Test_baselineable_metric.Id,
            CompartmentId = @var.Compartment_id,
            MetricNamespace = @var.Baselineable_metric_metric_namespace,
            Name = @var.Baselineable_metric_name,
            ResourceGroup = @var.Baselineable_metric_resource_group,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.StackMonitoring.StackMonitoringFunctions;
    import com.pulumi.oci.StackMonitoring.inputs.GetBaselineableMetricsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var testBaselineableMetrics = StackMonitoringFunctions.getBaselineableMetrics(GetBaselineableMetricsArgs.builder()
                .baselineableMetricId(oci_stack_monitoring_baselineable_metric.test_baselineable_metric().id())
                .compartmentId(var_.compartment_id())
                .metricNamespace(var_.baselineable_metric_metric_namespace())
                .name(var_.baselineable_metric_name())
                .resourceGroup(var_.baselineable_metric_resource_group())
                .build());
    
        }
    }
    
    variables:
      testBaselineableMetrics:
        fn::invoke:
          Function: oci:StackMonitoring:getBaselineableMetrics
          Arguments:
            baselineableMetricId: ${oci_stack_monitoring_baselineable_metric.test_baselineable_metric.id}
            compartmentId: ${var.compartment_id}
            metricNamespace: ${var.baselineable_metric_metric_namespace}
            name: ${var.baselineable_metric_name}
            resourceGroup: ${var.baselineable_metric_resource_group}
    

    Using getBaselineableMetrics

    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 getBaselineableMetrics(args: GetBaselineableMetricsArgs, opts?: InvokeOptions): Promise<GetBaselineableMetricsResult>
    function getBaselineableMetricsOutput(args: GetBaselineableMetricsOutputArgs, opts?: InvokeOptions): Output<GetBaselineableMetricsResult>
    def get_baselineable_metrics(baselineable_metric_id: Optional[str] = None,
                                 compartment_id: Optional[str] = None,
                                 filters: Optional[Sequence[_stackmonitoring.GetBaselineableMetricsFilter]] = None,
                                 metric_namespace: Optional[str] = None,
                                 name: Optional[str] = None,
                                 resource_group: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetBaselineableMetricsResult
    def get_baselineable_metrics_output(baselineable_metric_id: Optional[pulumi.Input[str]] = None,
                                 compartment_id: Optional[pulumi.Input[str]] = None,
                                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_stackmonitoring.GetBaselineableMetricsFilterArgs]]]] = None,
                                 metric_namespace: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 resource_group: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetBaselineableMetricsResult]
    func GetBaselineableMetrics(ctx *Context, args *GetBaselineableMetricsArgs, opts ...InvokeOption) (*GetBaselineableMetricsResult, error)
    func GetBaselineableMetricsOutput(ctx *Context, args *GetBaselineableMetricsOutputArgs, opts ...InvokeOption) GetBaselineableMetricsResultOutput

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

    public static class GetBaselineableMetrics 
    {
        public static Task<GetBaselineableMetricsResult> InvokeAsync(GetBaselineableMetricsArgs args, InvokeOptions? opts = null)
        public static Output<GetBaselineableMetricsResult> Invoke(GetBaselineableMetricsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBaselineableMetricsResult> getBaselineableMetrics(GetBaselineableMetricsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:StackMonitoring/getBaselineableMetrics:getBaselineableMetrics
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BaselineableMetricId string
    Identifier for the metric
    CompartmentId string
    The ID of the compartment in which data is listed.
    Filters List<GetBaselineableMetricsFilter>
    MetricNamespace string
    A filter to return monitored resource types that has the matching namespace.
    Name string
    Metric Name
    ResourceGroup string
    Resource Group
    BaselineableMetricId string
    Identifier for the metric
    CompartmentId string
    The ID of the compartment in which data is listed.
    Filters []GetBaselineableMetricsFilter
    MetricNamespace string
    A filter to return monitored resource types that has the matching namespace.
    Name string
    Metric Name
    ResourceGroup string
    Resource Group
    baselineableMetricId String
    Identifier for the metric
    compartmentId String
    The ID of the compartment in which data is listed.
    filters List<GetBaselineableMetricsFilter>
    metricNamespace String
    A filter to return monitored resource types that has the matching namespace.
    name String
    Metric Name
    resourceGroup String
    Resource Group
    baselineableMetricId string
    Identifier for the metric
    compartmentId string
    The ID of the compartment in which data is listed.
    filters GetBaselineableMetricsFilter[]
    metricNamespace string
    A filter to return monitored resource types that has the matching namespace.
    name string
    Metric Name
    resourceGroup string
    Resource Group
    baselineable_metric_id str
    Identifier for the metric
    compartment_id str
    The ID of the compartment in which data is listed.
    filters Sequence[stackmonitoring.GetBaselineableMetricsFilter]
    metric_namespace str
    A filter to return monitored resource types that has the matching namespace.
    name str
    Metric Name
    resource_group str
    Resource Group
    baselineableMetricId String
    Identifier for the metric
    compartmentId String
    The ID of the compartment in which data is listed.
    filters List<Property Map>
    metricNamespace String
    A filter to return monitored resource types that has the matching namespace.
    name String
    Metric Name
    resourceGroup String
    Resource Group

    getBaselineableMetrics Result

    The following output properties are available:

    BaselineableMetricSummaryCollections List<GetBaselineableMetricsBaselineableMetricSummaryCollection>
    The list of baselineable_metric_summary_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    BaselineableMetricId string
    CompartmentId string
    OCID of the compartment
    Filters List<GetBaselineableMetricsFilter>
    MetricNamespace string
    Name string
    name of the metric
    ResourceGroup string
    Resource group of the metric
    BaselineableMetricSummaryCollections []GetBaselineableMetricsBaselineableMetricSummaryCollection
    The list of baselineable_metric_summary_collection.
    Id string
    The provider-assigned unique ID for this managed resource.
    BaselineableMetricId string
    CompartmentId string
    OCID of the compartment
    Filters []GetBaselineableMetricsFilter
    MetricNamespace string
    Name string
    name of the metric
    ResourceGroup string
    Resource group of the metric
    baselineableMetricSummaryCollections List<GetBaselineableMetricsBaselineableMetricSummaryCollection>
    The list of baselineable_metric_summary_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    baselineableMetricId String
    compartmentId String
    OCID of the compartment
    filters List<GetBaselineableMetricsFilter>
    metricNamespace String
    name String
    name of the metric
    resourceGroup String
    Resource group of the metric
    baselineableMetricSummaryCollections GetBaselineableMetricsBaselineableMetricSummaryCollection[]
    The list of baselineable_metric_summary_collection.
    id string
    The provider-assigned unique ID for this managed resource.
    baselineableMetricId string
    compartmentId string
    OCID of the compartment
    filters GetBaselineableMetricsFilter[]
    metricNamespace string
    name string
    name of the metric
    resourceGroup string
    Resource group of the metric
    baselineable_metric_summary_collections Sequence[stackmonitoring.GetBaselineableMetricsBaselineableMetricSummaryCollection]
    The list of baselineable_metric_summary_collection.
    id str
    The provider-assigned unique ID for this managed resource.
    baselineable_metric_id str
    compartment_id str
    OCID of the compartment
    filters Sequence[stackmonitoring.GetBaselineableMetricsFilter]
    metric_namespace str
    name str
    name of the metric
    resource_group str
    Resource group of the metric
    baselineableMetricSummaryCollections List<Property Map>
    The list of baselineable_metric_summary_collection.
    id String
    The provider-assigned unique ID for this managed resource.
    baselineableMetricId String
    compartmentId String
    OCID of the compartment
    filters List<Property Map>
    metricNamespace String
    name String
    name of the metric
    resourceGroup String
    Resource group of the metric

    Supporting Types

    GetBaselineableMetricsBaselineableMetricSummaryCollection

    GetBaselineableMetricsBaselineableMetricSummaryCollectionItem

    Column string
    metric column name
    CompartmentId string
    The ID of the compartment in which data is listed.
    CreatedBy string
    Created user id
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    OCID of the metric
    IsOutOfBox bool
    Is the metric created out of box, default false
    LastUpdatedBy string
    last Updated user id
    Name string
    Metric Name
    Namespace string
    namespace of the metric
    ResourceGroup string
    Resource Group
    State string
    The current lifecycle state of the metric extension
    SystemTags Dictionary<string, object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenancyId string
    OCID of the tenancy
    TimeCreated string
    creation date
    TimeLastUpdated string
    last updated time
    Column string
    metric column name
    CompartmentId string
    The ID of the compartment in which data is listed.
    CreatedBy string
    Created user id
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]interface{}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    OCID of the metric
    IsOutOfBox bool
    Is the metric created out of box, default false
    LastUpdatedBy string
    last Updated user id
    Name string
    Metric Name
    Namespace string
    namespace of the metric
    ResourceGroup string
    Resource Group
    State string
    The current lifecycle state of the metric extension
    SystemTags map[string]interface{}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TenancyId string
    OCID of the tenancy
    TimeCreated string
    creation date
    TimeLastUpdated string
    last updated time
    column String
    metric column name
    compartmentId String
    The ID of the compartment in which data is listed.
    createdBy String
    Created user id
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,Object>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    OCID of the metric
    isOutOfBox Boolean
    Is the metric created out of box, default false
    lastUpdatedBy String
    last Updated user id
    name String
    Metric Name
    namespace String
    namespace of the metric
    resourceGroup String
    Resource Group
    state String
    The current lifecycle state of the metric extension
    systemTags Map<String,Object>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId String
    OCID of the tenancy
    timeCreated String
    creation date
    timeLastUpdated String
    last updated time
    column string
    metric column name
    compartmentId string
    The ID of the compartment in which data is listed.
    createdBy string
    Created user id
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: any}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    OCID of the metric
    isOutOfBox boolean
    Is the metric created out of box, default false
    lastUpdatedBy string
    last Updated user id
    name string
    Metric Name
    namespace string
    namespace of the metric
    resourceGroup string
    Resource Group
    state string
    The current lifecycle state of the metric extension
    systemTags {[key: string]: any}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId string
    OCID of the tenancy
    timeCreated string
    creation date
    timeLastUpdated string
    last updated time
    column str
    metric column name
    compartment_id str
    The ID of the compartment in which data is listed.
    created_by str
    Created user id
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, Any]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    OCID of the metric
    is_out_of_box bool
    Is the metric created out of box, default false
    last_updated_by str
    last Updated user id
    name str
    Metric Name
    namespace str
    namespace of the metric
    resource_group str
    Resource Group
    state str
    The current lifecycle state of the metric extension
    system_tags Mapping[str, Any]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancy_id str
    OCID of the tenancy
    time_created str
    creation date
    time_last_updated str
    last updated time
    column String
    metric column name
    compartmentId String
    The ID of the compartment in which data is listed.
    createdBy String
    Created user id
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<Any>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    OCID of the metric
    isOutOfBox Boolean
    Is the metric created out of box, default false
    lastUpdatedBy String
    last Updated user id
    name String
    Metric Name
    namespace String
    namespace of the metric
    resourceGroup String
    Resource Group
    state String
    The current lifecycle state of the metric extension
    systemTags Map<Any>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    tenancyId String
    OCID of the tenancy
    timeCreated String
    creation date
    timeLastUpdated String
    last updated time

    GetBaselineableMetricsFilter

    Name string
    Metric Name
    Values List<string>
    Regex bool
    Name string
    Metric Name
    Values []string
    Regex bool
    name String
    Metric Name
    values List<String>
    regex Boolean
    name string
    Metric Name
    values string[]
    regex boolean
    name str
    Metric Name
    values Sequence[str]
    regex bool
    name String
    Metric Name
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi