Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. StackMonitoring
  5. getMonitoredResourceTask
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.StackMonitoring.getMonitoredResourceTask

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Monitored Resource Task resource in Oracle Cloud Infrastructure Stack Monitoring service.

    Gets stack monitoring resource task details by identifier OCID.

    Example Usage

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

const testMonitoredResourceTask = oci.StackMonitoring.getMonitoredResourceTask({
    monitoredResourceTaskId: testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id,
});

    import pulumi
import pulumi_oci as oci

test_monitored_resource_task = oci.StackMonitoring.get_monitored_resource_task(monitored_resource_task_id=test_monitored_resource_task_oci_stack_monitoring_monitored_resource_task["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.GetMonitoredResourceTask(ctx, &stackmonitoring.GetMonitoredResourceTaskArgs{
			MonitoredResourceTaskId: testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.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 testMonitoredResourceTask = Oci.StackMonitoring.GetMonitoredResourceTask.Invoke(new()
    {
        MonitoredResourceTaskId = testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.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.GetMonitoredResourceTaskArgs;
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 testMonitoredResourceTask = StackMonitoringFunctions.getMonitoredResourceTask(GetMonitoredResourceTaskArgs.builder()
            .monitoredResourceTaskId(testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id())
            .build());

    }
}

    variables:
  testMonitoredResourceTask:
    fn::invoke:
      function: oci:StackMonitoring:getMonitoredResourceTask
      arguments:
        monitoredResourceTaskId: ${testMonitoredResourceTaskOciStackMonitoringMonitoredResourceTask.id}

    Using getMonitoredResourceTask

    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 getMonitoredResourceTask(args: GetMonitoredResourceTaskArgs, opts?: InvokeOptions): Promise<GetMonitoredResourceTaskResult>
function getMonitoredResourceTaskOutput(args: GetMonitoredResourceTaskOutputArgs, opts?: InvokeOptions): Output<GetMonitoredResourceTaskResult>
    def get_monitored_resource_task(monitored_resource_task_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetMonitoredResourceTaskResult
def get_monitored_resource_task_output(monitored_resource_task_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetMonitoredResourceTaskResult]
    func LookupMonitoredResourceTask(ctx *Context, args *LookupMonitoredResourceTaskArgs, opts ...InvokeOption) (*LookupMonitoredResourceTaskResult, error)
func LookupMonitoredResourceTaskOutput(ctx *Context, args *LookupMonitoredResourceTaskOutputArgs, opts ...InvokeOption) LookupMonitoredResourceTaskResultOutput

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

    public static class GetMonitoredResourceTask 
{
    public static Task<GetMonitoredResourceTaskResult> InvokeAsync(GetMonitoredResourceTaskArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitoredResourceTaskResult> Invoke(GetMonitoredResourceTaskInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMonitoredResourceTaskResult> getMonitoredResourceTask(GetMonitoredResourceTaskArgs args, InvokeOptions options)
public static Output<GetMonitoredResourceTaskResult> getMonitoredResourceTask(GetMonitoredResourceTaskArgs args, InvokeOptions options)

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

    The following arguments are supported:

    MonitoredResourceTaskId string
    The OCID of stack monitoring resource task.
    MonitoredResourceTaskId string
    The OCID of stack monitoring resource task.
    monitoredResourceTaskId String
    The OCID of stack monitoring resource task.
    monitoredResourceTaskId string
    The OCID of stack monitoring resource task.
    monitored_resource_task_id str
    The OCID of stack monitoring resource task.
    monitoredResourceTaskId String
    The OCID of stack monitoring resource task.

    getMonitoredResourceTask Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment identifier.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Task identifier OCID.
    MonitoredResourceTaskId string
    Name string
    Property name.
    State string
    The current state of the stack monitoring resource task.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TaskDetails List<GetMonitoredResourceTaskTaskDetail>
    The request details for the performing the task.
    TenantId string
    The OCID of the tenancy.
    TimeCreated string
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    Type string
    Type of the task.
    WorkRequestIds List<string>
    Identifiers OCID for work requests submitted for this task.
    CompartmentId string
    The OCID of the compartment identifier.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    Task identifier OCID.
    MonitoredResourceTaskId string
    Name string
    Property name.
    State string
    The current state of the stack monitoring resource task.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TaskDetails []GetMonitoredResourceTaskTaskDetail
    The request details for the performing the task.
    TenantId string
    The OCID of the tenancy.
    TimeCreated string
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    TimeUpdated string
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    Type string
    Type of the task.
    WorkRequestIds []string
    Identifiers OCID for work requests submitted for this task.
    compartmentId String
    The OCID of the compartment identifier.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Task identifier OCID.
    monitoredResourceTaskId String
    name String
    Property name.
    state String
    The current state of the stack monitoring resource task.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    taskDetails List<GetMonitoredResourceTaskTaskDetail>
    The request details for the performing the task.
    tenantId String
    The OCID of the tenancy.
    timeCreated String
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    type String
    Type of the task.
    workRequestIds List<String>
    Identifiers OCID for work requests submitted for this task.
    compartmentId string
    The OCID of the compartment identifier.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    Task identifier OCID.
    monitoredResourceTaskId string
    name string
    Property name.
    state string
    The current state of the stack monitoring resource task.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    taskDetails GetMonitoredResourceTaskTaskDetail[]
    The request details for the performing the task.
    tenantId string
    The OCID of the tenancy.
    timeCreated string
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    timeUpdated string
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    type string
    Type of the task.
    workRequestIds string[]
    Identifiers OCID for work requests submitted for this task.
    compartment_id str
    The OCID of the compartment identifier.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    Task identifier OCID.
    monitored_resource_task_id str
    name str
    Property name.
    state str
    The current state of the stack monitoring resource task.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    task_details Sequence[GetMonitoredResourceTaskTaskDetail]
    The request details for the performing the task.
    tenant_id str
    The OCID of the tenancy.
    time_created str
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    time_updated str
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    type str
    Type of the task.
    work_request_ids Sequence[str]
    Identifiers OCID for work requests submitted for this task.
    compartmentId String
    The OCID of the compartment identifier.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    Task identifier OCID.
    monitoredResourceTaskId String
    name String
    Property name.
    state String
    The current state of the stack monitoring resource task.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    taskDetails List<Property Map>
    The request details for the performing the task.
    tenantId String
    The OCID of the tenancy.
    timeCreated String
    The date and time when the stack monitoring resource task was created, expressed in RFC 3339 timestamp format.
    timeUpdated String
    The date and time when the stack monitoring resource task was last updated, expressed in RFC 3339 timestamp format.
    type String
    Type of the task.
    workRequestIds List<String>
    Identifiers OCID for work requests submitted for this task.

    Supporting Types

    GetMonitoredResourceTaskTaskDetail

    AgentId string
    Management Agent Identifier OCID.
    AvailabilityProxyMetricCollectionInterval int
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    AvailabilityProxyMetrics List<string>
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    ConsolePathPrefix string
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    ExternalIdMapping string
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    HandlerType string
    Type of the handler.
    IsEnable bool
    True to enable the receiver and false to disable the receiver on the agent.
    LifecycleStatusMappingsForUpStatuses List<string>
    Lifecycle states of the external resource which reflects the status of the resource being up.
    Namespace string
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    ReceiverProperties List<GetMonitoredResourceTaskTaskDetailReceiverProperty>
    Properties for agent receiver.
    ResourceGroup string
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    ResourceNameFilter string
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    ResourceNameMapping string
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    ResourceTypeFilter string
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    ResourceTypeMapping string
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    ResourceTypesConfigurations List<GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration>
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    ServiceBaseUrl string
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    ShouldUseMetricsFlowForStatus bool
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    Source string
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    Type string
    Type of the task.
    AgentId string
    Management Agent Identifier OCID.
    AvailabilityProxyMetricCollectionInterval int
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    AvailabilityProxyMetrics []string
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    ConsolePathPrefix string
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    ExternalIdMapping string
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    HandlerType string
    Type of the handler.
    IsEnable bool
    True to enable the receiver and false to disable the receiver on the agent.
    LifecycleStatusMappingsForUpStatuses []string
    Lifecycle states of the external resource which reflects the status of the resource being up.
    Namespace string
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    ReceiverProperties []GetMonitoredResourceTaskTaskDetailReceiverProperty
    Properties for agent receiver.
    ResourceGroup string
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    ResourceNameFilter string
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    ResourceNameMapping string
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    ResourceTypeFilter string
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    ResourceTypeMapping string
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    ResourceTypesConfigurations []GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    ServiceBaseUrl string
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    ShouldUseMetricsFlowForStatus bool
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    Source string
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    Type string
    Type of the task.
    agentId String
    Management Agent Identifier OCID.
    availabilityProxyMetricCollectionInterval Integer
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    availabilityProxyMetrics List<String>
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    consolePathPrefix String
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    externalIdMapping String
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    handlerType String
    Type of the handler.
    isEnable Boolean
    True to enable the receiver and false to disable the receiver on the agent.
    lifecycleStatusMappingsForUpStatuses List<String>
    Lifecycle states of the external resource which reflects the status of the resource being up.
    namespace String
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    receiverProperties List<GetMonitoredResourceTaskTaskDetailReceiverProperty>
    Properties for agent receiver.
    resourceGroup String
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    resourceNameFilter String
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    resourceNameMapping String
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    resourceTypeFilter String
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    resourceTypeMapping String
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    resourceTypesConfigurations List<GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration>
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    serviceBaseUrl String
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    shouldUseMetricsFlowForStatus Boolean
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    source String
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    type String
    Type of the task.
    agentId string
    Management Agent Identifier OCID.
    availabilityProxyMetricCollectionInterval number
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    availabilityProxyMetrics string[]
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    consolePathPrefix string
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    externalIdMapping string
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    handlerType string
    Type of the handler.
    isEnable boolean
    True to enable the receiver and false to disable the receiver on the agent.
    lifecycleStatusMappingsForUpStatuses string[]
    Lifecycle states of the external resource which reflects the status of the resource being up.
    namespace string
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    receiverProperties GetMonitoredResourceTaskTaskDetailReceiverProperty[]
    Properties for agent receiver.
    resourceGroup string
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    resourceNameFilter string
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    resourceNameMapping string
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    resourceTypeFilter string
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    resourceTypeMapping string
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    resourceTypesConfigurations GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration[]
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    serviceBaseUrl string
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    shouldUseMetricsFlowForStatus boolean
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    source string
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    type string
    Type of the task.
    agent_id str
    Management Agent Identifier OCID.
    availability_proxy_metric_collection_interval int
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    availability_proxy_metrics Sequence[str]
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    console_path_prefix str
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    external_id_mapping str
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    handler_type str
    Type of the handler.
    is_enable bool
    True to enable the receiver and false to disable the receiver on the agent.
    lifecycle_status_mappings_for_up_statuses Sequence[str]
    Lifecycle states of the external resource which reflects the status of the resource being up.
    namespace str
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    receiver_properties Sequence[GetMonitoredResourceTaskTaskDetailReceiverProperty]
    Properties for agent receiver.
    resource_group str
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    resource_name_filter str
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    resource_name_mapping str
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    resource_type_filter str
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    resource_type_mapping str
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    resource_types_configurations Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration]
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    service_base_url str
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    should_use_metrics_flow_for_status bool
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    source str
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    type str
    Type of the task.
    agentId String
    Management Agent Identifier OCID.
    availabilityProxyMetricCollectionInterval Number
    Metrics collection interval in seconds used when calculating the availability of the resource based on metrics specified using the property 'availabilityProxyMetrics'.
    availabilityProxyMetrics List<String>
    List of metrics to be used to calculate the availability of the resource. Resource is considered to be up if at least one of the specified metrics is available for the resource during the specified interval using the property 'availabilityProxyMetricCollectionInterval'. If no metrics are specified, availability will not be calculated for the resource.
    consolePathPrefix String
    The console path prefix to use for providing service home url page navigation. For example if the prefix provided is 'security/bastion/bastions', the URL used for navigation will be https:///security/bastion/bastions/. If not provided, service home page link will not be shown in the stack monitoring home page.
    externalIdMapping String
    The external resource identifier property in the metric dimensions. Resources imported will be using this property value for external id.
    handlerType String
    Type of the handler.
    isEnable Boolean
    True to enable the receiver and false to disable the receiver on the agent.
    lifecycleStatusMappingsForUpStatuses List<String>
    Lifecycle states of the external resource which reflects the status of the resource being up.
    namespace String
    Name space to be used for Oracle Cloud Infrastructure Native service resources' import.
    receiverProperties List<Property Map>
    Properties for agent receiver.
    resourceGroup String
    The resource group to use while fetching metrics from telemetry. If not specified, resource group will be skipped in the list metrics request.
    resourceNameFilter String
    The resource name filter. Resources matching with the resource name filter will be imported. Regular expressions will be accepted.
    resourceNameMapping String
    The resource name property in the metric dimensions. Resources imported will be using this property value for resource name.
    resourceTypeFilter String
    The resource type filter. Resources matching with the resource type filter will be imported. Regular expressions will be accepted.
    resourceTypeMapping String
    The resource type property in the metric dimensions. Resources imported will be using this property value for resource type. If not specified, namespace will be used for resource type.
    resourceTypesConfigurations List<Property Map>
    A collection of resource type configuration details. User can provide availability proxy metrics list for resource types along with the telegraf/collectd handler configuration for the resource types.
    serviceBaseUrl String
    The base URL of the Oracle Cloud Infrastructure service to which the resource belongs to. Also this property is applicable only when source is OCI_TELEMETRY_NATIVE.
    shouldUseMetricsFlowForStatus Boolean
    Flag to indicate whether status is calculated using metrics or LifeCycleState attribute of the resource in Oracle Cloud Infrastructure service.
    source String
    Source from where the metrics pushed to telemetry. Possible values:

    • OCI_TELEMETRY_NATIVE - The metrics are pushed to telemetry from Oracle Cloud Infrastructure Native Services.
    • OCI_TELEMETRY_PROMETHEUS - The metrics are pushed to telemetry from Prometheus.
    • OCI_TELEMETRY_TELEGRAF - The metrics are pushed to telemetry from Telegraf receiver.
    • OCI_TELEMETRY_COLLECTD - The metrics are pushed to telemetry from CollectD receiver.
    type String
    Type of the task.

    GetMonitoredResourceTaskTaskDetailReceiverProperty

    ListenerPort int
    Receiver listener port.
    ListenerPort int
    Receiver listener port.
    listenerPort Integer
    Receiver listener port.
    listenerPort number
    Receiver listener port.
    listener_port int
    Receiver listener port.
    listenerPort Number
    Receiver listener port.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfiguration

    availabilityMetricsConfigs List<Property Map>
    Availability metrics details.
    handlerConfigs List<Property Map>
    Specific resource mapping configurations for Agent Extension Handlers.
    resourceType String
    Resource type.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationAvailabilityMetricsConfig

    CollectionIntervalInSeconds int
    Availability metric collection internal in seconds.
    Metrics List<string>
    List of metrics used for availability calculation for the resource.
    CollectionIntervalInSeconds int
    Availability metric collection internal in seconds.
    Metrics []string
    List of metrics used for availability calculation for the resource.
    collectionIntervalInSeconds Integer
    Availability metric collection internal in seconds.
    metrics List<String>
    List of metrics used for availability calculation for the resource.
    collectionIntervalInSeconds number
    Availability metric collection internal in seconds.
    metrics string[]
    List of metrics used for availability calculation for the resource.
    collection_interval_in_seconds int
    Availability metric collection internal in seconds.
    metrics Sequence[str]
    List of metrics used for availability calculation for the resource.
    collectionIntervalInSeconds Number
    Availability metric collection internal in seconds.
    metrics List<String>
    List of metrics used for availability calculation for the resource.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfig

    CollectdResourceNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig>
    Resource name generation overriding configurations for collectd resource types.
    CollectorTypes List<string>
    List of collector/plugin names.
    HandlerProperties List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty>
    List of handler configuration properties
    MetricMappings List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping>
    List of AgentExtensionHandlerMetricMappingDetails.
    MetricNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig>
    Metric name generation overriding configurations.
    MetricUploadIntervalInSeconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    TelegrafResourceNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig>
    Resource name generation overriding configurations for telegraf resource types.
    TelemetryResourceGroup string
    Resource group string; if not specified, the resource group string will be generated by the handler.
    CollectdResourceNameConfigs []GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig
    Resource name generation overriding configurations for collectd resource types.
    CollectorTypes []string
    List of collector/plugin names.
    HandlerProperties []GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty
    List of handler configuration properties
    MetricMappings []GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping
    List of AgentExtensionHandlerMetricMappingDetails.
    MetricNameConfigs []GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig
    Metric name generation overriding configurations.
    MetricUploadIntervalInSeconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    TelegrafResourceNameConfigs []GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig
    Resource name generation overriding configurations for telegraf resource types.
    TelemetryResourceGroup string
    Resource group string; if not specified, the resource group string will be generated by the handler.
    collectdResourceNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig>
    Resource name generation overriding configurations for collectd resource types.
    collectorTypes List<String>
    List of collector/plugin names.
    handlerProperties List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty>
    List of handler configuration properties
    metricMappings List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping>
    List of AgentExtensionHandlerMetricMappingDetails.
    metricNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig>
    Metric name generation overriding configurations.
    metricUploadIntervalInSeconds Integer
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telegrafResourceNameConfigs List<GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig>
    Resource name generation overriding configurations for telegraf resource types.
    telemetryResourceGroup String
    Resource group string; if not specified, the resource group string will be generated by the handler.
    collectdResourceNameConfigs GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig[]
    Resource name generation overriding configurations for collectd resource types.
    collectorTypes string[]
    List of collector/plugin names.
    handlerProperties GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty[]
    List of handler configuration properties
    metricMappings GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping[]
    List of AgentExtensionHandlerMetricMappingDetails.
    metricNameConfigs GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig[]
    Metric name generation overriding configurations.
    metricUploadIntervalInSeconds number
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telegrafResourceNameConfigs GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig[]
    Resource name generation overriding configurations for telegraf resource types.
    telemetryResourceGroup string
    Resource group string; if not specified, the resource group string will be generated by the handler.
    collectd_resource_name_configs Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig]
    Resource name generation overriding configurations for collectd resource types.
    collector_types Sequence[str]
    List of collector/plugin names.
    handler_properties Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty]
    List of handler configuration properties
    metric_mappings Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping]
    List of AgentExtensionHandlerMetricMappingDetails.
    metric_name_configs Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig]
    Metric name generation overriding configurations.
    metric_upload_interval_in_seconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telegraf_resource_name_configs Sequence[GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig]
    Resource name generation overriding configurations for telegraf resource types.
    telemetry_resource_group str
    Resource group string; if not specified, the resource group string will be generated by the handler.
    collectdResourceNameConfigs List<Property Map>
    Resource name generation overriding configurations for collectd resource types.
    collectorTypes List<String>
    List of collector/plugin names.
    handlerProperties List<Property Map>
    List of handler configuration properties
    metricMappings List<Property Map>
    List of AgentExtensionHandlerMetricMappingDetails.
    metricNameConfigs List<Property Map>
    Metric name generation overriding configurations.
    metricUploadIntervalInSeconds Number
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telegrafResourceNameConfigs List<Property Map>
    Resource name generation overriding configurations for telegraf resource types.
    telemetryResourceGroup String
    Resource group string; if not specified, the resource group string will be generated by the handler.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigCollectdResourceNameConfig

    ExcludeProperties List<string>
    List of property names to be excluded.
    IncludeProperties List<string>
    List of property names to be included.
    Suffix string
    String to be suffixed to the resource name.
    ExcludeProperties []string
    List of property names to be excluded.
    IncludeProperties []string
    List of property names to be included.
    Suffix string
    String to be suffixed to the resource name.
    excludeProperties List<String>
    List of property names to be excluded.
    includeProperties List<String>
    List of property names to be included.
    suffix String
    String to be suffixed to the resource name.
    excludeProperties string[]
    List of property names to be excluded.
    includeProperties string[]
    List of property names to be included.
    suffix string
    String to be suffixed to the resource name.
    exclude_properties Sequence[str]
    List of property names to be excluded.
    include_properties Sequence[str]
    List of property names to be included.
    suffix str
    String to be suffixed to the resource name.
    excludeProperties List<String>
    List of property names to be excluded.
    includeProperties List<String>
    List of property names to be included.
    suffix String
    String to be suffixed to the resource name.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigHandlerProperty

    Name string
    Property name.
    Value string
    Property value.
    Name string
    Property name.
    Value string
    Property value.
    name String
    Property name.
    value String
    Property value.
    name string
    Property name.
    value string
    Property value.
    name str
    Property name.
    value str
    Property value.
    name String
    Property name.
    value String
    Property value.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricMapping

    CollectorMetricName string
    Metric name as defined by the collector.
    IsSkipUpload bool
    Is ignoring this metric.
    MetricUploadIntervalInSeconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    TelemetryMetricName string
    Metric name to be upload to telemetry.
    CollectorMetricName string
    Metric name as defined by the collector.
    IsSkipUpload bool
    Is ignoring this metric.
    MetricUploadIntervalInSeconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    TelemetryMetricName string
    Metric name to be upload to telemetry.
    collectorMetricName String
    Metric name as defined by the collector.
    isSkipUpload Boolean
    Is ignoring this metric.
    metricUploadIntervalInSeconds Integer
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telemetryMetricName String
    Metric name to be upload to telemetry.
    collectorMetricName string
    Metric name as defined by the collector.
    isSkipUpload boolean
    Is ignoring this metric.
    metricUploadIntervalInSeconds number
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telemetryMetricName string
    Metric name to be upload to telemetry.
    collector_metric_name str
    Metric name as defined by the collector.
    is_skip_upload bool
    Is ignoring this metric.
    metric_upload_interval_in_seconds int
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telemetry_metric_name str
    Metric name to be upload to telemetry.
    collectorMetricName String
    Metric name as defined by the collector.
    isSkipUpload Boolean
    Is ignoring this metric.
    metricUploadIntervalInSeconds Number
    Metric upload interval in seconds. Any metric sent by telegraf/collectd before the configured interval expires will be dropped.
    telemetryMetricName String
    Metric name to be upload to telemetry.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigMetricNameConfig

    ExcludePatternOnPrefix string
    String pattern to be removed from the prefix of the metric name.
    IsPrefixWithCollectorType bool
    is prefixing the metric with collector type.
    ExcludePatternOnPrefix string
    String pattern to be removed from the prefix of the metric name.
    IsPrefixWithCollectorType bool
    is prefixing the metric with collector type.
    excludePatternOnPrefix String
    String pattern to be removed from the prefix of the metric name.
    isPrefixWithCollectorType Boolean
    is prefixing the metric with collector type.
    excludePatternOnPrefix string
    String pattern to be removed from the prefix of the metric name.
    isPrefixWithCollectorType boolean
    is prefixing the metric with collector type.
    exclude_pattern_on_prefix str
    String pattern to be removed from the prefix of the metric name.
    is_prefix_with_collector_type bool
    is prefixing the metric with collector type.
    excludePatternOnPrefix String
    String pattern to be removed from the prefix of the metric name.
    isPrefixWithCollectorType Boolean
    is prefixing the metric with collector type.

    GetMonitoredResourceTaskTaskDetailResourceTypesConfigurationHandlerConfigTelegrafResourceNameConfig

    ExcludeTags List<string>
    List of tag names to be excluded.
    IncludeTags List<string>
    List of tag names to be included.
    IsUseTagsOnly bool
    Flag to indicate if only tags will be used for resource name generation.
    ExcludeTags []string
    List of tag names to be excluded.
    IncludeTags []string
    List of tag names to be included.
    IsUseTagsOnly bool
    Flag to indicate if only tags will be used for resource name generation.
    excludeTags List<String>
    List of tag names to be excluded.
    includeTags List<String>
    List of tag names to be included.
    isUseTagsOnly Boolean
    Flag to indicate if only tags will be used for resource name generation.
    excludeTags string[]
    List of tag names to be excluded.
    includeTags string[]
    List of tag names to be included.
    isUseTagsOnly boolean
    Flag to indicate if only tags will be used for resource name generation.
    exclude_tags Sequence[str]
    List of tag names to be excluded.
    include_tags Sequence[str]
    List of tag names to be included.
    is_use_tags_only bool
    Flag to indicate if only tags will be used for resource name generation.
    excludeTags List<String>
    List of tag names to be excluded.
    includeTags List<String>
    List of tag names to be included.
    isUseTagsOnly Boolean
    Flag to indicate if only tags will be used for resource name generation.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci