Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.StackMonitoring.getMetricExtension

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

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

const testMetricExtension = oci.StackMonitoring.getMetricExtension({
    metricExtensionId: testMetricExtensionOciStackMonitoringMetricExtension.id,
});

import pulumi
import pulumi_oci as oci

test_metric_extension = oci.StackMonitoring.get_metric_extension(metric_extension_id=test_metric_extension_oci_stack_monitoring_metric_extension["id"])

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.GetMetricExtension(ctx, &stackmonitoring.GetMetricExtensionArgs{
			MetricExtensionId: testMetricExtensionOciStackMonitoringMetricExtension.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMetricExtension = Oci.StackMonitoring.GetMetricExtension.Invoke(new()
    {
        MetricExtensionId = testMetricExtensionOciStackMonitoringMetricExtension.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.StackMonitoring.StackMonitoringFunctions;
import com.pulumi.oci.StackMonitoring.inputs.GetMetricExtensionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testMetricExtension = StackMonitoringFunctions.getMetricExtension(GetMetricExtensionArgs.builder()
            .metricExtensionId(testMetricExtensionOciStackMonitoringMetricExtension.id())
            .build());

    }
}

variables:
  testMetricExtension:
    fn::invoke:
      function: oci:StackMonitoring:getMetricExtension
      arguments:
        metricExtensionId: ${testMetricExtensionOciStackMonitoringMetricExtension.id}

Using getMetricExtension

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMetricExtension(args: GetMetricExtensionArgs, opts?: InvokeOptions): Promise<GetMetricExtensionResult>
function getMetricExtensionOutput(args: GetMetricExtensionOutputArgs, opts?: InvokeOptions): Output<GetMetricExtensionResult>

def get_metric_extension(metric_extension_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetMetricExtensionResult
def get_metric_extension_output(metric_extension_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetMetricExtensionResult]

func GetMetricExtension(ctx *Context, args *GetMetricExtensionArgs, opts ...InvokeOption) (*GetMetricExtensionResult, error)
func GetMetricExtensionOutput(ctx *Context, args *GetMetricExtensionOutputArgs, opts ...InvokeOption) GetMetricExtensionResultOutput

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

public static class GetMetricExtension 
{
    public static Task<GetMetricExtensionResult> InvokeAsync(GetMetricExtensionArgs args, InvokeOptions? opts = null)
    public static Output<GetMetricExtensionResult> Invoke(GetMetricExtensionInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMetricExtensionResult> getMetricExtension(GetMetricExtensionArgs args, InvokeOptions options)
public static Output<GetMetricExtensionResult> getMetricExtension(GetMetricExtensionArgs args, InvokeOptions options)

fn::invoke:
  function: oci:StackMonitoring/getMetricExtension:getMetricExtension
  arguments:
    # arguments dictionary

The following arguments are supported:

MetricExtensionId string: The OCID of the metric extension resource.

MetricExtensionId string: The OCID of the metric extension resource.

metricExtensionId String: The OCID of the metric extension resource.

metricExtensionId string: The OCID of the metric extension resource.

metric_extension_id str: The OCID of the metric extension resource.

metricExtensionId String: The OCID of the metric extension resource.

getMetricExtension Result

The following output properties are available:

CollectionMethod string: Type of possible collection methods.
CollectionRecurrences string: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
CreatedBy string: Created by user
Description string: Description of the metric extension.
DisplayName string: Display name of the metric.
EnabledOnResources List<GetMetricExtensionEnabledOnResource>: 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 OCID of Metric Extension resource
LastUpdatedBy string: Last updated by user
MetricExtensionId string
MetricLists List<GetMetricExtensionMetricList>: List of metrics which are part of this metric extension
Name string: Name of the script file
PublishTrigger bool
QueryProperties List<GetMetricExtensionQueryProperty>: Collection method and query properties details of metric extension
ResourceType 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: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
CreatedBy string: Created by user
Description string: Description of the metric extension.
DisplayName string: Display name of the metric.
EnabledOnResources []GetMetricExtensionEnabledOnResource: 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 OCID of Metric Extension resource
LastUpdatedBy string: Last updated by user
MetricExtensionId string
MetricLists []GetMetricExtensionMetricList: List of metrics which are part of this metric extension
Name string: Name of the script file
PublishTrigger bool
QueryProperties []GetMetricExtensionQueryProperty: Collection method and query properties details of metric extension
ResourceType 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: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
createdBy String: Created by user
description String: Description of the metric extension.
displayName String: Display name of the metric.
enabledOnResources List<GetMetricExtensionEnabledOnResource>: 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 OCID of Metric Extension resource
lastUpdatedBy String: Last updated by user
metricExtensionId String
metricLists List<GetMetricExtensionMetricList>: List of metrics which are part of this metric extension
name String: Name of the script file
publishTrigger Boolean
queryProperties List<GetMetricExtensionQueryProperty>: Collection method and query properties details of metric extension
resourceType 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: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
createdBy string: Created by user
description string: Description of the metric extension.
displayName string: Display name of the metric.
enabledOnResources GetMetricExtensionEnabledOnResource[]: 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 OCID of Metric Extension resource
lastUpdatedBy string: Last updated by user
metricExtensionId string
metricLists GetMetricExtensionMetricList[]: List of metrics which are part of this metric extension
name string: Name of the script file
publishTrigger boolean
queryProperties GetMetricExtensionQueryProperty[]: Collection method and query properties details of metric extension
resourceType 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: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
created_by str: Created by user
description str: Description of the metric extension.
display_name str: Display name of the metric.
enabled_on_resources Sequence[stackmonitoring.GetMetricExtensionEnabledOnResource]: 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 OCID of Metric Extension resource
last_updated_by str: Last updated by user
metric_extension_id str
metric_lists Sequence[stackmonitoring.GetMetricExtensionMetricList]: List of metrics which are part of this metric extension
name str: Name of the script file
publish_trigger bool
query_properties Sequence[stackmonitoring.GetMetricExtensionQueryProperty]: Collection method and query properties details of metric extension
resource_type 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: Schedule of metric extension should use RFC 5545 format > 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: Compartment Identifier OCID
createdBy String: Created by user
description String: Description of the metric extension.
displayName String: Display name of the metric.
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 OCID of Metric Extension resource
lastUpdatedBy String: Last updated by user
metricExtensionId String
metricLists List<Property Map>: List of metrics which are part of this metric extension
name String: Name of the script file
publishTrigger Boolean
queryProperties List<Property Map>: Collection method and query properties details of metric extension
resourceType 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

GetMetricExtensionEnabledOnResource

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

GetMetricExtensionMetricList

ComputeExpression string: Compute Expression to calculate the value of this metric
DataType string: Data type of value of this metric
DisplayName string: Display name of the metric.
IsDimension bool: Current metric need to be included as dimension or not
IsHidden bool: 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: Metric category
Name string: Name of the script file
Unit string: Unit of metric value

ComputeExpression string: Compute Expression to calculate the value of this metric
DataType string: Data type of value of this metric
DisplayName string: Display name of the metric.
IsDimension bool: Current metric need to be included as dimension or not
IsHidden bool: 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: Metric category
Name string: Name of the script file
Unit string: Unit of metric value

computeExpression String: Compute Expression to calculate the value of this metric
dataType String: Data type of value of this metric
displayName String: Display name of the metric.
isDimension Boolean: Current metric need to be included as dimension or not
isHidden Boolean: 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: Metric category
name String: Name of the script file
unit String: Unit of metric value

computeExpression string: Compute Expression to calculate the value of this metric
dataType string: Data type of value of this metric
displayName string: Display name of the metric.
isDimension boolean: Current metric need to be included as dimension or not
isHidden boolean: 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: Metric category
name string: Name of the script file
unit string: Unit of metric value

compute_expression str: Compute Expression to calculate the value of this metric
data_type str: Data type of value of this metric
display_name str: Display name of the metric.
is_dimension bool: Current metric need to be included as dimension or not
is_hidden bool: 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: Metric category
name str: Name of the script file
unit str: Unit of metric value

computeExpression String: Compute Expression to calculate the value of this metric
dataType String: Data type of value of this metric
displayName String: Display name of the metric.
isDimension Boolean: Current metric need to be included as dimension or not
isHidden Boolean: 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: Metric category
name String: Name of the script file
unit String: Unit of metric value

GetMetricExtensionQueryProperty

Arguments string: Arguments required by either command or script
AutoRowPrefix string: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
CollectionMethod string: Type of possible collection methods.
Command string: OS command to execute without arguments
Delimiter string: Character used to delimit multiple metric values in single line of output
IdentityMetric string: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
InParamDetails List<GetMetricExtensionQueryPropertyInParamDetail>: List of values and position of PL/SQL procedure IN parameters
IsMetricServiceEnabled bool: Indicates if Metric Service is enabled on server domain
JmxAttributes string: List of JMX attributes or Metric Service Table columns separated by semi-colon
ManagedBeanQuery string: JMX Managed Bean Query or Metric Service Table name
OutParamDetails List<GetMetricExtensionQueryPropertyOutParamDetail>: Position and SQL Type of PL/SQL OUT parameter
ProtocolType string: 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: Type of content response given by the http(s) URL
ScriptDetails List<GetMetricExtensionQueryPropertyScriptDetail>: 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 List<GetMetricExtensionQueryPropertySqlDetail>: Details of Sql content which needs to execute to collect Metric Extension data
SqlType string: Type of SQL data collection method i.e. either a Statement or SQL Script File
StartsWith string: String prefix used to identify metric output of the OS Command
Url string: Http(s) end point URL

Arguments string: Arguments required by either command or script
AutoRowPrefix string: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
CollectionMethod string: Type of possible collection methods.
Command string: OS command to execute without arguments
Delimiter string: Character used to delimit multiple metric values in single line of output
IdentityMetric string: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
InParamDetails []GetMetricExtensionQueryPropertyInParamDetail: List of values and position of PL/SQL procedure IN parameters
IsMetricServiceEnabled bool: Indicates if Metric Service is enabled on server domain
JmxAttributes string: List of JMX attributes or Metric Service Table columns separated by semi-colon
ManagedBeanQuery string: JMX Managed Bean Query or Metric Service Table name
OutParamDetails []GetMetricExtensionQueryPropertyOutParamDetail: Position and SQL Type of PL/SQL OUT parameter
ProtocolType string: 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: Type of content response given by the http(s) URL
ScriptDetails []GetMetricExtensionQueryPropertyScriptDetail: 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 []GetMetricExtensionQueryPropertySqlDetail: Details of Sql content which needs to execute to collect Metric Extension data
SqlType string: Type of SQL data collection method i.e. either a Statement or SQL Script File
StartsWith string: String prefix used to identify metric output of the OS Command
Url string: Http(s) end point URL

arguments String: Arguments required by either command or script
autoRowPrefix String: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
collectionMethod String: Type of possible collection methods.
command String: OS command to execute without arguments
delimiter String: Character used to delimit multiple metric values in single line of output
identityMetric String: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails List<GetMetricExtensionQueryPropertyInParamDetail>: List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled Boolean: Indicates if Metric Service is enabled on server domain
jmxAttributes String: List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery String: JMX Managed Bean Query or Metric Service Table name
outParamDetails List<GetMetricExtensionQueryPropertyOutParamDetail>: Position and SQL Type of PL/SQL OUT parameter
protocolType String: 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: Type of content response given by the http(s) URL
scriptDetails List<GetMetricExtensionQueryPropertyScriptDetail>: 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 List<GetMetricExtensionQueryPropertySqlDetail>: Details of Sql content which needs to execute to collect Metric Extension data
sqlType String: Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith String: String prefix used to identify metric output of the OS Command
url String: Http(s) end point URL

arguments string: Arguments required by either command or script
autoRowPrefix string: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
collectionMethod string: Type of possible collection methods.
command string: OS command to execute without arguments
delimiter string: Character used to delimit multiple metric values in single line of output
identityMetric string: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails GetMetricExtensionQueryPropertyInParamDetail[]: List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled boolean: Indicates if Metric Service is enabled on server domain
jmxAttributes string: List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery string: JMX Managed Bean Query or Metric Service Table name
outParamDetails GetMetricExtensionQueryPropertyOutParamDetail[]: Position and SQL Type of PL/SQL OUT parameter
protocolType string: 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: Type of content response given by the http(s) URL
scriptDetails GetMetricExtensionQueryPropertyScriptDetail[]: 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 GetMetricExtensionQueryPropertySqlDetail[]: Details of Sql content which needs to execute to collect Metric Extension data
sqlType string: Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith string: String prefix used to identify metric output of the OS Command
url string: Http(s) end point URL

arguments str: Arguments required by either command or script
auto_row_prefix str: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
collection_method str: Type of possible collection methods.
command str: OS command to execute without arguments
delimiter str: Character used to delimit multiple metric values in single line of output
identity_metric str: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
in_param_details Sequence[stackmonitoring.GetMetricExtensionQueryPropertyInParamDetail]: List of values and position of PL/SQL procedure IN parameters
is_metric_service_enabled bool: Indicates if Metric Service is enabled on server domain
jmx_attributes str: List of JMX attributes or Metric Service Table columns separated by semi-colon
managed_bean_query str: JMX Managed Bean Query or Metric Service Table name
out_param_details Sequence[stackmonitoring.GetMetricExtensionQueryPropertyOutParamDetail]: Position and SQL Type of PL/SQL OUT parameter
protocol_type str: 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: Type of content response given by the http(s) URL
script_details Sequence[stackmonitoring.GetMetricExtensionQueryPropertyScriptDetail]: 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 Sequence[stackmonitoring.GetMetricExtensionQueryPropertySqlDetail]: Details of Sql content which needs to execute to collect Metric Extension data
sql_type str: Type of SQL data collection method i.e. either a Statement or SQL Script File
starts_with str: String prefix used to identify metric output of the OS Command
url str: Http(s) end point URL

arguments String: Arguments required by either command or script
autoRowPrefix String: Prefix for an auto generated metric, in case multiple rows with non unique key values are returned
collectionMethod String: Type of possible collection methods.
command String: OS command to execute without arguments
delimiter String: Character used to delimit multiple metric values in single line of output
identityMetric String: Semi-colon separated list of key properties from Managed Bean ObjectName to be used as key metrics
inParamDetails List<Property Map>: List of values and position of PL/SQL procedure IN parameters
isMetricServiceEnabled Boolean: Indicates if Metric Service is enabled on server domain
jmxAttributes String: List of JMX attributes or Metric Service Table columns separated by semi-colon
managedBeanQuery String: JMX Managed Bean Query or Metric Service Table name
outParamDetails List<Property Map>: Position and SQL Type of PL/SQL OUT parameter
protocolType String: 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: Type of content response given by the http(s) URL
scriptDetails List<Property Map>: 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 List<Property Map>: Details of Sql content which needs to execute to collect Metric Extension data
sqlType String: Type of SQL data collection method i.e. either a Statement or SQL Script File
startsWith String: String prefix used to identify metric output of the OS Command
url String: Http(s) end point URL

GetMetricExtensionQueryPropertyInParamDetail

InParamPosition int: Position of IN parameter
InParamValue string: Value of IN parameter

InParamPosition int: Position of IN parameter
InParamValue string: Value of IN parameter

inParamPosition Integer: Position of IN parameter
inParamValue String: Value of IN parameter

inParamPosition number: Position of IN parameter
inParamValue string: Value of IN parameter

in_param_position int: Position of IN parameter
in_param_value str: Value of IN parameter

inParamPosition Number: Position of IN parameter
inParamValue String: Value of IN parameter

GetMetricExtensionQueryPropertyOutParamDetail

OutParamName string: Name of the Out Parameter
OutParamPosition int: 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 string: 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: Name of the Out Parameter
OutParamPosition int: 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 string: 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: Name of the Out Parameter
outParamPosition Integer: 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 String: 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: Name of the Out Parameter
outParamPosition number: 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 string: 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: Name of the Out Parameter
out_param_position int: 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 str: 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: Name of the Out Parameter
outParamPosition Number: 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 String: 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.

GetMetricExtensionQueryPropertyScriptDetail

Content string: Sql statement or script file content as base64 encoded string
Name string: Name of the script file

Content string: Sql statement or script file content as base64 encoded string
Name string: Name of the script file

content String: Sql statement or script file content as base64 encoded string
name String: Name of the script file

content string: Sql statement or script file content as base64 encoded string
name string: Name of the script file

content str: Sql statement or script file content as base64 encoded string
name str: Name of the script file

content String: Sql statement or script file content as base64 encoded string
name String: Name of the script file

GetMetricExtensionQueryPropertySqlDetail

Content string: Sql statement or script file content as base64 encoded string
ScriptFileName string: If a script needs to be executed, then provide file name of the script

Content string: Sql statement or script file content as base64 encoded string
ScriptFileName string: If a script needs to be executed, then provide file name of the script

content String: Sql statement or script file content as base64 encoded string
scriptFileName String: If a script needs to be executed, then provide file name of the script

content string: Sql statement or script file content as base64 encoded string
scriptFileName string: If a script needs to be executed, then provide file name of the script

content str: Sql statement or script file content as base64 encoded string
script_file_name str: If a script needs to be executed, then provide file name of the script

content String: Sql statement or script file content as base64 encoded string
scriptFileName String: If a script needs to be executed, then provide file name of the script

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.StackMonitoring.getMetricExtension

On this page

On this page

Example Usage

Using getMetricExtension

getMetricExtension Result

Supporting Types

GetMetricExtensionEnabledOnResource

GetMetricExtensionMetricList

GetMetricExtensionQueryProperty

GetMetricExtensionQueryPropertyInParamDetail

GetMetricExtensionQueryPropertyOutParamDetail

GetMetricExtensionQueryPropertyScriptDetail

GetMetricExtensionQueryPropertySqlDetail

Package Details

On this page

On this page