Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. MetricExtension
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

oci.StackMonitoring.MetricExtension

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci

This resource provides the Metric Extension resource in Oracle Cloud Infrastructure Stack Monitoring service.

Creates a new metric extension resource for a given compartment

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMetricExtension = new oci.stackmonitoring.MetricExtension("test_metric_extension", {
    collectionRecurrences: metricExtensionCollectionRecurrences,
    compartmentId: compartmentId,
    displayName: metricExtensionDisplayName,
    metricLists: [{
        dataType: metricExtensionMetricListDataType,
        name: metricExtensionMetricListName,
        computeExpression: metricExtensionMetricListComputeExpression,
        displayName: metricExtensionMetricListDisplayName,
        isDimension: metricExtensionMetricListIsDimension,
        isHidden: metricExtensionMetricListIsHidden,
        metricCategory: metricExtensionMetricListMetricCategory,
        unit: metricExtensionMetricListUnit,
    }],
    name: metricExtensionName,
    queryProperties: {
        collectionMethod: metricExtensionQueryPropertiesCollectionMethod,
        arguments: metricExtensionQueryPropertiesArguments,
        autoRowPrefix: metricExtensionQueryPropertiesAutoRowPrefix,
        command: metricExtensionQueryPropertiesCommand,
        delimiter: metricExtensionQueryPropertiesDelimiter,
        identityMetric: metricExtensionQueryPropertiesIdentityMetric,
        inParamDetails: [{
            inParamPosition: metricExtensionQueryPropertiesInParamDetailsInParamPosition,
            inParamValue: metricExtensionQueryPropertiesInParamDetailsInParamValue,
        }],
        isMetricServiceEnabled: metricExtensionQueryPropertiesIsMetricServiceEnabled,
        jmxAttributes: metricExtensionQueryPropertiesJmxAttributes,
        managedBeanQuery: metricExtensionQueryPropertiesManagedBeanQuery,
        outParamDetails: {
            outParamName: metricExtensionQueryPropertiesOutParamDetailsOutParamName,
            outParamPosition: metricExtensionQueryPropertiesOutParamDetailsOutParamPosition,
            outParamType: metricExtensionQueryPropertiesOutParamDetailsOutParamType,
        },
        protocolType: metricExtensionQueryPropertiesProtocolType,
        responseContentType: metricExtensionQueryPropertiesResponseContentType,
        scriptDetails: {
            content: metricExtensionQueryPropertiesScriptDetailsContent,
            name: metricExtensionQueryPropertiesScriptDetailsName,
        },
        sqlDetails: {
            content: metricExtensionQueryPropertiesSqlDetailsContent,
            scriptFileName: metricExtensionQueryPropertiesSqlDetailsScriptFileName,
        },
        sqlType: metricExtensionQueryPropertiesSqlType,
        startsWith: metricExtensionQueryPropertiesStartsWith,
        url: metricExtensionQueryPropertiesUrl,
    },
    resourceType: metricExtensionResourceType,
    description: metricExtensionDescription,
});
Copy
import pulumi
import pulumi_oci as oci

test_metric_extension = oci.stack_monitoring.MetricExtension("test_metric_extension",
    collection_recurrences=metric_extension_collection_recurrences,
    compartment_id=compartment_id,
    display_name=metric_extension_display_name,
    metric_lists=[{
        "data_type": metric_extension_metric_list_data_type,
        "name": metric_extension_metric_list_name,
        "compute_expression": metric_extension_metric_list_compute_expression,
        "display_name": metric_extension_metric_list_display_name,
        "is_dimension": metric_extension_metric_list_is_dimension,
        "is_hidden": metric_extension_metric_list_is_hidden,
        "metric_category": metric_extension_metric_list_metric_category,
        "unit": metric_extension_metric_list_unit,
    }],
    name=metric_extension_name,
    query_properties={
        "collection_method": metric_extension_query_properties_collection_method,
        "arguments": metric_extension_query_properties_arguments,
        "auto_row_prefix": metric_extension_query_properties_auto_row_prefix,
        "command": metric_extension_query_properties_command,
        "delimiter": metric_extension_query_properties_delimiter,
        "identity_metric": metric_extension_query_properties_identity_metric,
        "in_param_details": [{
            "in_param_position": metric_extension_query_properties_in_param_details_in_param_position,
            "in_param_value": metric_extension_query_properties_in_param_details_in_param_value,
        }],
        "is_metric_service_enabled": metric_extension_query_properties_is_metric_service_enabled,
        "jmx_attributes": metric_extension_query_properties_jmx_attributes,
        "managed_bean_query": metric_extension_query_properties_managed_bean_query,
        "out_param_details": {
            "out_param_name": metric_extension_query_properties_out_param_details_out_param_name,
            "out_param_position": metric_extension_query_properties_out_param_details_out_param_position,
            "out_param_type": metric_extension_query_properties_out_param_details_out_param_type,
        },
        "protocol_type": metric_extension_query_properties_protocol_type,
        "response_content_type": metric_extension_query_properties_response_content_type,
        "script_details": {
            "content": metric_extension_query_properties_script_details_content,
            "name": metric_extension_query_properties_script_details_name,
        },
        "sql_details": {
            "content": metric_extension_query_properties_sql_details_content,
            "script_file_name": metric_extension_query_properties_sql_details_script_file_name,
        },
        "sql_type": metric_extension_query_properties_sql_type,
        "starts_with": metric_extension_query_properties_starts_with,
        "url": metric_extension_query_properties_url,
    },
    resource_type=metric_extension_resource_type,
    description=metric_extension_description)
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.NewMetricExtension(ctx, "test_metric_extension", &stackmonitoring.MetricExtensionArgs{
			CollectionRecurrences: pulumi.Any(metricExtensionCollectionRecurrences),
			CompartmentId:         pulumi.Any(compartmentId),
			DisplayName:           pulumi.Any(metricExtensionDisplayName),
			MetricLists: stackmonitoring.MetricExtensionMetricListArray{
				&stackmonitoring.MetricExtensionMetricListArgs{
					DataType:          pulumi.Any(metricExtensionMetricListDataType),
					Name:              pulumi.Any(metricExtensionMetricListName),
					ComputeExpression: pulumi.Any(metricExtensionMetricListComputeExpression),
					DisplayName:       pulumi.Any(metricExtensionMetricListDisplayName),
					IsDimension:       pulumi.Any(metricExtensionMetricListIsDimension),
					IsHidden:          pulumi.Any(metricExtensionMetricListIsHidden),
					MetricCategory:    pulumi.Any(metricExtensionMetricListMetricCategory),
					Unit:              pulumi.Any(metricExtensionMetricListUnit),
				},
			},
			Name: pulumi.Any(metricExtensionName),
			QueryProperties: &stackmonitoring.MetricExtensionQueryPropertiesArgs{
				CollectionMethod: pulumi.Any(metricExtensionQueryPropertiesCollectionMethod),
				Arguments:        pulumi.Any(metricExtensionQueryPropertiesArguments),
				AutoRowPrefix:    pulumi.Any(metricExtensionQueryPropertiesAutoRowPrefix),
				Command:          pulumi.Any(metricExtensionQueryPropertiesCommand),
				Delimiter:        pulumi.Any(metricExtensionQueryPropertiesDelimiter),
				IdentityMetric:   pulumi.Any(metricExtensionQueryPropertiesIdentityMetric),
				InParamDetails: stackmonitoring.MetricExtensionQueryPropertiesInParamDetailArray{
					&stackmonitoring.MetricExtensionQueryPropertiesInParamDetailArgs{
						InParamPosition: pulumi.Any(metricExtensionQueryPropertiesInParamDetailsInParamPosition),
						InParamValue:    pulumi.Any(metricExtensionQueryPropertiesInParamDetailsInParamValue),
					},
				},
				IsMetricServiceEnabled: pulumi.Any(metricExtensionQueryPropertiesIsMetricServiceEnabled),
				JmxAttributes:          pulumi.Any(metricExtensionQueryPropertiesJmxAttributes),
				ManagedBeanQuery:       pulumi.Any(metricExtensionQueryPropertiesManagedBeanQuery),
				OutParamDetails: &stackmonitoring.MetricExtensionQueryPropertiesOutParamDetailsArgs{
					OutParamName:     pulumi.Any(metricExtensionQueryPropertiesOutParamDetailsOutParamName),
					OutParamPosition: pulumi.Any(metricExtensionQueryPropertiesOutParamDetailsOutParamPosition),
					OutParamType:     pulumi.Any(metricExtensionQueryPropertiesOutParamDetailsOutParamType),
				},
				ProtocolType:        pulumi.Any(metricExtensionQueryPropertiesProtocolType),
				ResponseContentType: pulumi.Any(metricExtensionQueryPropertiesResponseContentType),
				ScriptDetails: &stackmonitoring.MetricExtensionQueryPropertiesScriptDetailsArgs{
					Content: pulumi.Any(metricExtensionQueryPropertiesScriptDetailsContent),
					Name:    pulumi.Any(metricExtensionQueryPropertiesScriptDetailsName),
				},
				SqlDetails: &stackmonitoring.MetricExtensionQueryPropertiesSqlDetailsArgs{
					Content:        pulumi.Any(metricExtensionQueryPropertiesSqlDetailsContent),
					ScriptFileName: pulumi.Any(metricExtensionQueryPropertiesSqlDetailsScriptFileName),
				},
				SqlType:    pulumi.Any(metricExtensionQueryPropertiesSqlType),
				StartsWith: pulumi.Any(metricExtensionQueryPropertiesStartsWith),
				Url:        pulumi.Any(metricExtensionQueryPropertiesUrl),
			},
			ResourceType: pulumi.Any(metricExtensionResourceType),
			Description:  pulumi.Any(metricExtensionDescription),
		})
		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 testMetricExtension = new Oci.StackMonitoring.MetricExtension("test_metric_extension", new()
    {
        CollectionRecurrences = metricExtensionCollectionRecurrences,
        CompartmentId = compartmentId,
        DisplayName = metricExtensionDisplayName,
        MetricLists = new[]
        {
            new Oci.StackMonitoring.Inputs.MetricExtensionMetricListArgs
            {
                DataType = metricExtensionMetricListDataType,
                Name = metricExtensionMetricListName,
                ComputeExpression = metricExtensionMetricListComputeExpression,
                DisplayName = metricExtensionMetricListDisplayName,
                IsDimension = metricExtensionMetricListIsDimension,
                IsHidden = metricExtensionMetricListIsHidden,
                MetricCategory = metricExtensionMetricListMetricCategory,
                Unit = metricExtensionMetricListUnit,
            },
        },
        Name = metricExtensionName,
        QueryProperties = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesArgs
        {
            CollectionMethod = metricExtensionQueryPropertiesCollectionMethod,
            Arguments = metricExtensionQueryPropertiesArguments,
            AutoRowPrefix = metricExtensionQueryPropertiesAutoRowPrefix,
            Command = metricExtensionQueryPropertiesCommand,
            Delimiter = metricExtensionQueryPropertiesDelimiter,
            IdentityMetric = metricExtensionQueryPropertiesIdentityMetric,
            InParamDetails = new[]
            {
                new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesInParamDetailArgs
                {
                    InParamPosition = metricExtensionQueryPropertiesInParamDetailsInParamPosition,
                    InParamValue = metricExtensionQueryPropertiesInParamDetailsInParamValue,
                },
            },
            IsMetricServiceEnabled = metricExtensionQueryPropertiesIsMetricServiceEnabled,
            JmxAttributes = metricExtensionQueryPropertiesJmxAttributes,
            ManagedBeanQuery = metricExtensionQueryPropertiesManagedBeanQuery,
            OutParamDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesOutParamDetailsArgs
            {
                OutParamName = metricExtensionQueryPropertiesOutParamDetailsOutParamName,
                OutParamPosition = metricExtensionQueryPropertiesOutParamDetailsOutParamPosition,
                OutParamType = metricExtensionQueryPropertiesOutParamDetailsOutParamType,
            },
            ProtocolType = metricExtensionQueryPropertiesProtocolType,
            ResponseContentType = metricExtensionQueryPropertiesResponseContentType,
            ScriptDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesScriptDetailsArgs
            {
                Content = metricExtensionQueryPropertiesScriptDetailsContent,
                Name = metricExtensionQueryPropertiesScriptDetailsName,
            },
            SqlDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesSqlDetailsArgs
            {
                Content = metricExtensionQueryPropertiesSqlDetailsContent,
                ScriptFileName = metricExtensionQueryPropertiesSqlDetailsScriptFileName,
            },
            SqlType = metricExtensionQueryPropertiesSqlType,
            StartsWith = metricExtensionQueryPropertiesStartsWith,
            Url = metricExtensionQueryPropertiesUrl,
        },
        ResourceType = metricExtensionResourceType,
        Description = metricExtensionDescription,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.StackMonitoring.MetricExtension;
import com.pulumi.oci.StackMonitoring.MetricExtensionArgs;
import com.pulumi.oci.StackMonitoring.inputs.MetricExtensionMetricListArgs;
import com.pulumi.oci.StackMonitoring.inputs.MetricExtensionQueryPropertiesArgs;
import com.pulumi.oci.StackMonitoring.inputs.MetricExtensionQueryPropertiesOutParamDetailsArgs;
import com.pulumi.oci.StackMonitoring.inputs.MetricExtensionQueryPropertiesScriptDetailsArgs;
import com.pulumi.oci.StackMonitoring.inputs.MetricExtensionQueryPropertiesSqlDetailsArgs;
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) {
        var testMetricExtension = new MetricExtension("testMetricExtension", MetricExtensionArgs.builder()
            .collectionRecurrences(metricExtensionCollectionRecurrences)
            .compartmentId(compartmentId)
            .displayName(metricExtensionDisplayName)
            .metricLists(MetricExtensionMetricListArgs.builder()
                .dataType(metricExtensionMetricListDataType)
                .name(metricExtensionMetricListName)
                .computeExpression(metricExtensionMetricListComputeExpression)
                .displayName(metricExtensionMetricListDisplayName)
                .isDimension(metricExtensionMetricListIsDimension)
                .isHidden(metricExtensionMetricListIsHidden)
                .metricCategory(metricExtensionMetricListMetricCategory)
                .unit(metricExtensionMetricListUnit)
                .build())
            .name(metricExtensionName)
            .queryProperties(MetricExtensionQueryPropertiesArgs.builder()
                .collectionMethod(metricExtensionQueryPropertiesCollectionMethod)
                .arguments(metricExtensionQueryPropertiesArguments)
                .autoRowPrefix(metricExtensionQueryPropertiesAutoRowPrefix)
                .command(metricExtensionQueryPropertiesCommand)
                .delimiter(metricExtensionQueryPropertiesDelimiter)
                .identityMetric(metricExtensionQueryPropertiesIdentityMetric)
                .inParamDetails(MetricExtensionQueryPropertiesInParamDetailArgs.builder()
                    .inParamPosition(metricExtensionQueryPropertiesInParamDetailsInParamPosition)
                    .inParamValue(metricExtensionQueryPropertiesInParamDetailsInParamValue)
                    .build())
                .isMetricServiceEnabled(metricExtensionQueryPropertiesIsMetricServiceEnabled)
                .jmxAttributes(metricExtensionQueryPropertiesJmxAttributes)
                .managedBeanQuery(metricExtensionQueryPropertiesManagedBeanQuery)
                .outParamDetails(MetricExtensionQueryPropertiesOutParamDetailsArgs.builder()
                    .outParamName(metricExtensionQueryPropertiesOutParamDetailsOutParamName)
                    .outParamPosition(metricExtensionQueryPropertiesOutParamDetailsOutParamPosition)
                    .outParamType(metricExtensionQueryPropertiesOutParamDetailsOutParamType)
                    .build())
                .protocolType(metricExtensionQueryPropertiesProtocolType)
                .responseContentType(metricExtensionQueryPropertiesResponseContentType)
                .scriptDetails(MetricExtensionQueryPropertiesScriptDetailsArgs.builder()
                    .content(metricExtensionQueryPropertiesScriptDetailsContent)
                    .name(metricExtensionQueryPropertiesScriptDetailsName)
                    .build())
                .sqlDetails(MetricExtensionQueryPropertiesSqlDetailsArgs.builder()
                    .content(metricExtensionQueryPropertiesSqlDetailsContent)
                    .scriptFileName(metricExtensionQueryPropertiesSqlDetailsScriptFileName)
                    .build())
                .sqlType(metricExtensionQueryPropertiesSqlType)
                .startsWith(metricExtensionQueryPropertiesStartsWith)
                .url(metricExtensionQueryPropertiesUrl)
                .build())
            .resourceType(metricExtensionResourceType)
            .description(metricExtensionDescription)
            .build());

    }
}
Copy
resources:
  testMetricExtension:
    type: oci:StackMonitoring:MetricExtension
    name: test_metric_extension
    properties:
      collectionRecurrences: ${metricExtensionCollectionRecurrences}
      compartmentId: ${compartmentId}
      displayName: ${metricExtensionDisplayName}
      metricLists:
        - dataType: ${metricExtensionMetricListDataType}
          name: ${metricExtensionMetricListName}
          computeExpression: ${metricExtensionMetricListComputeExpression}
          displayName: ${metricExtensionMetricListDisplayName}
          isDimension: ${metricExtensionMetricListIsDimension}
          isHidden: ${metricExtensionMetricListIsHidden}
          metricCategory: ${metricExtensionMetricListMetricCategory}
          unit: ${metricExtensionMetricListUnit}
      name: ${metricExtensionName}
      queryProperties:
        collectionMethod: ${metricExtensionQueryPropertiesCollectionMethod}
        arguments: ${metricExtensionQueryPropertiesArguments}
        autoRowPrefix: ${metricExtensionQueryPropertiesAutoRowPrefix}
        command: ${metricExtensionQueryPropertiesCommand}
        delimiter: ${metricExtensionQueryPropertiesDelimiter}
        identityMetric: ${metricExtensionQueryPropertiesIdentityMetric}
        inParamDetails:
          - inParamPosition: ${metricExtensionQueryPropertiesInParamDetailsInParamPosition}
            inParamValue: ${metricExtensionQueryPropertiesInParamDetailsInParamValue}
        isMetricServiceEnabled: ${metricExtensionQueryPropertiesIsMetricServiceEnabled}
        jmxAttributes: ${metricExtensionQueryPropertiesJmxAttributes}
        managedBeanQuery: ${metricExtensionQueryPropertiesManagedBeanQuery}
        outParamDetails:
          outParamName: ${metricExtensionQueryPropertiesOutParamDetailsOutParamName}
          outParamPosition: ${metricExtensionQueryPropertiesOutParamDetailsOutParamPosition}
          outParamType: ${metricExtensionQueryPropertiesOutParamDetailsOutParamType}
        protocolType: ${metricExtensionQueryPropertiesProtocolType}
        responseContentType: ${metricExtensionQueryPropertiesResponseContentType}
        scriptDetails:
          content: ${metricExtensionQueryPropertiesScriptDetailsContent}
          name: ${metricExtensionQueryPropertiesScriptDetailsName}
        sqlDetails:
          content: ${metricExtensionQueryPropertiesSqlDetailsContent}
          scriptFileName: ${metricExtensionQueryPropertiesSqlDetailsScriptFileName}
        sqlType: ${metricExtensionQueryPropertiesSqlType}
        startsWith: ${metricExtensionQueryPropertiesStartsWith}
        url: ${metricExtensionQueryPropertiesUrl}
      resourceType: ${metricExtensionResourceType}
      description: ${metricExtensionDescription}
Copy

Create MetricExtension Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MetricExtension(name: string, args: MetricExtensionArgs, opts?: CustomResourceOptions);
@overload
def MetricExtension(resource_name: str,
                    args: MetricExtensionArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def MetricExtension(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    collection_recurrences: Optional[str] = None,
                    compartment_id: Optional[str] = None,
                    display_name: Optional[str] = None,
                    metric_lists: Optional[Sequence[_stackmonitoring.MetricExtensionMetricListArgs]] = None,
                    query_properties: Optional[_stackmonitoring.MetricExtensionQueryPropertiesArgs] = None,
                    resource_type: Optional[str] = None,
                    description: Optional[str] = None,
                    name: Optional[str] = None,
                    publish_trigger: Optional[bool] = None)
func NewMetricExtension(ctx *Context, name string, args MetricExtensionArgs, opts ...ResourceOption) (*MetricExtension, error)
public MetricExtension(string name, MetricExtensionArgs args, CustomResourceOptions? opts = null)
public MetricExtension(String name, MetricExtensionArgs args)
public MetricExtension(String name, MetricExtensionArgs args, CustomResourceOptions options)

type: oci:StackMonitoring:MetricExtension
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MetricExtensionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MetricExtensionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MetricExtensionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MetricExtensionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MetricExtensionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var metricExtensionResource = new Oci.StackMonitoring.MetricExtension("metricExtensionResource", new()
{
    CollectionRecurrences = "string",
    CompartmentId = "string",
    DisplayName = "string",
    MetricLists = new[]
    {
        new Oci.StackMonitoring.Inputs.MetricExtensionMetricListArgs
        {
            DataType = "string",
            Name = "string",
            ComputeExpression = "string",
            DisplayName = "string",
            IsDimension = false,
            IsHidden = false,
            MetricCategory = "string",
            Unit = "string",
        },
    },
    QueryProperties = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesArgs
    {
        CollectionMethod = "string",
        JmxAttributes = "string",
        OutParamDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesOutParamDetailsArgs
        {
            OutParamPosition = 0,
            OutParamType = "string",
            OutParamName = "string",
        },
        Command = "string",
        Delimiter = "string",
        IdentityMetric = "string",
        InParamDetails = new[]
        {
            new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesInParamDetailArgs
            {
                InParamPosition = 0,
                InParamValue = "string",
            },
        },
        IsMetricServiceEnabled = false,
        Arguments = "string",
        AutoRowPrefix = "string",
        ProtocolType = "string",
        ManagedBeanQuery = "string",
        ResponseContentType = "string",
        ScriptDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesScriptDetailsArgs
        {
            Content = "string",
            Name = "string",
        },
        SqlDetails = new Oci.StackMonitoring.Inputs.MetricExtensionQueryPropertiesSqlDetailsArgs
        {
            Content = "string",
            ScriptFileName = "string",
        },
        SqlType = "string",
        StartsWith = "string",
        Url = "string",
    },
    ResourceType = "string",
    Description = "string",
    Name = "string",
    PublishTrigger = false,
});
Copy
example, err := StackMonitoring.NewMetricExtension(ctx, "metricExtensionResource", &StackMonitoring.MetricExtensionArgs{
	CollectionRecurrences: pulumi.String("string"),
	CompartmentId:         pulumi.String("string"),
	DisplayName:           pulumi.String("string"),
	MetricLists: stackmonitoring.MetricExtensionMetricListArray{
		&stackmonitoring.MetricExtensionMetricListArgs{
			DataType:          pulumi.String("string"),
			Name:              pulumi.String("string"),
			ComputeExpression: pulumi.String("string"),
			DisplayName:       pulumi.String("string"),
			IsDimension:       pulumi.Bool(false),
			IsHidden:          pulumi.Bool(false),
			MetricCategory:    pulumi.String("string"),
			Unit:              pulumi.String("string"),
		},
	},
	QueryProperties: &stackmonitoring.MetricExtensionQueryPropertiesArgs{
		CollectionMethod: pulumi.String("string"),
		JmxAttributes:    pulumi.String("string"),
		OutParamDetails: &stackmonitoring.MetricExtensionQueryPropertiesOutParamDetailsArgs{
			OutParamPosition: pulumi.Int(0),
			OutParamType:     pulumi.String("string"),
			OutParamName:     pulumi.String("string"),
		},
		Command:        pulumi.String("string"),
		Delimiter:      pulumi.String("string"),
		IdentityMetric: pulumi.String("string"),
		InParamDetails: stackmonitoring.MetricExtensionQueryPropertiesInParamDetailArray{
			&stackmonitoring.MetricExtensionQueryPropertiesInParamDetailArgs{
				InParamPosition: pulumi.Int(0),
				InParamValue:    pulumi.String("string"),
			},
		},
		IsMetricServiceEnabled: pulumi.Bool(false),
		Arguments:              pulumi.String("string"),
		AutoRowPrefix:          pulumi.String("string"),
		ProtocolType:           pulumi.String("string"),
		ManagedBeanQuery:       pulumi.String("string"),
		ResponseContentType:    pulumi.String("string"),
		ScriptDetails: &stackmonitoring.MetricExtensionQueryPropertiesScriptDetailsArgs{
			Content: pulumi.String("string"),
			Name:    pulumi.String("string"),
		},
		SqlDetails: &stackmonitoring.MetricExtensionQueryPropertiesSqlDetailsArgs{
			Content:        pulumi.String("string"),
			ScriptFileName: pulumi.String("string"),
		},
		SqlType:    pulumi.String("string"),
		StartsWith: pulumi.String("string"),
		Url:        pulumi.String("string"),
	},
	ResourceType:   pulumi.String("string"),
	Description:    pulumi.String("string"),
	Name:           pulumi.String("string"),
	PublishTrigger: pulumi.Bool(false),
})
Copy
var metricExtensionResource = new MetricExtension("metricExtensionResource", MetricExtensionArgs.builder()
    .collectionRecurrences("string")
    .compartmentId("string")
    .displayName("string")
    .metricLists(MetricExtensionMetricListArgs.builder()
        .dataType("string")
        .name("string")
        .computeExpression("string")
        .displayName("string")
        .isDimension(false)
        .isHidden(false)
        .metricCategory("string")
        .unit("string")
        .build())
    .queryProperties(MetricExtensionQueryPropertiesArgs.builder()
        .collectionMethod("string")
        .jmxAttributes("string")
        .outParamDetails(MetricExtensionQueryPropertiesOutParamDetailsArgs.builder()
            .outParamPosition(0)
            .outParamType("string")
            .outParamName("string")
            .build())
        .command("string")
        .delimiter("string")
        .identityMetric("string")
        .inParamDetails(MetricExtensionQueryPropertiesInParamDetailArgs.builder()
            .inParamPosition(0)
            .inParamValue("string")
            .build())
        .isMetricServiceEnabled(false)
        .arguments("string")
        .autoRowPrefix("string")
        .protocolType("string")
        .managedBeanQuery("string")
        .responseContentType("string")
        .scriptDetails(MetricExtensionQueryPropertiesScriptDetailsArgs.builder()
            .content("string")
            .name("string")
            .build())
        .sqlDetails(MetricExtensionQueryPropertiesSqlDetailsArgs.builder()
            .content("string")
            .scriptFileName("string")
            .build())
        .sqlType("string")
        .startsWith("string")
        .url("string")
        .build())
    .resourceType("string")
    .description("string")
    .name("string")
    .publishTrigger(false)
    .build());
Copy
metric_extension_resource = oci.stack_monitoring.MetricExtension("metricExtensionResource",
    collection_recurrences="string",
    compartment_id="string",
    display_name="string",
    metric_lists=[{
        "data_type": "string",
        "name": "string",
        "compute_expression": "string",
        "display_name": "string",
        "is_dimension": False,
        "is_hidden": False,
        "metric_category": "string",
        "unit": "string",
    }],
    query_properties={
        "collection_method": "string",
        "jmx_attributes": "string",
        "out_param_details": {
            "out_param_position": 0,
            "out_param_type": "string",
            "out_param_name": "string",
        },
        "command": "string",
        "delimiter": "string",
        "identity_metric": "string",
        "in_param_details": [{
            "in_param_position": 0,
            "in_param_value": "string",
        }],
        "is_metric_service_enabled": False,
        "arguments": "string",
        "auto_row_prefix": "string",
        "protocol_type": "string",
        "managed_bean_query": "string",
        "response_content_type": "string",
        "script_details": {
            "content": "string",
            "name": "string",
        },
        "sql_details": {
            "content": "string",
            "script_file_name": "string",
        },
        "sql_type": "string",
        "starts_with": "string",
        "url": "string",
    },
    resource_type="string",
    description="string",
    name="string",
    publish_trigger=False)
Copy
const metricExtensionResource = new oci.stackmonitoring.MetricExtension("metricExtensionResource", {
    collectionRecurrences: "string",
    compartmentId: "string",
    displayName: "string",
    metricLists: [{
        dataType: "string",
        name: "string",
        computeExpression: "string",
        displayName: "string",
        isDimension: false,
        isHidden: false,
        metricCategory: "string",
        unit: "string",
    }],
    queryProperties: {
        collectionMethod: "string",
        jmxAttributes: "string",
        outParamDetails: {
            outParamPosition: 0,
            outParamType: "string",
            outParamName: "string",
        },
        command: "string",
        delimiter: "string",
        identityMetric: "string",
        inParamDetails: [{
            inParamPosition: 0,
            inParamValue: "string",
        }],
        isMetricServiceEnabled: false,
        arguments: "string",
        autoRowPrefix: "string",
        protocolType: "string",
        managedBeanQuery: "string",
        responseContentType: "string",
        scriptDetails: {
            content: "string",
            name: "string",
        },
        sqlDetails: {
            content: "string",
            scriptFileName: "string",
        },
        sqlType: "string",
        startsWith: "string",
        url: "string",
    },
    resourceType: "string",
    description: "string",
    name: "string",
    publishTrigger: false,
});
Copy
type: oci:StackMonitoring:MetricExtension
properties:
    collectionRecurrences: string
    compartmentId: string
    description: string
    displayName: string
    metricLists:
        - computeExpression: string
          dataType: string
          displayName: string
          isDimension: false
          isHidden: false
          metricCategory: string
          name: string
          unit: string
    name: string
    publishTrigger: false
    queryProperties:
        arguments: string
        autoRowPrefix: string
        collectionMethod: string
        command: string
        delimiter: string
        identityMetric: string
        inParamDetails:
            - inParamPosition: 0
              inParamValue: string
        isMetricServiceEnabled: false
        jmxAttributes: string
        managedBeanQuery: string
        outParamDetails:
            outParamName: string
            outParamPosition: 0
            outParamType: string
        protocolType: string
        responseContentType: string
        scriptDetails:
            content: string
            name: string
        sqlDetails:
            content: string
            scriptFileName: string
        sqlType: string
        startsWith: string
        url: string
    resourceType: string
Copy

MetricExtension Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MetricExtension resource accepts the following input properties:

CollectionRecurrences This property is required. string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
CompartmentId This property is required. string
(Updatable) Compartment Identifier OCID
DisplayName This property is required. string
(Updatable) Metric Extension display name.
MetricLists This property is required. List<MetricExtensionMetricList>
(Updatable) List of metrics which are part of this metric extension
QueryProperties This property is required. MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
ResourceType
This property is required.
Changes to this property will trigger replacement.
string
Resource type to which Metric Extension applies
Description string
(Updatable) Description of the metric extension.
Name Changes to this property will trigger replacement. string
Metric Extension Resource name.
PublishTrigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CollectionRecurrences This property is required. string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
CompartmentId This property is required. string
(Updatable) Compartment Identifier OCID
DisplayName This property is required. string
(Updatable) Metric Extension display name.
MetricLists This property is required. []MetricExtensionMetricListArgs
(Updatable) List of metrics which are part of this metric extension
QueryProperties This property is required. MetricExtensionQueryPropertiesArgs
(Updatable) Collection method and query properties details of metric extension
ResourceType
This property is required.
Changes to this property will trigger replacement.
string
Resource type to which Metric Extension applies
Description string
(Updatable) Description of the metric extension.
Name Changes to this property will trigger replacement. string
Metric Extension Resource name.
PublishTrigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

collectionRecurrences This property is required. String
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId This property is required. String
(Updatable) Compartment Identifier OCID
displayName This property is required. String
(Updatable) Metric Extension display name.
metricLists This property is required. List<MetricExtensionMetricList>
(Updatable) List of metrics which are part of this metric extension
queryProperties This property is required. MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
resourceType
This property is required.
Changes to this property will trigger replacement.
String
Resource type to which Metric Extension applies
description String
(Updatable) Description of the metric extension.
name Changes to this property will trigger replacement. String
Metric Extension Resource name.
publishTrigger Boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

collectionRecurrences This property is required. string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId This property is required. string
(Updatable) Compartment Identifier OCID
displayName This property is required. string
(Updatable) Metric Extension display name.
metricLists This property is required. MetricExtensionMetricList[]
(Updatable) List of metrics which are part of this metric extension
queryProperties This property is required. MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
resourceType
This property is required.
Changes to this property will trigger replacement.
string
Resource type to which Metric Extension applies
description string
(Updatable) Description of the metric extension.
name Changes to this property will trigger replacement. string
Metric Extension Resource name.
publishTrigger boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

collection_recurrences This property is required. str
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartment_id This property is required. str
(Updatable) Compartment Identifier OCID
display_name This property is required. str
(Updatable) Metric Extension display name.
metric_lists This property is required. Sequence[stackmonitoring.MetricExtensionMetricListArgs]
(Updatable) List of metrics which are part of this metric extension
query_properties This property is required. stackmonitoring.MetricExtensionQueryPropertiesArgs
(Updatable) Collection method and query properties details of metric extension
resource_type
This property is required.
Changes to this property will trigger replacement.
str
Resource type to which Metric Extension applies
description str
(Updatable) Description of the metric extension.
name Changes to this property will trigger replacement. str
Metric Extension Resource name.
publish_trigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

collectionRecurrences This property is required. String
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId This property is required. String
(Updatable) Compartment Identifier OCID
displayName This property is required. String
(Updatable) Metric Extension display name.
metricLists This property is required. List<Property Map>
(Updatable) List of metrics which are part of this metric extension
queryProperties This property is required. Property Map
(Updatable) Collection method and query properties details of metric extension
resourceType
This property is required.
Changes to this property will trigger replacement.
String
Resource type to which Metric Extension applies
description String
(Updatable) Description of the metric extension.
name Changes to this property will trigger replacement. String
Metric Extension Resource name.
publishTrigger Boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Outputs

All input properties are implicitly available as output properties. Additionally, the MetricExtension resource produces the following output properties:

CollectionMethod string
Type of possible collection methods.
CreatedBy string
Created by user
EnabledOnResources List<MetricExtensionEnabledOnResource>
List of resource details objects having resourceIds on which this metric extension is enabled.
EnabledOnResourcesCount int
Count of resources on which this metric extension is enabled.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedBy string
Last updated by user
ResourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
State string
The current lifecycle state of the metric extension
Status string
The current status of the metric extension i.e. whether it is Draft or Published
TenantId string
Tenant Identifier OCID
TimeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
TimeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
CollectionMethod string
Type of possible collection methods.
CreatedBy string
Created by user
EnabledOnResources []MetricExtensionEnabledOnResource
List of resource details objects having resourceIds on which this metric extension is enabled.
EnabledOnResourcesCount int
Count of resources on which this metric extension is enabled.
Id string
The provider-assigned unique ID for this managed resource.
LastUpdatedBy string
Last updated by user
ResourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
State string
The current lifecycle state of the metric extension
Status string
The current status of the metric extension i.e. whether it is Draft or Published
TenantId string
Tenant Identifier OCID
TimeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
TimeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod String
Type of possible collection methods.
createdBy String
Created by user
enabledOnResources List<MetricExtensionEnabledOnResource>
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount Integer
Count of resources on which this metric extension is enabled.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedBy String
Last updated by user
resourceUri String
The URI path that the user can do a GET on to access the metric extension metadata
state String
The current lifecycle state of the metric extension
status String
The current status of the metric extension i.e. whether it is Draft or Published
tenantId String
Tenant Identifier OCID
timeCreated String
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated String
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod string
Type of possible collection methods.
createdBy string
Created by user
enabledOnResources MetricExtensionEnabledOnResource[]
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount number
Count of resources on which this metric extension is enabled.
id string
The provider-assigned unique ID for this managed resource.
lastUpdatedBy string
Last updated by user
resourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
state string
The current lifecycle state of the metric extension
status string
The current status of the metric extension i.e. whether it is Draft or Published
tenantId string
Tenant Identifier OCID
timeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
collection_method str
Type of possible collection methods.
created_by str
Created by user
enabled_on_resources Sequence[stackmonitoring.MetricExtensionEnabledOnResource]
List of resource details objects having resourceIds on which this metric extension is enabled.
enabled_on_resources_count int
Count of resources on which this metric extension is enabled.
id str
The provider-assigned unique ID for this managed resource.
last_updated_by str
Last updated by user
resource_uri str
The URI path that the user can do a GET on to access the metric extension metadata
state str
The current lifecycle state of the metric extension
status str
The current status of the metric extension i.e. whether it is Draft or Published
tenant_id str
Tenant Identifier OCID
time_created str
Metric Extension creation time. An RFC3339 formatted datetime string.
time_updated str
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod String
Type of possible collection methods.
createdBy String
Created by user
enabledOnResources List<Property Map>
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount Number
Count of resources on which this metric extension is enabled.
id String
The provider-assigned unique ID for this managed resource.
lastUpdatedBy String
Last updated by user
resourceUri String
The URI path that the user can do a GET on to access the metric extension metadata
state String
The current lifecycle state of the metric extension
status String
The current status of the metric extension i.e. whether it is Draft or Published
tenantId String
Tenant Identifier OCID
timeCreated String
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated String
Metric Extension update time. An RFC3339 formatted datetime string.

Look up Existing MetricExtension Resource

Get an existing MetricExtension resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MetricExtensionState, opts?: CustomResourceOptions): MetricExtension
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collection_method: Optional[str] = None,
        collection_recurrences: Optional[str] = None,
        compartment_id: Optional[str] = None,
        created_by: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled_on_resources: Optional[Sequence[_stackmonitoring.MetricExtensionEnabledOnResourceArgs]] = None,
        enabled_on_resources_count: Optional[int] = None,
        last_updated_by: Optional[str] = None,
        metric_lists: Optional[Sequence[_stackmonitoring.MetricExtensionMetricListArgs]] = None,
        name: Optional[str] = None,
        publish_trigger: Optional[bool] = None,
        query_properties: Optional[_stackmonitoring.MetricExtensionQueryPropertiesArgs] = None,
        resource_type: Optional[str] = None,
        resource_uri: Optional[str] = None,
        state: Optional[str] = None,
        status: Optional[str] = None,
        tenant_id: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> MetricExtension
func GetMetricExtension(ctx *Context, name string, id IDInput, state *MetricExtensionState, opts ...ResourceOption) (*MetricExtension, error)
public static MetricExtension Get(string name, Input<string> id, MetricExtensionState? state, CustomResourceOptions? opts = null)
public static MetricExtension get(String name, Output<String> id, MetricExtensionState state, CustomResourceOptions options)
resources:  _:    type: oci:StackMonitoring:MetricExtension    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CollectionMethod string
Type of possible collection methods.
CollectionRecurrences string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
CompartmentId string
(Updatable) Compartment Identifier OCID
CreatedBy string
Created by user
Description string
(Updatable) Description of the metric extension.
DisplayName string
(Updatable) Metric Extension display name.
EnabledOnResources List<MetricExtensionEnabledOnResource>
List of resource details objects having resourceIds on which this metric extension is enabled.
EnabledOnResourcesCount int
Count of resources on which this metric extension is enabled.
LastUpdatedBy string
Last updated by user
MetricLists List<MetricExtensionMetricList>
(Updatable) List of metrics which are part of this metric extension
Name Changes to this property will trigger replacement. string
Metric Extension Resource name.
PublishTrigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

QueryProperties MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
ResourceType Changes to this property will trigger replacement. string
Resource type to which Metric Extension applies
ResourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
State string
The current lifecycle state of the metric extension
Status string
The current status of the metric extension i.e. whether it is Draft or Published
TenantId string
Tenant Identifier OCID
TimeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
TimeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
CollectionMethod string
Type of possible collection methods.
CollectionRecurrences string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
CompartmentId string
(Updatable) Compartment Identifier OCID
CreatedBy string
Created by user
Description string
(Updatable) Description of the metric extension.
DisplayName string
(Updatable) Metric Extension display name.
EnabledOnResources []MetricExtensionEnabledOnResourceArgs
List of resource details objects having resourceIds on which this metric extension is enabled.
EnabledOnResourcesCount int
Count of resources on which this metric extension is enabled.
LastUpdatedBy string
Last updated by user
MetricLists []MetricExtensionMetricListArgs
(Updatable) List of metrics which are part of this metric extension
Name Changes to this property will trigger replacement. string
Metric Extension Resource name.
PublishTrigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

QueryProperties MetricExtensionQueryPropertiesArgs
(Updatable) Collection method and query properties details of metric extension
ResourceType Changes to this property will trigger replacement. string
Resource type to which Metric Extension applies
ResourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
State string
The current lifecycle state of the metric extension
Status string
The current status of the metric extension i.e. whether it is Draft or Published
TenantId string
Tenant Identifier OCID
TimeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
TimeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod String
Type of possible collection methods.
collectionRecurrences String
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId String
(Updatable) Compartment Identifier OCID
createdBy String
Created by user
description String
(Updatable) Description of the metric extension.
displayName String
(Updatable) Metric Extension display name.
enabledOnResources List<MetricExtensionEnabledOnResource>
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount Integer
Count of resources on which this metric extension is enabled.
lastUpdatedBy String
Last updated by user
metricLists List<MetricExtensionMetricList>
(Updatable) List of metrics which are part of this metric extension
name Changes to this property will trigger replacement. String
Metric Extension Resource name.
publishTrigger Boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

queryProperties MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
resourceType Changes to this property will trigger replacement. String
Resource type to which Metric Extension applies
resourceUri String
The URI path that the user can do a GET on to access the metric extension metadata
state String
The current lifecycle state of the metric extension
status String
The current status of the metric extension i.e. whether it is Draft or Published
tenantId String
Tenant Identifier OCID
timeCreated String
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated String
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod string
Type of possible collection methods.
collectionRecurrences string
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId string
(Updatable) Compartment Identifier OCID
createdBy string
Created by user
description string
(Updatable) Description of the metric extension.
displayName string
(Updatable) Metric Extension display name.
enabledOnResources MetricExtensionEnabledOnResource[]
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount number
Count of resources on which this metric extension is enabled.
lastUpdatedBy string
Last updated by user
metricLists MetricExtensionMetricList[]
(Updatable) List of metrics which are part of this metric extension
name Changes to this property will trigger replacement. string
Metric Extension Resource name.
publishTrigger boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

