1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. getBaselineableMetrics
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi

oci.StackMonitoring.getBaselineableMetrics

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 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: testBaselineableMetric.id,
    compartmentId: compartmentId,
    isOutOfBox: baselineableMetricIsOutOfBox,
    metricNamespace: baselineableMetricMetricNamespace,
    name: baselineableMetricName,
    resourceGroup: baselineableMetricResourceGroup,
    resourceType: baselineableMetricResourceType,
});
Copy
import pulumi
import pulumi_oci as oci

test_baselineable_metrics = oci.StackMonitoring.get_baselineable_metrics(baselineable_metric_id=test_baselineable_metric["id"],
    compartment_id=compartment_id,
    is_out_of_box=baselineable_metric_is_out_of_box,
    metric_namespace=baselineable_metric_metric_namespace,
    name=baselineable_metric_name,
    resource_group=baselineable_metric_resource_group,
    resource_type=baselineable_metric_resource_type)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/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(testBaselineableMetric.Id),
			CompartmentId:        pulumi.StringRef(compartmentId),
			IsOutOfBox:           pulumi.BoolRef(baselineableMetricIsOutOfBox),
			MetricNamespace:      pulumi.StringRef(baselineableMetricMetricNamespace),
			Name:                 pulumi.StringRef(baselineableMetricName),
			ResourceGroup:        pulumi.StringRef(baselineableMetricResourceGroup),
			ResourceType:         pulumi.StringRef(baselineableMetricResourceType),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = testBaselineableMetric.Id,
        CompartmentId = compartmentId,
        IsOutOfBox = baselineableMetricIsOutOfBox,
        MetricNamespace = baselineableMetricMetricNamespace,
        Name = baselineableMetricName,
        ResourceGroup = baselineableMetricResourceGroup,
        ResourceType = baselineableMetricResourceType,
    });

});
Copy
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(testBaselineableMetric.id())
            .compartmentId(compartmentId)
            .isOutOfBox(baselineableMetricIsOutOfBox)
            .metricNamespace(baselineableMetricMetricNamespace)
            .name(baselineableMetricName)
            .resourceGroup(baselineableMetricResourceGroup)
            .resourceType(baselineableMetricResourceType)
            .build());

    }
}
Copy
variables:
  testBaselineableMetrics:
    fn::invoke:
      function: oci:StackMonitoring:getBaselineableMetrics
      arguments:
        baselineableMetricId: ${testBaselineableMetric.id}
        compartmentId: ${compartmentId}
        isOutOfBox: ${baselineableMetricIsOutOfBox}
        metricNamespace: ${baselineableMetricMetricNamespace}
        name: ${baselineableMetricName}
        resourceGroup: ${baselineableMetricResourceGroup}
        resourceType: ${baselineableMetricResourceType}
Copy

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

> 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)
}
Copy
public static CompletableFuture<GetBaselineableMetricsResult> getBaselineableMetrics(GetBaselineableMetricsArgs args, InvokeOptions options)
public static Output<GetBaselineableMetricsResult> getBaselineableMetrics(GetBaselineableMetricsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:StackMonitoring/getBaselineableMetrics:getBaselineableMetrics
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BaselineableMetricId string
Identifier for the metric
CompartmentId string
The ID of the compartment in which data is listed.
Filters Changes to this property will trigger replacement. List<GetBaselineableMetricsFilter>
IsOutOfBox bool
Is the baseline enabled metric defined out of box by Oracle or by end-user
MetricNamespace string
A filter to return monitored resource types that has the matching namespace.
Name string
Metric Name
ResourceGroup string
Resource Group
ResourceType string
Resource Type
BaselineableMetricId string
Identifier for the metric
CompartmentId string
The ID of the compartment in which data is listed.
Filters Changes to this property will trigger replacement. []GetBaselineableMetricsFilter
IsOutOfBox bool
Is the baseline enabled metric defined out of box by Oracle or by end-user
MetricNamespace string
A filter to return monitored resource types that has the matching namespace.
Name string
Metric Name
ResourceGroup string
Resource Group
ResourceType string
Resource Type
baselineableMetricId String
Identifier for the metric
compartmentId String
The ID of the compartment in which data is listed.
filters Changes to this property will trigger replacement. List<GetBaselineableMetricsFilter>
isOutOfBox Boolean
Is the baseline enabled metric defined out of box by Oracle or by end-user
metricNamespace String
A filter to return monitored resource types that has the matching namespace.
name String
Metric Name
resourceGroup String
Resource Group
resourceType String
Resource Type
baselineableMetricId string
Identifier for the metric
compartmentId string
The ID of the compartment in which data is listed.
filters Changes to this property will trigger replacement. GetBaselineableMetricsFilter[]
isOutOfBox boolean
Is the baseline enabled metric defined out of box by Oracle or by end-user
metricNamespace string
A filter to return monitored resource types that has the matching namespace.
name string
Metric Name
resourceGroup string
Resource Group
resourceType string
Resource Type
baselineable_metric_id str
Identifier for the metric
compartment_id str
The ID of the compartment in which data is listed.
filters Changes to this property will trigger replacement. Sequence[stackmonitoring.GetBaselineableMetricsFilter]
is_out_of_box bool
Is the baseline enabled metric defined out of box by Oracle or by end-user
metric_namespace str
A filter to return monitored resource types that has the matching namespace.
name str
Metric Name
resource_group str
Resource Group
resource_type str
Resource Type
baselineableMetricId String
Identifier for the metric
compartmentId String
The ID of the compartment in which data is listed.
filters Changes to this property will trigger replacement. List<Property Map>
isOutOfBox Boolean
Is the baseline enabled metric defined out of box by Oracle or by end-user
metricNamespace String
A filter to return monitored resource types that has the matching namespace.
name String
Metric Name
resourceGroup String
Resource Group
resourceType String
Resource Type

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>
IsOutOfBox bool
Is the metric created out of box, default false
MetricNamespace string
Name string
name of the metric
ResourceGroup string
Resource group of the metric
ResourceType string
Resource type 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
IsOutOfBox bool
Is the metric created out of box, default false
MetricNamespace string
Name string
name of the metric
ResourceGroup string
Resource group of the metric
ResourceType string
Resource type 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>
isOutOfBox Boolean
Is the metric created out of box, default false
metricNamespace String
name String
name of the metric
resourceGroup String
Resource group of the metric
resourceType String
Resource type 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[]
isOutOfBox boolean
Is the metric created out of box, default false
metricNamespace string
name string
name of the metric
resourceGroup string
Resource group of the metric
resourceType string
Resource type 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]
is_out_of_box bool
Is the metric created out of box, default false
metric_namespace str
name str
name of the metric
resource_group str
Resource group of the metric
resource_type str
Resource type 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>
isOutOfBox Boolean
Is the metric created out of box, default false
metricNamespace String
name String
name of the metric
resourceGroup String
Resource group of the metric
resourceType String
Resource type of the metric

Supporting Types

GetBaselineableMetricsBaselineableMetricSummaryCollection

items This property is required. List<Property Map>

GetBaselineableMetricsBaselineableMetricSummaryCollectionItem

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

GetBaselineableMetricsFilter

Name This property is required. string
Metric Name
Values This property is required. List<string>
Regex bool
Name This property is required. string
Metric Name
Values This property is required. []string
Regex bool
name This property is required. String
Metric Name
values This property is required. List<String>
regex Boolean
name This property is required. string
Metric Name
values This property is required. string[]
regex boolean
name This property is required. str
Metric Name
values This property is required. Sequence[str]
regex bool
name This property is required. String
Metric Name
values This property is required. 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.
Oracle Cloud Infrastructure v2.32.0 published on Thursday, Apr 24, 2025 by Pulumi