1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ManagementAgent
  5. ManagementAgentDataSource
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

oci.ManagementAgent.ManagementAgentDataSource

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi

    This resource provides the Management Agent Data Source resource in Oracle Cloud Infrastructure Management Agent service.

    Datasource creation request to given Management Agent.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testManagementAgentDataSource = new oci.managementagent.ManagementAgentDataSource("test_management_agent_data_source", {
        compartmentId: compartmentId,
        managementAgentId: testManagementAgent.id,
        name: managementAgentDataSourceName,
        type: managementAgentDataSourceType,
        url: managementAgentDataSourceUrl,
        allowMetrics: managementAgentDataSourceAllowMetrics,
        connectionTimeout: managementAgentDataSourceConnectionTimeout,
        metricDimensions: [{
            name: managementAgentDataSourceMetricDimensionsName,
            value: managementAgentDataSourceMetricDimensionsValue,
        }],
        namespace: managementAgentDataSourceNamespace,
        proxyUrl: managementAgentDataSourceProxyUrl,
        readDataLimitInKilobytes: managementAgentDataSourceReadDataLimitInKilobytes,
        readTimeout: managementAgentDataSourceReadTimeout,
        resourceGroup: managementAgentDataSourceResourceGroup,
        scheduleMins: managementAgentDataSourceScheduleMins,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_management_agent_data_source = oci.management_agent.ManagementAgentDataSource("test_management_agent_data_source",
        compartment_id=compartment_id,
        management_agent_id=test_management_agent["id"],
        name=management_agent_data_source_name,
        type=management_agent_data_source_type,
        url=management_agent_data_source_url,
        allow_metrics=management_agent_data_source_allow_metrics,
        connection_timeout=management_agent_data_source_connection_timeout,
        metric_dimensions=[oci.management_agent.ManagementAgentDataSourceMetricDimensionArgs(
            name=management_agent_data_source_metric_dimensions_name,
            value=management_agent_data_source_metric_dimensions_value,
        )],
        namespace=management_agent_data_source_namespace,
        proxy_url=management_agent_data_source_proxy_url,
        read_data_limit_in_kilobytes=management_agent_data_source_read_data_limit_in_kilobytes,
        read_timeout=management_agent_data_source_read_timeout,
        resource_group=management_agent_data_source_resource_group,
        schedule_mins=management_agent_data_source_schedule_mins)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/ManagementAgent"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ManagementAgent.NewManagementAgentDataSource(ctx, "test_management_agent_data_source", &ManagementAgent.ManagementAgentDataSourceArgs{
    			CompartmentId:     pulumi.Any(compartmentId),
    			ManagementAgentId: pulumi.Any(testManagementAgent.Id),
    			Name:              pulumi.Any(managementAgentDataSourceName),
    			Type:              pulumi.Any(managementAgentDataSourceType),
    			Url:               pulumi.Any(managementAgentDataSourceUrl),
    			AllowMetrics:      pulumi.Any(managementAgentDataSourceAllowMetrics),
    			ConnectionTimeout: pulumi.Any(managementAgentDataSourceConnectionTimeout),
    			MetricDimensions: managementagent.ManagementAgentDataSourceMetricDimensionArray{
    				&managementagent.ManagementAgentDataSourceMetricDimensionArgs{
    					Name:  pulumi.Any(managementAgentDataSourceMetricDimensionsName),
    					Value: pulumi.Any(managementAgentDataSourceMetricDimensionsValue),
    				},
    			},
    			Namespace:                pulumi.Any(managementAgentDataSourceNamespace),
    			ProxyUrl:                 pulumi.Any(managementAgentDataSourceProxyUrl),
    			ReadDataLimitInKilobytes: pulumi.Any(managementAgentDataSourceReadDataLimitInKilobytes),
    			ReadTimeout:              pulumi.Any(managementAgentDataSourceReadTimeout),
    			ResourceGroup:            pulumi.Any(managementAgentDataSourceResourceGroup),
    			ScheduleMins:             pulumi.Any(managementAgentDataSourceScheduleMins),
    		})
    		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 testManagementAgentDataSource = new Oci.ManagementAgent.ManagementAgentDataSource("test_management_agent_data_source", new()
        {
            CompartmentId = compartmentId,
            ManagementAgentId = testManagementAgent.Id,
            Name = managementAgentDataSourceName,
            Type = managementAgentDataSourceType,
            Url = managementAgentDataSourceUrl,
            AllowMetrics = managementAgentDataSourceAllowMetrics,
            ConnectionTimeout = managementAgentDataSourceConnectionTimeout,
            MetricDimensions = new[]
            {
                new Oci.ManagementAgent.Inputs.ManagementAgentDataSourceMetricDimensionArgs
                {
                    Name = managementAgentDataSourceMetricDimensionsName,
                    Value = managementAgentDataSourceMetricDimensionsValue,
                },
            },
            Namespace = managementAgentDataSourceNamespace,
            ProxyUrl = managementAgentDataSourceProxyUrl,
            ReadDataLimitInKilobytes = managementAgentDataSourceReadDataLimitInKilobytes,
            ReadTimeout = managementAgentDataSourceReadTimeout,
            ResourceGroup = managementAgentDataSourceResourceGroup,
            ScheduleMins = managementAgentDataSourceScheduleMins,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.ManagementAgent.ManagementAgentDataSource;
    import com.pulumi.oci.ManagementAgent.ManagementAgentDataSourceArgs;
    import com.pulumi.oci.ManagementAgent.inputs.ManagementAgentDataSourceMetricDimensionArgs;
    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 testManagementAgentDataSource = new ManagementAgentDataSource("testManagementAgentDataSource", ManagementAgentDataSourceArgs.builder()
                .compartmentId(compartmentId)
                .managementAgentId(testManagementAgent.id())
                .name(managementAgentDataSourceName)
                .type(managementAgentDataSourceType)
                .url(managementAgentDataSourceUrl)
                .allowMetrics(managementAgentDataSourceAllowMetrics)
                .connectionTimeout(managementAgentDataSourceConnectionTimeout)
                .metricDimensions(ManagementAgentDataSourceMetricDimensionArgs.builder()
                    .name(managementAgentDataSourceMetricDimensionsName)
                    .value(managementAgentDataSourceMetricDimensionsValue)
                    .build())
                .namespace(managementAgentDataSourceNamespace)
                .proxyUrl(managementAgentDataSourceProxyUrl)
                .readDataLimitInKilobytes(managementAgentDataSourceReadDataLimitInKilobytes)
                .readTimeout(managementAgentDataSourceReadTimeout)
                .resourceGroup(managementAgentDataSourceResourceGroup)
                .scheduleMins(managementAgentDataSourceScheduleMins)
                .build());
    
        }
    }
    
    resources:
      testManagementAgentDataSource:
        type: oci:ManagementAgent:ManagementAgentDataSource
        name: test_management_agent_data_source
        properties:
          compartmentId: ${compartmentId}
          managementAgentId: ${testManagementAgent.id}
          name: ${managementAgentDataSourceName}
          type: ${managementAgentDataSourceType}
          url: ${managementAgentDataSourceUrl}
          allowMetrics: ${managementAgentDataSourceAllowMetrics}
          connectionTimeout: ${managementAgentDataSourceConnectionTimeout}
          metricDimensions:
            - name: ${managementAgentDataSourceMetricDimensionsName}
              value: ${managementAgentDataSourceMetricDimensionsValue}
          namespace: ${managementAgentDataSourceNamespace}
          proxyUrl: ${managementAgentDataSourceProxyUrl}
          readDataLimitInKilobytes: ${managementAgentDataSourceReadDataLimitInKilobytes}
          readTimeout: ${managementAgentDataSourceReadTimeout}
          resourceGroup: ${managementAgentDataSourceResourceGroup}
          scheduleMins: ${managementAgentDataSourceScheduleMins}
    

    Create ManagementAgentDataSource Resource

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

    Constructor syntax

    new ManagementAgentDataSource(name: string, args: ManagementAgentDataSourceArgs, opts?: CustomResourceOptions);
    @overload
    def ManagementAgentDataSource(resource_name: str,
                                  args: ManagementAgentDataSourceArgs,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def ManagementAgentDataSource(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  type: Optional[str] = None,
                                  compartment_id: Optional[str] = None,
                                  url: Optional[str] = None,
                                  management_agent_id: Optional[str] = None,
                                  namespace: Optional[str] = None,
                                  name: Optional[str] = None,
                                  allow_metrics: Optional[str] = None,
                                  proxy_url: Optional[str] = None,
                                  read_data_limit_in_kilobytes: Optional[int] = None,
                                  read_timeout: Optional[int] = None,
                                  resource_group: Optional[str] = None,
                                  schedule_mins: Optional[int] = None,
                                  metric_dimensions: Optional[Sequence[_managementagent.ManagementAgentDataSourceMetricDimensionArgs]] = None,
                                  connection_timeout: Optional[int] = None)
    func NewManagementAgentDataSource(ctx *Context, name string, args ManagementAgentDataSourceArgs, opts ...ResourceOption) (*ManagementAgentDataSource, error)
    public ManagementAgentDataSource(string name, ManagementAgentDataSourceArgs args, CustomResourceOptions? opts = null)
    public ManagementAgentDataSource(String name, ManagementAgentDataSourceArgs args)
    public ManagementAgentDataSource(String name, ManagementAgentDataSourceArgs args, CustomResourceOptions options)
    
    type: oci:ManagementAgent:ManagementAgentDataSource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ManagementAgentDataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagementAgentDataSourceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagementAgentDataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementAgentDataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementAgentDataSourceArgs
    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 managementAgentDataSourceResource = new Oci.ManagementAgent.ManagementAgentDataSource("managementAgentDataSourceResource", new()
    {
        Type = "string",
        CompartmentId = "string",
        Url = "string",
        ManagementAgentId = "string",
        Namespace = "string",
        Name = "string",
        AllowMetrics = "string",
        ProxyUrl = "string",
        ReadDataLimitInKilobytes = 0,
        ReadTimeout = 0,
        ResourceGroup = "string",
        ScheduleMins = 0,
        MetricDimensions = new[]
        {
            new Oci.ManagementAgent.Inputs.ManagementAgentDataSourceMetricDimensionArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        ConnectionTimeout = 0,
    });
    
    example, err := ManagementAgent.NewManagementAgentDataSource(ctx, "managementAgentDataSourceResource", &ManagementAgent.ManagementAgentDataSourceArgs{
    	Type:                     pulumi.String("string"),
    	CompartmentId:            pulumi.String("string"),
    	Url:                      pulumi.String("string"),
    	ManagementAgentId:        pulumi.String("string"),
    	Namespace:                pulumi.String("string"),
    	Name:                     pulumi.String("string"),
    	AllowMetrics:             pulumi.String("string"),
    	ProxyUrl:                 pulumi.String("string"),
    	ReadDataLimitInKilobytes: pulumi.Int(0),
    	ReadTimeout:              pulumi.Int(0),
    	ResourceGroup:            pulumi.String("string"),
    	ScheduleMins:             pulumi.Int(0),
    	MetricDimensions: managementagent.ManagementAgentDataSourceMetricDimensionArray{
    		&managementagent.ManagementAgentDataSourceMetricDimensionArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	ConnectionTimeout: pulumi.Int(0),
    })
    
    var managementAgentDataSourceResource = new ManagementAgentDataSource("managementAgentDataSourceResource", ManagementAgentDataSourceArgs.builder()
        .type("string")
        .compartmentId("string")
        .url("string")
        .managementAgentId("string")
        .namespace("string")
        .name("string")
        .allowMetrics("string")
        .proxyUrl("string")
        .readDataLimitInKilobytes(0)
        .readTimeout(0)
        .resourceGroup("string")
        .scheduleMins(0)
        .metricDimensions(ManagementAgentDataSourceMetricDimensionArgs.builder()
            .name("string")
            .value("string")
            .build())
        .connectionTimeout(0)
        .build());
    
    management_agent_data_source_resource = oci.management_agent.ManagementAgentDataSource("managementAgentDataSourceResource",
        type="string",
        compartment_id="string",
        url="string",
        management_agent_id="string",
        namespace="string",
        name="string",
        allow_metrics="string",
        proxy_url="string",
        read_data_limit_in_kilobytes=0,
        read_timeout=0,
        resource_group="string",
        schedule_mins=0,
        metric_dimensions=[oci.management_agent.ManagementAgentDataSourceMetricDimensionArgs(
            name="string",
            value="string",
        )],
        connection_timeout=0)
    
    const managementAgentDataSourceResource = new oci.managementagent.ManagementAgentDataSource("managementAgentDataSourceResource", {
        type: "string",
        compartmentId: "string",
        url: "string",
        managementAgentId: "string",
        namespace: "string",
        name: "string",
        allowMetrics: "string",
        proxyUrl: "string",
        readDataLimitInKilobytes: 0,
        readTimeout: 0,
        resourceGroup: "string",
        scheduleMins: 0,
        metricDimensions: [{
            name: "string",
            value: "string",
        }],
        connectionTimeout: 0,
    });
    
    type: oci:ManagementAgent:ManagementAgentDataSource
    properties:
        allowMetrics: string
        compartmentId: string
        connectionTimeout: 0
        managementAgentId: string
        metricDimensions:
            - name: string
              value: string
        name: string
        namespace: string
        proxyUrl: string
        readDataLimitInKilobytes: 0
        readTimeout: 0
        resourceGroup: string
        scheduleMins: 0
        type: string
        url: string
    

    ManagementAgentDataSource Resource Properties

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

    Inputs

    The ManagementAgentDataSource resource accepts the following input properties:

    CompartmentId string
    Compartment owning this DataSource.
    ManagementAgentId string
    Unique Management Agent identifier
    Type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    Url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    AllowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    ConnectionTimeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    MetricDimensions List<ManagementAgentDataSourceMetricDimension>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Unique name of the DataSource.
    Namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    ProxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    ReadDataLimitInKilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadTimeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    ResourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    ScheduleMins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    CompartmentId string
    Compartment owning this DataSource.
    ManagementAgentId string
    Unique Management Agent identifier
    Type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    Url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    AllowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    ConnectionTimeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    MetricDimensions []ManagementAgentDataSourceMetricDimensionArgs
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Unique name of the DataSource.
    Namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    ProxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    ReadDataLimitInKilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadTimeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    ResourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    ScheduleMins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    compartmentId String
    Compartment owning this DataSource.
    managementAgentId String
    Unique Management Agent identifier
    type String
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url String

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics String
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    connectionTimeout Integer
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    metricDimensions List<DataSourceMetricDimension>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name String
    Unique name of the DataSource.
    namespace String
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl String
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimitInKilobytes Integer
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout Integer
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup String
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins Integer
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    compartmentId string
    Compartment owning this DataSource.
    managementAgentId string
    Unique Management Agent identifier
    type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    connectionTimeout number
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    metricDimensions ManagementAgentDataSourceMetricDimension[]
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name string
    Unique name of the DataSource.
    namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimitInKilobytes number
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout number
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins number
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    compartment_id str
    Compartment owning this DataSource.
    management_agent_id str
    Unique Management Agent identifier
    type str
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url str

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allow_metrics str
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    connection_timeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    metric_dimensions Sequence[managementagent.ManagementAgentDataSourceMetricDimensionArgs]
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name str
    Unique name of the DataSource.
    namespace str
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxy_url str
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    read_data_limit_in_kilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    read_timeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resource_group str
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    schedule_mins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    compartmentId String
    Compartment owning this DataSource.
    managementAgentId String
    Unique Management Agent identifier
    type String
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url String

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics String
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    connectionTimeout Number
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    metricDimensions List<Property Map>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name String
    Unique name of the DataSource.
    namespace String
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl String
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimitInKilobytes Number
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout Number
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup String
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins Number
    (Updatable) Number in minutes. The scraping occurs at the specified interval.

    Outputs

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

    DataSourceKey string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    ReadDataLimit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    State string
    State of the DataSource.
    TimeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    DataSourceKey string
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    ReadDataLimit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    State string
    State of the DataSource.
    TimeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    dataSourceKey String
    id String
    The provider-assigned unique ID for this managed resource.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    readDataLimit Integer
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    state String
    State of the DataSource.
    timeCreated String
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    dataSourceKey string
    id string
    The provider-assigned unique ID for this managed resource.
    isDaemonSet boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    readDataLimit number
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    state string
    State of the DataSource.
    timeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    data_source_key str
    id str
    The provider-assigned unique ID for this managed resource.
    is_daemon_set bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    read_data_limit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    state str
    State of the DataSource.
    time_created str
    The time the DataSource was created. An RFC3339 formatted datetime string
    time_updated str
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    dataSourceKey String
    id String
    The provider-assigned unique ID for this managed resource.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    readDataLimit Number
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    state String
    State of the DataSource.
    timeCreated String
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the DataSource data was last received. An RFC3339 formatted datetime string

    Look up Existing ManagementAgentDataSource Resource

    Get an existing ManagementAgentDataSource 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?: ManagementAgentDataSourceState, opts?: CustomResourceOptions): ManagementAgentDataSource
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_metrics: Optional[str] = None,
            compartment_id: Optional[str] = None,
            connection_timeout: Optional[int] = None,
            data_source_key: Optional[str] = None,
            is_daemon_set: Optional[bool] = None,
            management_agent_id: Optional[str] = None,
            metric_dimensions: Optional[Sequence[_managementagent.ManagementAgentDataSourceMetricDimensionArgs]] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            proxy_url: Optional[str] = None,
            read_data_limit: Optional[int] = None,
            read_data_limit_in_kilobytes: Optional[int] = None,
            read_timeout: Optional[int] = None,
            resource_group: Optional[str] = None,
            schedule_mins: Optional[int] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None,
            type: Optional[str] = None,
            url: Optional[str] = None) -> ManagementAgentDataSource
    func GetManagementAgentDataSource(ctx *Context, name string, id IDInput, state *ManagementAgentDataSourceState, opts ...ResourceOption) (*ManagementAgentDataSource, error)
    public static ManagementAgentDataSource Get(string name, Input<string> id, ManagementAgentDataSourceState? state, CustomResourceOptions? opts = null)
    public static ManagementAgentDataSource get(String name, Output<String> id, ManagementAgentDataSourceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AllowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    CompartmentId string
    Compartment owning this DataSource.
    ConnectionTimeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    DataSourceKey string
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    ManagementAgentId string
    Unique Management Agent identifier
    MetricDimensions List<ManagementAgentDataSourceMetricDimension>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Unique name of the DataSource.
    Namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    ProxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    ReadDataLimit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadDataLimitInKilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadTimeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    ResourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    ScheduleMins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    State string
    State of the DataSource.
    TimeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    Type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    Url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    AllowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    CompartmentId string
    Compartment owning this DataSource.
    ConnectionTimeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    DataSourceKey string
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    ManagementAgentId string
    Unique Management Agent identifier
    MetricDimensions []ManagementAgentDataSourceMetricDimensionArgs
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Unique name of the DataSource.
    Namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    ProxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    ReadDataLimit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadDataLimitInKilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    ReadTimeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    ResourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    ScheduleMins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    State string
    State of the DataSource.
    TimeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    Type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    Url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics String
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    compartmentId String
    Compartment owning this DataSource.
    connectionTimeout Integer
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    dataSourceKey String
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    managementAgentId String
    Unique Management Agent identifier
    metricDimensions List<DataSourceMetricDimension>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name String
    Unique name of the DataSource.
    namespace String
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl String
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimit Integer
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readDataLimitInKilobytes Integer
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout Integer
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup String
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins Integer
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    state String
    State of the DataSource.
    timeCreated String
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    type String
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url String

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics string
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    compartmentId string
    Compartment owning this DataSource.
    connectionTimeout number
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    dataSourceKey string
    isDaemonSet boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    managementAgentId string
    Unique Management Agent identifier
    metricDimensions ManagementAgentDataSourceMetricDimension[]
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name string
    Unique name of the DataSource.
    namespace string
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl string
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimit number
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readDataLimitInKilobytes number
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout number
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup string
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins number
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    state string
    State of the DataSource.
    timeCreated string
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    type string
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url string

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allow_metrics str
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    compartment_id str
    Compartment owning this DataSource.
    connection_timeout int
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    data_source_key str
    is_daemon_set bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    management_agent_id str
    Unique Management Agent identifier
    metric_dimensions Sequence[managementagent.ManagementAgentDataSourceMetricDimensionArgs]
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name str
    Unique name of the DataSource.
    namespace str
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxy_url str
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    read_data_limit int
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    read_data_limit_in_kilobytes int
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    read_timeout int
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resource_group str
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    schedule_mins int
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    state str
    State of the DataSource.
    time_created str
    The time the DataSource was created. An RFC3339 formatted datetime string
    time_updated str
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    type str
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url str

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    allowMetrics String
    (Updatable) Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.
    compartmentId String
    Compartment owning this DataSource.
    connectionTimeout Number
    (Updatable) Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
    dataSourceKey String
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    managementAgentId String
    Unique Management Agent identifier
    metricDimensions List<Property Map>
    (Updatable) The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name String
    Unique name of the DataSource.
    namespace String
    The Oracle Cloud Infrastructure monitoring namespace to which scraped metrics should be uploaded.
    proxyUrl String
    (Updatable) The url of the network proxy that provides access to the Prometheus Exporter's endpoint (url required property).
    readDataLimit Number
    Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readDataLimitInKilobytes Number
    (Updatable) Number in kilobytes. The limit on the data being sent, not to exceed the agent's fixed limit of 400 (KB).
    readTimeout Number
    (Updatable) Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
    resourceGroup String
    (Updatable) Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
    scheduleMins Number
    (Updatable) Number in minutes. The scraping occurs at the specified interval.
    state String
    State of the DataSource.
    timeCreated String
    The time the DataSource was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the DataSource data was last received. An RFC3339 formatted datetime string
    type String
    (Updatable) The type of the DataSource. Support types: PROMETHEUS_EMITTER
    url String

    (Updatable) The url through which the Prometheus Exporter publishes its metrics. (http only)

    ** 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

    Supporting Types

    ManagementAgentDataSourceMetricDimension, ManagementAgentDataSourceMetricDimensionArgs

    Name string
    (Updatable) Name of the metric dimension
    Value string
    (Updatable) Value of the metric dimension
    Name string
    (Updatable) Name of the metric dimension
    Value string
    (Updatable) Value of the metric dimension
    name String
    (Updatable) Name of the metric dimension
    value String
    (Updatable) Value of the metric dimension
    name string
    (Updatable) Name of the metric dimension
    value string
    (Updatable) Value of the metric dimension
    name str
    (Updatable) Name of the metric dimension
    value str
    (Updatable) Value of the metric dimension
    name String
    (Updatable) Name of the metric dimension
    value String
    (Updatable) Value of the metric dimension

    Import

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

    $ pulumi import oci:ManagementAgent/managementAgentDataSource:ManagementAgentDataSource test_management_agent_data_source "managementAgents/{managementAgentId}/dataSources/{key}"
    

    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.
    oci logo
    Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi