Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ManagementAgent
  5. getManagementAgent
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.ManagementAgent.getManagementAgent

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Management Agent resource in Oracle Cloud Infrastructure Management Agent service.

    Gets complete details of the inventory of a given agent id

    Example Usage

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

const testManagementAgent = oci.ManagementAgent.getManagementAgent({
    managementAgentId: testManagementAgentOciManagementAgentManagementAgent.id,
});

    import pulumi
import pulumi_oci as oci

test_management_agent = oci.ManagementAgent.get_management_agent(management_agent_id=test_management_agent_oci_management_agent_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.GetManagementAgent(ctx, &managementagent.GetManagementAgentArgs{
			ManagementAgentId: testManagementAgentOciManagementAgentManagementAgent.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 testManagementAgent = Oci.ManagementAgent.GetManagementAgent.Invoke(new()
    {
        ManagementAgentId = testManagementAgentOciManagementAgentManagementAgent.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.GetManagementAgentArgs;
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 testManagementAgent = ManagementAgentFunctions.getManagementAgent(GetManagementAgentArgs.builder()
            .managementAgentId(testManagementAgentOciManagementAgentManagementAgent.id())
            .build());

    }
}

    variables:
  testManagementAgent:
    fn::invoke:
      Function: oci:ManagementAgent:getManagementAgent
      Arguments:
        managementAgentId: ${testManagementAgentOciManagementAgentManagementAgent.id}

    Using getManagementAgent

    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 getManagementAgent(args: GetManagementAgentArgs, opts?: InvokeOptions): Promise<GetManagementAgentResult>
function getManagementAgentOutput(args: GetManagementAgentOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentResult>
    def get_management_agent(management_agent_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetManagementAgentResult
def get_management_agent_output(management_agent_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentResult]
    func GetManagementAgent(ctx *Context, args *GetManagementAgentArgs, opts ...InvokeOption) (*GetManagementAgentResult, error)
func GetManagementAgentOutput(ctx *Context, args *GetManagementAgentOutputArgs, opts ...InvokeOption) GetManagementAgentResultOutput

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

    public static class GetManagementAgent 
{
    public static Task<GetManagementAgentResult> InvokeAsync(GetManagementAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentResult> Invoke(GetManagementAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetManagementAgentResult> getManagementAgent(GetManagementAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    ManagementAgentId string
    Unique Management Agent identifier
    ManagementAgentId string
    Unique Management Agent identifier
    managementAgentId String
    Unique Management Agent identifier
    managementAgentId string
    Unique Management Agent identifier
    management_agent_id str
    Unique Management Agent identifier
    managementAgentId String
    Unique Management Agent identifier

    getManagementAgent Result

    The following output properties are available:

    AvailabilityStatus string
    The current availability status of managementAgent
    CompartmentId string
    Compartment owning this DataSource.
    DataSourceLists List<GetManagementAgentDataSourceList>
    list of dataSources associated with the agent
    DataSourceSummaryLists List<GetManagementAgentDataSourceSummaryList>
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeployPluginsIds List<string>
    DisplayName string
    Management Agent Name
    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"}
    Host string
    Management Agent host machine name
    HostId string
    Host resource ocid
    Id string
    agent identifier
    InstallKeyId string
    agent install key identifier
    InstallPath string
    Path where Management Agent is installed
    InstallType string
    The install type, either AGENT or GATEWAY
    IsAgentAutoUpgradable bool
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    IsCustomerDeployed bool
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManagedAgentId string
    ManagementAgentId string
    ManagementAgentProperties List<GetManagementAgentManagementAgentProperty>
    Additional properties for this Management Agent
    PlatformName string
    Platform Name
    PlatformType string
    Platform Type
    PlatformVersion string
    Platform Version
    PluginLists List<GetManagementAgentPluginList>
    list of managementAgentPlugins associated with the agent
    ResourceArtifactVersion string
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    State string
    The current state of managementAgent
    TimeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    TimeLastHeartbeat string
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    Version string
    Management Agent Version
    AvailabilityStatus string
    The current availability status of managementAgent
    CompartmentId string
    Compartment owning this DataSource.
    DataSourceLists []GetManagementAgentDataSourceList
    list of dataSources associated with the agent
    DataSourceSummaryLists []GetManagementAgentDataSourceSummaryList
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DeployPluginsIds []string
    DisplayName string
    Management Agent Name
    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"}
    Host string
    Management Agent host machine name
    HostId string
    Host resource ocid
    Id string
    agent identifier
    InstallKeyId string
    agent install key identifier
    InstallPath string
    Path where Management Agent is installed
    InstallType string
    The install type, either AGENT or GATEWAY
    IsAgentAutoUpgradable bool
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    IsCustomerDeployed bool
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    LifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    ManagedAgentId string
    ManagementAgentId string
    ManagementAgentProperties []GetManagementAgentManagementAgentProperty
    Additional properties for this Management Agent
    PlatformName string
    Platform Name
    PlatformType string
    Platform Type
    PlatformVersion string
    Platform Version
    PluginLists []GetManagementAgentPluginList
    list of managementAgentPlugins associated with the agent
    ResourceArtifactVersion string
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    State string
    The current state of managementAgent
    TimeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    TimeLastHeartbeat string
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    Version string
    Management Agent Version
    availabilityStatus String
    The current availability status of managementAgent
    compartmentId String
    Compartment owning this DataSource.
    dataSourceLists List<GetDataSourceList>
    list of dataSources associated with the agent
    dataSourceSummaryLists List<GetDataSourceSummaryList>
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deployPluginsIds List<String>
    displayName String
    Management Agent Name
    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"}
    host String
    Management Agent host machine name
    hostId String
    Host resource ocid
    id String
    agent identifier
    installKeyId String
    agent install key identifier
    installPath String
    Path where Management Agent is installed
    installType String
    The install type, either AGENT or GATEWAY
    isAgentAutoUpgradable Boolean
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    isCustomerDeployed Boolean
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managedAgentId String
    managementAgentId String
    managementAgentProperties List<GetProperty>
    Additional properties for this Management Agent
    platformName String
    Platform Name
    platformType String
    Platform Type
    platformVersion String
    Platform Version
    pluginLists List<GetPluginList>
    list of managementAgentPlugins associated with the agent
    resourceArtifactVersion String
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    state String
    The current state of managementAgent
    timeCreated String
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeLastHeartbeat String
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    version String
    Management Agent Version
    availabilityStatus string
    The current availability status of managementAgent
    compartmentId string
    Compartment owning this DataSource.
    dataSourceLists GetManagementAgentDataSourceList[]
    list of dataSources associated with the agent
    dataSourceSummaryLists GetManagementAgentDataSourceSummaryList[]
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deployPluginsIds string[]
    displayName string
    Management Agent Name
    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"}
    host string
    Management Agent host machine name
    hostId string
    Host resource ocid
    id string
    agent identifier
    installKeyId string
    agent install key identifier
    installPath string
    Path where Management Agent is installed
    installType string
    The install type, either AGENT or GATEWAY
    isAgentAutoUpgradable boolean
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    isCustomerDeployed boolean
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    lifecycleDetails string
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managedAgentId string
    managementAgentId string
    managementAgentProperties GetManagementAgentManagementAgentProperty[]
    Additional properties for this Management Agent
    platformName string
    Platform Name
    platformType string
    Platform Type
    platformVersion string
    Platform Version
    pluginLists GetManagementAgentPluginList[]
    list of managementAgentPlugins associated with the agent
    resourceArtifactVersion string
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    state string
    The current state of managementAgent
    timeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeLastHeartbeat string
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    version string
    Management Agent Version
    availability_status str
    The current availability status of managementAgent
    compartment_id str
    Compartment owning this DataSource.
    data_source_lists Sequence[managementagent.GetManagementAgentDataSourceList]
    list of dataSources associated with the agent
    data_source_summary_lists Sequence[managementagent.GetManagementAgentDataSourceSummaryList]
    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"}
    deploy_plugins_ids Sequence[str]
    display_name str
    Management Agent Name
    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"}
    host str
    Management Agent host machine name
    host_id str
    Host resource ocid
    id str
    agent identifier
    install_key_id str
    agent install key identifier
    install_path str
    Path where Management Agent is installed
    install_type str
    The install type, either AGENT or GATEWAY
    is_agent_auto_upgradable bool
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    is_customer_deployed bool
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    lifecycle_details str
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managed_agent_id str
    management_agent_id str
    management_agent_properties Sequence[managementagent.GetManagementAgentManagementAgentProperty]
    Additional properties for this Management Agent
    platform_name str
    Platform Name
    platform_type str
    Platform Type
    platform_version str
    Platform Version
    plugin_lists Sequence[managementagent.GetManagementAgentPluginList]
    list of managementAgentPlugins associated with the agent
    resource_artifact_version str
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    state str
    The current state of managementAgent
    time_created str
    The time the Management Agent was created. An RFC3339 formatted datetime string
    time_last_heartbeat str
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    time_updated str
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    version str
    Management Agent Version
    availabilityStatus String
    The current availability status of managementAgent
    compartmentId String
    Compartment owning this DataSource.
    dataSourceLists List<Property Map>
    list of dataSources associated with the agent
    dataSourceSummaryLists List<Property Map>
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    deployPluginsIds List<String>
    displayName String
    Management Agent Name
    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"}
    host String
    Management Agent host machine name
    hostId String
    Host resource ocid
    id String
    agent identifier
    installKeyId String
    agent install key identifier
    installPath String
    Path where Management Agent is installed
    installType String
    The install type, either AGENT or GATEWAY
    isAgentAutoUpgradable Boolean
    true if the agent can be upgraded automatically; false if it must be upgraded manually. This flag is derived from the tenancy level auto upgrade preference.
    isCustomerDeployed Boolean
    true, if the agent image is manually downloaded and installed. false, if the agent is deployed as a plugin in Oracle Cloud Agent.
    lifecycleDetails String
    A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
    managedAgentId String
    managementAgentId String
    managementAgentProperties List<Property Map>
    Additional properties for this Management Agent
    platformName String
    Platform Name
    platformType String
    Platform Type
    platformVersion String
    Platform Version
    pluginLists List<Property Map>
    list of managementAgentPlugins associated with the agent
    resourceArtifactVersion String
    Version of the deployment artifact instantiated by this Management Agent. The format for Standalone resourceMode is YYMMDD.HHMM, and the format for other modes (whose artifacts are based upon Standalone but can advance independently) is YYMMDD.HHMM.VVVVVVVVVVVV. VVVVVVVVVVVV is always a numeric value between 000000000000 and 999999999999
    state String
    The current state of managementAgent
    timeCreated String
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeLastHeartbeat String
    The time the Management Agent has last recorded its health status in telemetry. This value will be null if the agent has not recorded its health status in last 7 days. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Management Agent was last updated. An RFC3339 formatted datetime string
    version String
    Management Agent Version

    Supporting Types

    GetManagementAgentDataSourceList

    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.
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    Key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    MetricDimensions List<GetManagementAgentDataSourceListMetricDimension>
    The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Name of the property
    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).
    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
    The current state of managementAgent
    TimeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Management Agent was last updated. 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.
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    Key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    MetricDimensions []GetManagementAgentDataSourceListMetricDimension
    The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    Name string
    Name of the property
    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).
    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
    The current state of managementAgent
    TimeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Management Agent was last updated. 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.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key String
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    metricDimensions List<GetDataSourceListMetricDimension>
    The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name String
    Name of the property
    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).
    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
    The current state of managementAgent
    timeCreated String
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Management Agent was last updated. 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.
    isDaemonSet boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    metricDimensions GetManagementAgentDataSourceListMetricDimension[]
    The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name string
    Name of the property
    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).
    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
    The current state of managementAgent
    timeCreated string
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Management Agent was last updated. 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.
    is_daemon_set bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key str
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    metric_dimensions Sequence[managementagent.GetManagementAgentDataSourceListMetricDimension]
    The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.
    name str
    Name of the property
    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_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
    The current state of managementAgent
    time_created str
    The time the Management Agent was created. An RFC3339 formatted datetime string
    time_updated str
    The time the Management Agent was last updated. 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.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key String
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    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
    Name of the property
    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).
    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
    The current state of managementAgent
    timeCreated String
    The time the Management Agent was created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Management Agent was last updated. 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)

    GetManagementAgentDataSourceListMetricDimension

    Name string
    Name of the property
    Value string
    Value of the metric dimension
    Name string
    Name of the property
    Value string
    Value of the metric dimension
    name String
    Name of the property
    value String
    Value of the metric dimension
    name string
    Name of the property
    value string
    Value of the metric dimension
    name str
    Name of the property
    value str
    Value of the metric dimension
    name String
    Name of the property
    value String
    Value of the metric dimension

    GetManagementAgentDataSourceSummaryList

    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    Key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    Name string
    Name of the property
    Type string
    The type of the DataSource.
    IsDaemonSet bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    Key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    Name string
    Name of the property
    Type string
    The type of the DataSource.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key String
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    name String
    Name of the property
    type String
    The type of the DataSource.
    isDaemonSet boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key string
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    name string
    Name of the property
    type string
    The type of the DataSource.
    is_daemon_set bool
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key str
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    name str
    Name of the property
    type str
    The type of the DataSource.
    isDaemonSet Boolean
    If the Kubernetes cluster type is Daemon set then this will be set to true.
    key String
    Identifier for DataSource. This represents the type and name for the data source associated with the Management Agent.
    name String
    Name of the property
    type String
    The type of the DataSource.

    GetManagementAgentManagementAgentProperty

    Name string
    Name of the property
    Units string
    Unit for the property
    Values List<string>
    Values of the property
    Name string
    Name of the property
    Units string
    Unit for the property
    Values []string
    Values of the property
    name String
    Name of the property
    units String
    Unit for the property
    values List<String>
    Values of the property
    name string
    Name of the property
    units string
    Unit for the property
    values string[]
    Values of the property
    name str
    Name of the property
    units str
    Unit for the property
    values Sequence[str]
    Values of the property
    name String
    Name of the property
    units String
    Unit for the property
    values List<String>
    Values of the property

    GetManagementAgentPluginList

    IsEnabled bool
    flag indicating whether the plugin is in enabled mode or disabled mode.
    PluginDisplayName string
    Management Agent Plugin Identifier, can be renamed
    PluginId string
    Plugin Id
    PluginName string
    Management Agent Plugin Name
    PluginStatus string
    Plugin Status
    PluginStatusMessage string
    Status message of the Plugin
    PluginVersion string
    Plugin Version
    IsEnabled bool
    flag indicating whether the plugin is in enabled mode or disabled mode.
    PluginDisplayName string
    Management Agent Plugin Identifier, can be renamed
    PluginId string
    Plugin Id
    PluginName string
    Management Agent Plugin Name
    PluginStatus string
    Plugin Status
    PluginStatusMessage string
    Status message of the Plugin
    PluginVersion string
    Plugin Version
    isEnabled Boolean
    flag indicating whether the plugin is in enabled mode or disabled mode.
    pluginDisplayName String
    Management Agent Plugin Identifier, can be renamed
    pluginId String
    Plugin Id
    pluginName String
    Management Agent Plugin Name
    pluginStatus String
    Plugin Status
    pluginStatusMessage String
    Status message of the Plugin
    pluginVersion String
    Plugin Version
    isEnabled boolean
    flag indicating whether the plugin is in enabled mode or disabled mode.
    pluginDisplayName string
    Management Agent Plugin Identifier, can be renamed
    pluginId string
    Plugin Id
    pluginName string
    Management Agent Plugin Name
    pluginStatus string
    Plugin Status
    pluginStatusMessage string
    Status message of the Plugin
    pluginVersion string
    Plugin Version
    is_enabled bool
    flag indicating whether the plugin is in enabled mode or disabled mode.
    plugin_display_name str
    Management Agent Plugin Identifier, can be renamed
    plugin_id str
    Plugin Id
    plugin_name str
    Management Agent Plugin Name
    plugin_status str
    Plugin Status
    plugin_status_message str
    Status message of the Plugin
    plugin_version str
    Plugin Version
    isEnabled Boolean
    flag indicating whether the plugin is in enabled mode or disabled mode.
    pluginDisplayName String
    Management Agent Plugin Identifier, can be renamed
    pluginId String
    Plugin Id
    pluginName String
    Management Agent Plugin Name
    pluginStatus String
    Plugin Status
    pluginStatusMessage String
    Status message of the Plugin
    pluginVersion String
    Plugin Version

    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.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci