Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.ManagementAgent.getManagementAgentDataSource

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testManagementAgentDataSource = oci.ManagementAgent.getManagementAgentDataSource({
    dataSourceKey: managementAgentDataSourceDataSourceKey,
    managementAgentId: testManagementAgent.id,
});

import pulumi
import pulumi_oci as oci

test_management_agent_data_source = oci.ManagementAgent.get_management_agent_data_source(data_source_key=management_agent_data_source_data_source_key,
    management_agent_id=test_management_agent["id"])

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/ManagementAgent"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ManagementAgent.GetManagementAgentDataSource(ctx, &managementagent.GetManagementAgentDataSourceArgs{
			DataSourceKey:     managementAgentDataSourceDataSourceKey,
			ManagementAgentId: testManagementAgent.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 testManagementAgentDataSource = Oci.ManagementAgent.GetManagementAgentDataSource.Invoke(new()
    {
        DataSourceKey = managementAgentDataSourceDataSourceKey,
        ManagementAgentId = testManagementAgent.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ManagementAgent.ManagementAgentFunctions;
import com.pulumi.oci.ManagementAgent.inputs.GetManagementAgentDataSourceArgs;
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 testManagementAgentDataSource = ManagementAgentFunctions.getManagementAgentDataSource(GetManagementAgentDataSourceArgs.builder()
            .dataSourceKey(managementAgentDataSourceDataSourceKey)
            .managementAgentId(testManagementAgent.id())
            .build());

    }
}

variables:
  testManagementAgentDataSource:
    fn::invoke:
      Function: oci:ManagementAgent:getManagementAgentDataSource
      Arguments:
        dataSourceKey: ${managementAgentDataSourceDataSourceKey}
        managementAgentId: ${testManagementAgent.id}

Using getManagementAgentDataSource

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 getManagementAgentDataSource(args: GetManagementAgentDataSourceArgs, opts?: InvokeOptions): Promise<GetManagementAgentDataSourceResult>
function getManagementAgentDataSourceOutput(args: GetManagementAgentDataSourceOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentDataSourceResult>

def get_management_agent_data_source(data_source_key: Optional[str] = None,
                                     management_agent_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetManagementAgentDataSourceResult
def get_management_agent_data_source_output(data_source_key: Optional[pulumi.Input[str]] = None,
                                     management_agent_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentDataSourceResult]

func GetManagementAgentDataSource(ctx *Context, args *GetManagementAgentDataSourceArgs, opts ...InvokeOption) (*GetManagementAgentDataSourceResult, error)
func GetManagementAgentDataSourceOutput(ctx *Context, args *GetManagementAgentDataSourceOutputArgs, opts ...InvokeOption) GetManagementAgentDataSourceResultOutput

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

public static class GetManagementAgentDataSource 
{
    public static Task<GetManagementAgentDataSourceResult> InvokeAsync(GetManagementAgentDataSourceArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentDataSourceResult> Invoke(GetManagementAgentDataSourceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementAgentDataSourceResult> getManagementAgentDataSource(GetManagementAgentDataSourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:ManagementAgent/getManagementAgentDataSource:getManagementAgentDataSource
  arguments:
    # arguments dictionary

The following arguments are supported:

DataSourceKey string: Data source type and name identifier.
ManagementAgentId string: Unique Management Agent identifier

DataSourceKey string: Data source type and name identifier.
ManagementAgentId string: Unique Management Agent identifier

dataSourceKey String: Data source type and name identifier.
managementAgentId String: Unique Management Agent identifier

dataSourceKey string: Data source type and name identifier.
managementAgentId string: Unique Management Agent identifier

data_source_key str: Data source type and name identifier.
management_agent_id str: Unique Management Agent identifier

dataSourceKey String: Data source type and name identifier.
managementAgentId String: Unique Management Agent identifier

getManagementAgentDataSource Result

The following output properties are available:

AllowMetrics string: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
DataSourceKey string
Id string
IsDaemonSet bool: If the Kubernetes cluster type is Daemon set then this will be set to true.
ManagementAgentId string
MetricDimensions List<GetManagementAgentDataSourceMetricDimension>: 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: 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
ReadTimeout int: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
ResourceGroup string: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
ScheduleMins int: 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: The type of the DataSource.
Url string: The url through which the Prometheus Exporter publishes its metrics. (http only)

AllowMetrics string: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
DataSourceKey string
Id string
IsDaemonSet bool: If the Kubernetes cluster type is Daemon set then this will be set to true.
ManagementAgentId string
MetricDimensions []GetManagementAgentDataSourceMetricDimension: 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: 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
ReadTimeout int: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
ResourceGroup string: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
ScheduleMins int: 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: The type of the DataSource.
Url string: The url through which the Prometheus Exporter publishes its metrics. (http only)

allowMetrics String: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
dataSourceKey String
id String
isDaemonSet Boolean: If the Kubernetes cluster type is Daemon set then this will be set to true.
managementAgentId String
metricDimensions List<GetDataSourceMetricDimension>: 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: 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
readTimeout Integer: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
resourceGroup String: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
scheduleMins Integer: 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: The type of the DataSource.
url String: The url through which the Prometheus Exporter publishes its metrics. (http only)

allowMetrics string: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
dataSourceKey string
id string
isDaemonSet boolean: If the Kubernetes cluster type is Daemon set then this will be set to true.
managementAgentId string
metricDimensions GetManagementAgentDataSourceMetricDimension[]: 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: 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
readTimeout number: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
resourceGroup string: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
scheduleMins number: 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: The type of the DataSource.
url string: The url through which the Prometheus Exporter publishes its metrics. (http only)

allow_metrics str: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
data_source_key str
id str
is_daemon_set bool: If the Kubernetes cluster type is Daemon set then this will be set to true.
management_agent_id str
metric_dimensions Sequence[managementagent.GetManagementAgentDataSourceMetricDimension]: 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: 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
read_timeout int: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
resource_group str: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
schedule_mins int: 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: The type of the DataSource.
url str: The url through which the Prometheus Exporter publishes its metrics. (http only)

allowMetrics String: 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: Number in milliseconds. The timeout for connecting to the Prometheus Exporter's endpoint.
dataSourceKey String
id String
isDaemonSet Boolean: If the Kubernetes cluster type is Daemon set then this will be set to true.
managementAgentId String
metricDimensions List<Property Map>: 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: 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
readTimeout Number: Number in milliseconds. The timeout for reading the response from the Prometheus Exporter's endpoint.
resourceGroup String: Oracle Cloud Infrastructure monitoring resource group to assign the metric to.
scheduleMins Number: 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: The type of the DataSource.
url String: The url through which the Prometheus Exporter publishes its metrics. (http only)

Supporting Types

GetManagementAgentDataSourceMetricDimension

Name string: Unique name of the DataSource.
Value string: Value of the metric dimension

Name string: Unique name of the DataSource.
Value string: Value of the metric dimension

name String: Unique name of the DataSource.
value String: Value of the metric dimension

name string: Unique name of the DataSource.
value string: Value of the metric dimension

name str: Unique name of the DataSource.
value str: Value of the metric dimension

name String: Unique name of the DataSource.
value String: Value of the metric dimension

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.ManagementAgent.getManagementAgentDataSource

On this page

On this page

Example Usage

Using getManagementAgentDataSource

getManagementAgentDataSource Result

Supporting Types

GetManagementAgentDataSourceMetricDimension

Package Details

On this page

On this page