Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.CloudBridge.getAgent
Explore with Pulumi AI
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 GetAgent(ctx *Context, args *GetAgentArgs, opts ...InvokeOption) (*GetAgentResult, error)
func GetAgentOutput(ctx *Context, args *GetAgentOutputArgs, opts ...InvokeOption) GetAgentResultOutput
> Note: This function is named GetAgent
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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:CloudBridge/getAgent:getAgent
arguments:
# arguments dictionary
The following arguments are supported:
- Agent
Id string - Unique Agent identifier path parameter.
- Agent
Id string - Unique Agent identifier path parameter.
- agent
Id String - Unique Agent identifier path parameter.
- agent
Id string - Unique Agent identifier path parameter.
- agent_
id str - Unique Agent identifier path parameter.
- agent
Id String - Unique Agent identifier path parameter.
getAgent Result
The following output properties are available:
- Agent
Id string - Agent identifier.
- Agent
Pub stringKey - Resource principal public key.
- Agent
Type string - Type of the Agent.
- Agent
Version string - Agent identifier.
- Compartment
Id string - Compartment identifier.
- 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"}
- Display
Name string - Agent identifier, can be renamed.
- Environment
Id string - Environment identifier.
- 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"}
- Heart
Beat stringStatus - The current heartbeat status of the Agent based on its timeLastSyncReceived value.
- Id string
- Unique identifier that is immutable on creation.
- Lifecycle
Details 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.
- Os
Version string - OS version.
- Plugin
Lists List<GetAgent Plugin List> - List of plugins associated with the agent.
- State string
- The current state of the Agent.
- 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}}
- Time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- Time
Expire stringAgent Key In Ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- Time
Last stringSync Received - The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- Agent
Id string - Agent identifier.
- Agent
Pub stringKey - Resource principal public key.
- Agent
Type string - Type of the Agent.
- Agent
Version string - Agent identifier.
- Compartment
Id string - Compartment identifier.
- 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"}
- Display
Name string - Agent identifier, can be renamed.
- Environment
Id string - Environment identifier.
- 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"}
- Heart
Beat stringStatus - The current heartbeat status of the Agent based on its timeLastSyncReceived value.
- Id string
- Unique identifier that is immutable on creation.
- Lifecycle
Details 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.
- Os
Version string - OS version.
- Plugin
Lists []GetAgent Plugin List - List of plugins associated with the agent.
- State string
- The current state of the Agent.
- 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}}
- Time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- Time
Expire stringAgent Key In Ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- Time
Last stringSync Received - The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent
Id String - Agent identifier.
- agent
Pub StringKey - Resource principal public key.
- agent
Type String - Type of the Agent.
- agent
Version String - Agent identifier.
- compartment
Id String - Compartment identifier.
- 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"}
- display
Name String - Agent identifier, can be renamed.
- environment
Id String - Environment identifier.
- 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"}
- heart
Beat StringStatus - The current heartbeat status of the Agent based on its timeLastSyncReceived value.
- id String
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- os
Version String - OS version.
- plugin
Lists List<GetAgent Plugin List> - List of plugins associated with the agent.
- state String
- The current state of the Agent.
- 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}}
- time
Created String - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Expire StringAgent Key In Ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- time
Last StringSync Received - The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
- time
Updated String - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent
Id string - Agent identifier.
- agent
Pub stringKey - Resource principal public key.
- agent
Type string - Type of the Agent.
- agent
Version string - Agent identifier.
- compartment
Id string - Compartment identifier.
- {[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"}
- display
Name string - Agent identifier, can be renamed.
- environment
Id string - Environment identifier.
- {[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"}
- heart
Beat stringStatus - The current heartbeat status of the Agent based on its timeLastSyncReceived value.
- id string
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- os
Version string - OS version.
- plugin
Lists GetAgent Plugin List[] - List of plugins associated with the agent.
- state string
- The current state of the Agent.
- {[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}}
- time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Expire stringAgent Key In Ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- time
Last stringSync Received - The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
- time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent_
id str - Agent identifier.
- agent_
pub_ strkey - Resource principal public key.
- agent_
type str - Type of the Agent.
- agent_
version str - Agent identifier.
- compartment_
id str - Compartment identifier.
- 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.
- 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_ strstatus - 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[cloudbridge.Get Agent Plugin List] - List of plugins associated with the agent.
- state str
- The current state of the Agent.
- 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_ stragent_ key_ in_ ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- time_
last_ strsync_ received - 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.
- agent
Id String - Agent identifier.
- agent
Pub StringKey - Resource principal public key.
- agent
Type String - Type of the Agent.
- agent
Version String - Agent identifier.
- compartment
Id String - Compartment identifier.
- 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"}
- display
Name String - Agent identifier, can be renamed.
- environment
Id String - Environment identifier.
- 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"}
- heart
Beat StringStatus - The current heartbeat status of the Agent based on its timeLastSyncReceived value.
- id String
- Unique identifier that is immutable on creation.
- lifecycle
Details 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.
- os
Version String - OS version.
- plugin
Lists List<Property Map> - List of plugins associated with the agent.
- state String
- The current state of the Agent.
- 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}}
- time
Created String - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Expire StringAgent Key In Ms - The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
- time
Last StringSync Received - The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
- time
Updated String - The time when the Agent was updated. An RFC3339 formatted datetime string.
Supporting Types
GetAgentPluginList
- Agent
Id string - Unique Agent identifier path parameter.
- 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"}
- 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"}
- Lifecycle
Details 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.
- Plugin
Version string - Plugin version.
- State string
- The current state of the Agent.
- Time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- Agent
Id string - Unique Agent identifier path parameter.
- 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"}
- 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"}
- Lifecycle
Details 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.
- Plugin
Version string - Plugin version.
- State string
- The current state of the Agent.
- Time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent
Id String - Unique Agent identifier path parameter.
- 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"}
- 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"}
- lifecycle
Details 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.
- plugin
Version String - Plugin version.
- state String
- The current state of the Agent.
- time
Created String - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Updated String - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent
Id string - Unique Agent identifier path parameter.
- {[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"}
- {[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"}
- lifecycle
Details 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.
- plugin
Version string - Plugin version.
- state string
- The current state of the Agent.
- time
Created string - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Updated string - The time when the Agent was updated. An RFC3339 formatted datetime string.
- agent_
id str - Unique Agent identifier path parameter.
- 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"}
- 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.
- agent
Id String - Unique Agent identifier path parameter.
- 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"}
- 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"}
- lifecycle
Details 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.
- plugin
Version String - Plugin version.
- state String
- The current state of the Agent.
- time
Created String - The time when the Agent was created. An RFC3339 formatted datetime string.
- time
Updated 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.