queryProperties MetricExtensionQueryProperties
(Updatable) Collection method and query properties details of metric extension
resourceType Changes to this property will trigger replacement. string
Resource type to which Metric Extension applies
resourceUri string
The URI path that the user can do a GET on to access the metric extension metadata
state string
The current lifecycle state of the metric extension
status string
The current status of the metric extension i.e. whether it is Draft or Published
tenantId string
Tenant Identifier OCID
timeCreated string
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated string
Metric Extension update time. An RFC3339 formatted datetime string.
collection_method str
Type of possible collection methods.
collection_recurrences str
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartment_id str
(Updatable) Compartment Identifier OCID
created_by str
Created by user
description str
(Updatable) Description of the metric extension.
display_name str
(Updatable) Metric Extension display name.
enabled_on_resources Sequence[stackmonitoring.MetricExtensionEnabledOnResourceArgs]
List of resource details objects having resourceIds on which this metric extension is enabled.
enabled_on_resources_count int
Count of resources on which this metric extension is enabled.
last_updated_by str
Last updated by user
metric_lists Sequence[stackmonitoring.MetricExtensionMetricListArgs]
(Updatable) List of metrics which are part of this metric extension
name Changes to this property will trigger replacement. str
Metric Extension Resource name.
publish_trigger bool

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

query_properties stackmonitoring.MetricExtensionQueryPropertiesArgs
(Updatable) Collection method and query properties details of metric extension
resource_type Changes to this property will trigger replacement. str
Resource type to which Metric Extension applies
resource_uri str
The URI path that the user can do a GET on to access the metric extension metadata
state str
The current lifecycle state of the metric extension
status str
The current status of the metric extension i.e. whether it is Draft or Published
tenant_id str
Tenant Identifier OCID
time_created str
Metric Extension creation time. An RFC3339 formatted datetime string.
time_updated str
Metric Extension update time. An RFC3339 formatted datetime string.
collectionMethod String
Type of possible collection methods.
collectionRecurrences String
(Updatable) Schedule of metric extension should use RFC 5545 format i.e. recur-rule-part = "FREQ";INTERVAL where FREQ rule part identifies the type of recurrence rule. Valid values are "MINUTELY","HOURLY","DAILY" to specify repeating events based on an interval of a minute, an hour and a day or more. Example- FREQ=DAILY;INTERVAL=1
compartmentId String
(Updatable) Compartment Identifier OCID
createdBy String
Created by user
description String
(Updatable) Description of the metric extension.
displayName String
(Updatable) Metric Extension display name.
enabledOnResources List<Property Map>
List of resource details objects having resourceIds on which this metric extension is enabled.
enabledOnResourcesCount Number
Count of resources on which this metric extension is enabled.
lastUpdatedBy String
Last updated by user
metricLists List<Property Map>
(Updatable) List of metrics which are part of this metric extension
name Changes to this property will trigger replacement. String
Metric Extension Resource name.
publishTrigger Boolean

(Updatable) An optional property when set to true triggers Publish of a metric extension. Once set to true, it cannot be changed back to false. Update of publish_trigger cannot be combined with other updates in the same request. A metric extension cannot be tested and its definition cannot be updated once it is marked published or publish_trigger is updated to true.

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

