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

oci.CloudBridge.getAgent

Explore with Pulumi AI

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

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

    Gets an Agent by identifier.

    Example Usage

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

const testAgent = oci.CloudBridge.getAgent({
    agentId: testAgentOciCloudBridgeAgent.id,
});

    import pulumi
import pulumi_oci as oci

test_agent = oci.CloudBridge.get_agent(agent_id=test_agent_oci_cloud_bridge_agent["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudbridge.GetAgent(ctx, &cloudbridge.GetAgentArgs{
			AgentId: testAgentOciCloudBridgeAgent.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 testAgent = Oci.CloudBridge.GetAgent.Invoke(new()
    {
        AgentId = testAgentOciCloudBridgeAgent.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.CloudBridge.CloudBridgeFunctions;
import com.pulumi.oci.CloudBridge.inputs.GetAgentArgs;
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 testAgent = CloudBridgeFunctions.getAgent(GetAgentArgs.builder()
            .agentId(testAgentOciCloudBridgeAgent.id())
            .build());

    }
}

    variables:
  testAgent:
    fn::invoke:
      function: oci:CloudBridge:getAgent
      arguments:
        agentId: ${testAgentOciCloudBridgeAgent.id}

    Using getAgent

    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 getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>
    def get_agent(agent_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]
    func LookupAgent(ctx *Context, args *LookupAgentArgs, opts ...InvokeOption) (*LookupAgentResult, error)
func LookupAgentOutput(ctx *Context, args *LookupAgentOutputArgs, opts ...InvokeOption) LookupAgentResultOutput

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

    public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:CloudBridge/getAgent:getAgent
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AgentId string
    Unique Agent identifier path parameter.
    AgentId string
    Unique Agent identifier path parameter.
    agentId String
    Unique Agent identifier path parameter.
    agentId string
    Unique Agent identifier path parameter.
    agent_id str
    Unique Agent identifier path parameter.
    agentId String
    Unique Agent identifier path parameter.

    getAgent Result

    The following output properties are available:

    AgentId string
    Agent identifier.
    AgentPubKey string
    Resource principal public key.
    AgentType string
    Type of the Agent.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    Compartment identifier.
    DefinedTags Dictionary<string, string>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    Agent identifier, can be renamed.
    EnvironmentId string
    Environment identifier.
    FreeformTags Dictionary<string, string>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    Id string
    Unique identifier that is immutable on creation.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    OsVersion string
    OS version.
    PluginLists List<GetAgentPluginList>
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    SystemTags Dictionary<string, string>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    AgentId string
    Agent identifier.
    AgentPubKey string
    Resource principal public key.
    AgentType string
    Type of the Agent.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    Compartment identifier.
    DefinedTags map[string]string
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    Agent identifier, can be renamed.
    EnvironmentId string
    Environment identifier.
    FreeformTags map[string]string
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    Id string
    Unique identifier that is immutable on creation.
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    OsVersion string
    OS version.
    PluginLists []GetAgentPluginList
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    SystemTags map[string]string
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    TimeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId String
    Agent identifier.
    agentPubKey String
    Resource principal public key.
    agentType String
    Type of the Agent.
    agentVersion String
    Agent identifier.
    compartmentId String
    Compartment identifier.
    definedTags Map<String,String>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    Agent identifier, can be renamed.
    environmentId String
    Environment identifier.
    freeformTags Map<String,String>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    id String
    Unique identifier that is immutable on creation.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    osVersion String
    OS version.
    pluginLists List<GetAgentPluginList>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    systemTags Map<String,String>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId string
    Agent identifier.
    agentPubKey string
    Resource principal public key.
    agentType string
    Type of the Agent.
    agentVersion string
    Agent identifier.
    compartmentId string
    Compartment identifier.
    definedTags {[key: string]: string}
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    Agent identifier, can be renamed.
    environmentId string
    Environment identifier.
    freeformTags {[key: string]: string}
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    heartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    id string
    Unique identifier that is immutable on creation.
    lifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    osVersion string
    OS version.
    pluginLists GetAgentPluginList[]
    List of plugins associated with the agent.
    state string
    The current state of the Agent.
    systemTags {[key: string]: string}
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agent_id str
    Agent identifier.
    agent_pub_key str
    Resource principal public key.
    agent_type str
    Type of the Agent.
    agent_version str
    Agent identifier.
    compartment_id str
    Compartment identifier.
    defined_tags Mapping[str, str]
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    Agent identifier, can be renamed.
    environment_id str
    Environment identifier.
    freeform_tags Mapping[str, str]
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    heart_beat_status str
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    id str
    Unique identifier that is immutable on creation.
    lifecycle_details str
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    os_version str
    OS version.
    plugin_lists Sequence[GetAgentPluginList]
    List of plugins associated with the agent.
    state str
    The current state of the Agent.
    system_tags Mapping[str, str]
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    time_created str
    The time when the Agent was created. An RFC3339 formatted datetime string.
    time_expire_agent_key_in_ms str
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    time_last_sync_received str
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    time_updated str
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId String
    Agent identifier.
    agentPubKey String
    Resource principal public key.
    agentType String
    Type of the Agent.
    agentVersion String
    Agent identifier.
    compartmentId String
    Compartment identifier.
    definedTags Map<String>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    Agent identifier, can be renamed.
    environmentId String
    Environment identifier.
    freeformTags Map<String>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    id String
    Unique identifier that is immutable on creation.
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    osVersion String
    OS version.
    pluginLists List<Property Map>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    systemTags Map<String>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    timeCreated String
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.

    Supporting Types

    GetAgentPluginList

    AgentId string
    Unique Agent identifier path parameter.
    DefinedTags Dictionary<string, string>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags Dictionary<string, string>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    Name string
    Plugin identifier, which can be renamed.
    PluginVersion string
    Plugin version.
    State string
    The current state of the Agent.
    TimeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    AgentId string
    Unique Agent identifier path parameter.
    DefinedTags map[string]string
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformTags map[string]string
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    LifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    Name string
    Plugin identifier, which can be renamed.
    PluginVersion string
    Plugin version.
    State string
    The current state of the Agent.
    TimeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId String
    Unique Agent identifier path parameter.
    definedTags Map<String,String>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String,String>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    name String
    Plugin identifier, which can be renamed.
    pluginVersion String
    Plugin version.
    state String
    The current state of the Agent.
    timeCreated String
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId string
    Unique Agent identifier path parameter.
    definedTags {[key: string]: string}
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags {[key: string]: string}
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails string
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    name string
    Plugin identifier, which can be renamed.
    pluginVersion string
    Plugin version.
    state string
    The current state of the Agent.
    timeCreated string
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agent_id str
    Unique Agent identifier path parameter.
    defined_tags Mapping[str, str]
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_tags Mapping[str, str]
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycle_details str
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    name str
    Plugin identifier, which can be renamed.
    plugin_version str
    Plugin version.
    state str
    The current state of the Agent.
    time_created str
    The time when the Agent was created. An RFC3339 formatted datetime string.
    time_updated str
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentId String
    Unique Agent identifier path parameter.
    definedTags Map<String>
    The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformTags Map<String>
    The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}
    lifecycleDetails String
    A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
    name String
    Plugin identifier, which can be renamed.
    pluginVersion String
    Plugin version.
    state String
    The current state of the Agent.
    timeCreated String
    The time when the Agent was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.

    Package Details

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