queryProperties Property Map
(Updatable) Collection method and query properties details of metric extension
resourceType Changes to this property will trigger replacement. String
Resource type to which Metric Extension applies
resourceUri String
The URI path that the user can do a GET on to access the metric extension metadata
state String
The current lifecycle state of the metric extension
status String
The current status of the metric extension i.e. whether it is Draft or Published
tenantId String
Tenant Identifier OCID
timeCreated String
Metric Extension creation time. An RFC3339 formatted datetime string.
timeUpdated String
Metric Extension update time. An RFC3339 formatted datetime string.

Supporting Types

MetricExtensionEnabledOnResource
, MetricExtensionEnabledOnResourceArgs

ResourceId string
The OCID of the resource on which Metric Extension is enabled
ResourceId string
The OCID of the resource on which Metric Extension is enabled
resourceId String
The OCID of the resource on which Metric Extension is enabled
resourceId string
The OCID of the resource on which Metric Extension is enabled
resource_id str
The OCID of the resource on which Metric Extension is enabled
resourceId String
The OCID of the resource on which Metric Extension is enabled

MetricExtensionMetricList
, MetricExtensionMetricListArgs

DataType This property is required. string
(Updatable) Data type of value of this metric
Name This property is required. string
(Updatable) Name of the metric.
ComputeExpression string
(Updatable) Compute Expression to calculate the value of this metric
DisplayName string
(Updatable) Display name of the metric.
IsDimension bool
(Updatable) Current metric need to be included as dimension or not
IsHidden bool
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
MetricCategory string
(Updatable) Metric category
Unit string
(Updatable) Unit of metric value
DataType This property is required. string
(Updatable) Data type of value of this metric
Name This property is required. string
(Updatable) Name of the metric.
ComputeExpression string
(Updatable) Compute Expression to calculate the value of this metric
DisplayName string
(Updatable) Display name of the metric.
IsDimension bool
(Updatable) Current metric need to be included as dimension or not
IsHidden bool
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
MetricCategory string
(Updatable) Metric category
Unit string
(Updatable) Unit of metric value
dataType This property is required. String
(Updatable) Data type of value of this metric
name This property is required. String
(Updatable) Name of the metric.
computeExpression String
(Updatable) Compute Expression to calculate the value of this metric
displayName String
(Updatable) Display name of the metric.
isDimension Boolean
(Updatable) Current metric need to be included as dimension or not
isHidden Boolean
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
metricCategory String
(Updatable) Metric category
unit String
(Updatable) Unit of metric value
dataType This property is required. string
(Updatable) Data type of value of this metric
name This property is required. string
(Updatable) Name of the metric.
computeExpression string
(Updatable) Compute Expression to calculate the value of this metric
displayName string
(Updatable) Display name of the metric.
isDimension boolean
(Updatable) Current metric need to be included as dimension or not
isHidden boolean
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
metricCategory string
(Updatable) Metric category
unit string
(Updatable) Unit of metric value
data_type This property is required. str
(Updatable) Data type of value of this metric
name This property is required. str
(Updatable) Name of the metric.
compute_expression str
(Updatable) Compute Expression to calculate the value of this metric
display_name str
(Updatable) Display name of the metric.
is_dimension bool
(Updatable) Current metric need to be included as dimension or not
is_hidden bool
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
metric_category str
(Updatable) Metric category
unit str
(Updatable) Unit of metric value
dataType This property is required. String
(Updatable) Data type of value of this metric
name This property is required. String
(Updatable) Name of the metric.
computeExpression String
(Updatable) Compute Expression to calculate the value of this metric
displayName String
(Updatable) Display name of the metric.
isDimension Boolean
(Updatable) Current metric need to be included as dimension or not
isHidden Boolean
(Updatable) Flag to marks whether a metric has to be uploaded or not. When isHidden = false > Metric is uploaded, isHidden = true > Metric is NOT uploaded
metricCategory String
(Updatable) Metric category
unit String
(Updatable) Unit of metric value

MetricExtensionQueryProperties
, MetricExtensionQueryPropertiesArgs

CollectionMethod This property is required. string
(Updatable) Type of possible collection methods.
Arguments string
(Updatable) Arguments required by either command or script
AutoRowPrefix string
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
Command string
(Updatable) OS command to execute without arguments
Delimiter string
(Updatable) Character used to delimit multiple metric values in single line of output
IdentityMetric string
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
InParamDetails List<MetricExtensionQueryPropertiesInParamDetail>
(Updatable) List of values and position of PL/SQL procedure IN parameters
IsMetricServiceEnabled bool
(Updatable) Indicates if Metric Service is enabled on server domain
JmxAttributes string
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
ManagedBeanQuery string
(Updatable) JMX Managed Bean Query or Metric Service Table name
OutParamDetails MetricExtensionQueryPropertiesOutParamDetails
(Updatable) Position and SQL Type of PL/SQL OUT parameter
ProtocolType string
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
ResponseContentType string
(Updatable) Type of content response given by the http(s) URL
ScriptDetails MetricExtensionQueryPropertiesScriptDetails
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
SqlDetails MetricExtensionQueryPropertiesSqlDetails
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
SqlType string
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
StartsWith string
(Updatable) String prefix used to identify metric output of the OS Command
Url string
(Updatable) Http(s) end point URL
CollectionMethod This property is required. string
(Updatable) Type of possible collection methods.
Arguments string
(Updatable) Arguments required by either command or script
AutoRowPrefix string
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
Command string
(Updatable) OS command to execute without arguments
Delimiter string
(Updatable) Character used to delimit multiple metric values in single line of output
IdentityMetric string
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
InParamDetails []MetricExtensionQueryPropertiesInParamDetail
(Updatable) List of values and position of PL/SQL procedure IN parameters
IsMetricServiceEnabled bool
(Updatable) Indicates if Metric Service is enabled on server domain
JmxAttributes string
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
ManagedBeanQuery string
(Updatable) JMX Managed Bean Query or Metric Service Table name
OutParamDetails MetricExtensionQueryPropertiesOutParamDetails
(Updatable) Position and SQL Type of PL/SQL OUT parameter
ProtocolType string
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
ResponseContentType string
(Updatable) Type of content response given by the http(s) URL
ScriptDetails MetricExtensionQueryPropertiesScriptDetails
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
SqlDetails MetricExtensionQueryPropertiesSqlDetails
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
SqlType string
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
StartsWith string
(Updatable) String prefix used to identify metric output of the OS Command
Url string
(Updatable) Http(s) end point URL
collectionMethod This property is required. String
(Updatable) Type of possible collection methods.
arguments String
(Updatable) Arguments required by either command or script
autoRowPrefix String
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
command String
(Updatable) OS command to execute without arguments
delimiter String
(Updatable) Character used to delimit multiple metric values in single line of output
identityMetric String
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails List<MetricExtensionQueryPropertiesInParamDetail>
(Updatable) List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled Boolean
(Updatable) Indicates if Metric Service is enabled on server domain
jmxAttributes String
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery String
(Updatable) JMX Managed Bean Query or Metric Service Table name
outParamDetails MetricExtensionQueryPropertiesOutParamDetails
(Updatable) Position and SQL Type of PL/SQL OUT parameter
protocolType String
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
responseContentType String
(Updatable) Type of content response given by the http(s) URL
scriptDetails MetricExtensionQueryPropertiesScriptDetails
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
sqlDetails MetricExtensionQueryPropertiesSqlDetails
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
sqlType String
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith String
(Updatable) String prefix used to identify metric output of the OS Command
url String
(Updatable) Http(s) end point URL
collectionMethod This property is required. string
(Updatable) Type of possible collection methods.
arguments string
(Updatable) Arguments required by either command or script
autoRowPrefix string
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
command string
(Updatable) OS command to execute without arguments
delimiter string
(Updatable) Character used to delimit multiple metric values in single line of output
identityMetric string
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails MetricExtensionQueryPropertiesInParamDetail[]
(Updatable) List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled boolean
(Updatable) Indicates if Metric Service is enabled on server domain
jmxAttributes string
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery string
(Updatable) JMX Managed Bean Query or Metric Service Table name
outParamDetails MetricExtensionQueryPropertiesOutParamDetails
(Updatable) Position and SQL Type of PL/SQL OUT parameter
protocolType string
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
responseContentType string
(Updatable) Type of content response given by the http(s) URL
scriptDetails MetricExtensionQueryPropertiesScriptDetails
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
sqlDetails MetricExtensionQueryPropertiesSqlDetails
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
sqlType string
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith string
(Updatable) String prefix used to identify metric output of the OS Command
url string
(Updatable) Http(s) end point URL
collection_method This property is required. str
(Updatable) Type of possible collection methods.
arguments str
(Updatable) Arguments required by either command or script
auto_row_prefix str
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
command str
(Updatable) OS command to execute without arguments
delimiter str
(Updatable) Character used to delimit multiple metric values in single line of output
identity_metric str
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
in_param_details Sequence[stackmonitoring.MetricExtensionQueryPropertiesInParamDetail]
(Updatable) List of values and position of PL/SQL procedure IN parameters
is_metric_service_enabled bool
(Updatable) Indicates if Metric Service is enabled on server domain
jmx_attributes str
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
managed_bean_query str
(Updatable) JMX Managed Bean Query or Metric Service Table name
out_param_details stackmonitoring.MetricExtensionQueryPropertiesOutParamDetails
(Updatable) Position and SQL Type of PL/SQL OUT parameter
protocol_type str
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
response_content_type str
(Updatable) Type of content response given by the http(s) URL
script_details stackmonitoring.MetricExtensionQueryPropertiesScriptDetails
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
sql_details stackmonitoring.MetricExtensionQueryPropertiesSqlDetails
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
sql_type str
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
starts_with str
(Updatable) String prefix used to identify metric output of the OS Command
url str
(Updatable) Http(s) end point URL
collectionMethod This property is required. String
(Updatable) Type of possible collection methods.
arguments String
(Updatable) Arguments required by either command or script
autoRowPrefix String
(Updatable) Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
command String
(Updatable) OS command to execute without arguments
delimiter String
(Updatable) Character used to delimit multiple metric values in single line of output
identityMetric String
(Updatable) Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails List<Property Map>
(Updatable) List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled Boolean
(Updatable) Indicates if Metric Service is enabled on server domain
jmxAttributes String
(Updatable) List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery String
(Updatable) JMX Managed Bean Query or Metric Service Table name
outParamDetails Property Map
(Updatable) Position and SQL Type of PL/SQL OUT parameter
protocolType String
(Updatable) Supported protocol of resources to be associated with this metric extension. This is optional and defaults to HTTPS, which uses secure connection to the URL
responseContentType String
(Updatable) Type of content response given by the http(s) URL
scriptDetails Property Map
(Updatable) Script details applicable to any OS Command/HTTP based Metric Extension which needs to run a script to collect data. For removing it during OS Command based Metric Extension update, set its "content" property to an empty string. In that case, "name" property value is ignored.
sqlDetails Property Map
(Updatable) Details of Sql content which needs to execute to collect Metric Extension data
sqlType String
(Updatable) Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith String
(Updatable) String prefix used to identify metric output of the OS Command
url String
(Updatable) Http(s) end point URL

MetricExtensionQueryPropertiesInParamDetail
, MetricExtensionQueryPropertiesInParamDetailArgs

InParamPosition This property is required. int
(Updatable) Position of IN parameter
InParamValue This property is required. string
(Updatable) Value of IN parameter
InParamPosition This property is required. int
(Updatable) Position of IN parameter
InParamValue This property is required. string
(Updatable) Value of IN parameter
inParamPosition This property is required. Integer
(Updatable) Position of IN parameter
inParamValue This property is required. String
(Updatable) Value of IN parameter
inParamPosition This property is required. number
(Updatable) Position of IN parameter
inParamValue This property is required. string
(Updatable) Value of IN parameter
in_param_position This property is required. int
(Updatable) Position of IN parameter
in_param_value This property is required. str
(Updatable) Value of IN parameter
inParamPosition This property is required. Number
(Updatable) Position of IN parameter
inParamValue This property is required. String
(Updatable) Value of IN parameter

MetricExtensionQueryPropertiesOutParamDetails
, MetricExtensionQueryPropertiesOutParamDetailsArgs

OutParamPosition This property is required. int
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
OutParamType This property is required. string
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
OutParamName string
(Updatable) Name of the Out Parameter
OutParamPosition This property is required. int
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
OutParamType This property is required. string
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
OutParamName string
(Updatable) Name of the Out Parameter
outParamPosition This property is required. Integer
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
outParamType This property is required. String
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
outParamName String
(Updatable) Name of the Out Parameter
outParamPosition This property is required. number
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
outParamType This property is required. string
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
outParamName string
(Updatable) Name of the Out Parameter
out_param_position This property is required. int
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
out_param_type This property is required. str
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
out_param_name str
(Updatable) Name of the Out Parameter
outParamPosition This property is required. Number
(Updatable) Position of PL/SQL procedure OUT parameter. The value of this property is ignored during update, if "outParamType" is set to NO_OUT_PARAM value.
outParamType This property is required. String
(Updatable) SQL Type of PL/SQL procedure OUT parameter. During the update, to completely remove the out parameter, use the value NO_OUT_PARAM. In that case, the value of "outParamPosition" will be ignored.
outParamName String
(Updatable) Name of the Out Parameter

MetricExtensionQueryPropertiesScriptDetails
, MetricExtensionQueryPropertiesScriptDetailsArgs

Content This property is required. string
(Updatable) Content of the script/JavaScript file as base64 encoded string
Name This property is required. string
(Updatable) Name of the script file
Content This property is required. string
(Updatable) Content of the script/JavaScript file as base64 encoded string
Name This property is required. string
(Updatable) Name of the script file
content This property is required. String
(Updatable) Content of the script/JavaScript file as base64 encoded string
name This property is required. String
(Updatable) Name of the script file
content This property is required. string
(Updatable) Content of the script/JavaScript file as base64 encoded string
name This property is required. string
(Updatable) Name of the script file
content This property is required. str
(Updatable) Content of the script/JavaScript file as base64 encoded string
name This property is required. str
(Updatable) Name of the script file
content This property is required. String
(Updatable) Content of the script/JavaScript file as base64 encoded string
name This property is required. String
(Updatable) Name of the script file

MetricExtensionQueryPropertiesSqlDetails
, MetricExtensionQueryPropertiesSqlDetailsArgs

Content This property is required. string
(Updatable) Sql statement or script file content as base64 encoded string
ScriptFileName string
(Updatable) If a script needs to be executed, then provide file name of the script
Content This property is required. string
(Updatable) Sql statement or script file content as base64 encoded string
ScriptFileName string
(Updatable) If a script needs to be executed, then provide file name of the script
content This property is required. String
(Updatable) Sql statement or script file content as base64 encoded string
scriptFileName String
(Updatable) If a script needs to be executed, then provide file name of the script
content This property is required. string
(Updatable) Sql statement or script file content as base64 encoded string
scriptFileName string
(Updatable) If a script needs to be executed, then provide file name of the script
content This property is required. str
(Updatable) Sql statement or script file content as base64 encoded string
script_file_name str
(Updatable) If a script needs to be executed, then provide file name of the script
content This property is required. String
(Updatable) Sql statement or script file content as base64 encoded string
scriptFileName String
(Updatable) If a script needs to be executed, then provide file name of the script

Import

MetricExtensions can be imported using the id, e.g.

$ pulumi import oci:StackMonitoring/metricExtension:MetricExtension test_metric_extension "id"
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.30.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-oci