1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. agentregistry
  6. getAgent
Viewing docs for Google Cloud v9.32.1
published on Wednesday, Jul 29, 2026 by Pulumi
gcp logo
Viewing docs for Google Cloud v9.32.1
published on Wednesday, Jul 29, 2026 by Pulumi

    Get information about an Agent Registry Agent.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const _default = gcp.agentregistry.getAgent({
        location: "us-central1",
        agentId: "apphub-00000000-0000-0000-0000-000000000000",
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    default = gcp.agentregistry.get_agent(location="us-central1",
        agent_id="apphub-00000000-0000-0000-0000-000000000000")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/agentregistry"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := agentregistry.GetAgent(ctx, &agentregistry.GetAgentArgs{
    			Location: "us-central1",
    			AgentId:  pulumi.StringRef("apphub-00000000-0000-0000-0000-000000000000"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = Gcp.AgentRegistry.GetAgent.Invoke(new()
        {
            Location = "us-central1",
            AgentId = "apphub-00000000-0000-0000-0000-000000000000",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.agentregistry.AgentregistryFunctions;
    import com.pulumi.gcp.agentregistry.inputs.GetAgentArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 default = AgentregistryFunctions.getAgent(GetAgentArgs.builder()
                .location("us-central1")
                .agentId("apphub-00000000-0000-0000-0000-000000000000")
                .build());
    
        }
    }
    
    variables:
      default:
        fn::invoke:
          function: gcp:agentregistry:getAgent
          arguments:
            location: us-central1
            agentId: apphub-00000000-0000-0000-0000-000000000000
    
    pulumi {
      required_providers {
        gcp = {
          source = "pulumi/gcp"
        }
      }
    }
    
    data "gcp_agentregistry_getagent" "default" {
      location = "us-central1"
      agent_id = "apphub-00000000-0000-0000-0000-000000000000"
    }
    

    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,
                  filter: Optional[str] = None,
                  location: Optional[str] = None,
                  project: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetAgentResult
    def get_agent_output(agent_id: pulumi.Input[Optional[str]] = None,
                  filter: pulumi.Input[Optional[str]] = None,
                  location: pulumi.Input[Optional[str]] = None,
                  project: pulumi.Input[Optional[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)
    public static Output<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcp:agentregistry/getAgent:getAgent
      arguments:
        # arguments dictionary
    data "gcp_agentregistry_get_agent" "name" {
        # arguments
    }

    The following arguments are supported:

    Location string
    The location of the resource.


    AgentId string
    The unique identifier for the Agent. This or filter must be set.
    Filter string
    A filter string that identifies a unique Agent. This or agentId must be set.
    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    Location string
    The location of the resource.


    AgentId string
    The unique identifier for the Agent. This or filter must be set.
    Filter string
    A filter string that identifies a unique Agent. This or agentId must be set.
    Project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    The location of the resource.


    agent_id string
    The unique identifier for the Agent. This or filter must be set.
    filter string
    A filter string that identifies a unique Agent. This or agentId must be set.
    project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    The location of the resource.


    agentId String
    The unique identifier for the Agent. This or filter must be set.
    filter String
    A filter string that identifies a unique Agent. This or agentId must be set.
    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.
    location string
    The location of the resource.


    agentId string
    The unique identifier for the Agent. This or filter must be set.
    filter string
    A filter string that identifies a unique Agent. This or agentId must be set.
    project string
    The project in which the resource belongs. If it is not provided, the provider project is used.
    location str
    The location of the resource.


    agent_id str
    The unique identifier for the Agent. This or filter must be set.
    filter str
    A filter string that identifies a unique Agent. This or agentId must be set.
    project str
    The project in which the resource belongs. If it is not provided, the provider project is used.
    location String
    The location of the resource.


    agentId String
    The unique identifier for the Agent. This or filter must be set.
    filter String
    A filter string that identifies a unique Agent. This or agentId must be set.
    project String
    The project in which the resource belongs. If it is not provided, the provider project is used.

    getAgent Result

    The following output properties are available:

    AgentId string
    Attributes Dictionary<string, string>
    Attributes of the Agent.
    CreateTime string
    Create time.
    Description string
    Obtained from the A2A Agent Card. The description of the Agent.
    DisplayName string
    Obtained from the A2A Agent Card. The display name of the Agent.
    Framework string
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Project string
    Protocols List<GetAgentProtocol>
    The connection details for the Agent.
    Skills List<GetAgentSkill>
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    UpdateTime string
    Update time.
    Urn string
    The URN of the Agent.
    Version string
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    Filter string
    AgentId string
    Attributes map[string]string
    Attributes of the Agent.
    CreateTime string
    Create time.
    Description string
    Obtained from the A2A Agent Card. The description of the Agent.
    DisplayName string
    Obtained from the A2A Agent Card. The display name of the Agent.
    Framework string
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    Id string
    The provider-assigned unique ID for this managed resource.
    Location string
    Project string
    Protocols []GetAgentProtocol
    The connection details for the Agent.
    Skills []GetAgentSkill
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    UpdateTime string
    Update time.
    Urn string
    The URN of the Agent.
    Version string
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    Filter string
    agent_id string
    attributes map(string)
    Attributes of the Agent.
    create_time string
    Create time.
    description string
    Obtained from the A2A Agent Card. The description of the Agent.
    display_name string
    Obtained from the A2A Agent Card. The display name of the Agent.
    framework string
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    project string
    protocols list(object)
    The connection details for the Agent.
    skills list(object)
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    update_time string
    Update time.
    urn string
    The URN of the Agent.
    version string
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    filter string
    agentId String
    attributes Map<String,String>
    Attributes of the Agent.
    createTime String
    Create time.
    description String
    Obtained from the A2A Agent Card. The description of the Agent.
    displayName String
    Obtained from the A2A Agent Card. The display name of the Agent.
    framework String
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    project String
    protocols List<GetAgentProtocol>
    The connection details for the Agent.
    skills List<GetAgentSkill>
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    updateTime String
    Update time.
    urn String
    The URN of the Agent.
    version String
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    filter String
    agentId string
    attributes {[key: string]: string}
    Attributes of the Agent.
    createTime string
    Create time.
    description string
    Obtained from the A2A Agent Card. The description of the Agent.
    displayName string
    Obtained from the A2A Agent Card. The display name of the Agent.
    framework string
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    id string
    The provider-assigned unique ID for this managed resource.
    location string
    project string
    protocols GetAgentProtocol[]
    The connection details for the Agent.
    skills GetAgentSkill[]
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    updateTime string
    Update time.
    urn string
    The URN of the Agent.
    version string
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    filter string
    agent_id str
    attributes Mapping[str, str]
    Attributes of the Agent.
    create_time str
    Create time.
    description str
    Obtained from the A2A Agent Card. The description of the Agent.
    display_name str
    Obtained from the A2A Agent Card. The display name of the Agent.
    framework str
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    id str
    The provider-assigned unique ID for this managed resource.
    location str
    project str
    protocols Sequence[GetAgentProtocol]
    The connection details for the Agent.
    skills Sequence[GetAgentSkill]
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    update_time str
    Update time.
    urn str
    The URN of the Agent.
    version str
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    filter str
    agentId String
    attributes Map<String>
    Attributes of the Agent.
    createTime String
    Create time.
    description String
    Obtained from the A2A Agent Card. The description of the Agent.
    displayName String
    Obtained from the A2A Agent Card. The display name of the Agent.
    framework String
    The OSS Agent framework used to develop the Agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom".
    id String
    The provider-assigned unique ID for this managed resource.
    location String
    project String
    protocols List<Property Map>
    The connection details for the Agent.
    skills List<Property Map>
    Obtained from the A2A Agent Card. Skills represent the ability of an Agent. It is largely a descriptive concept but represents a more focused set of behaviors that the Agent is likely to succeed at.
    updateTime String
    Update time.
    urn String
    The URN of the Agent.
    version String
    Obtained from the A2A Agent Card. Contains the version of the Agent.
    filter String

    Supporting Types

    GetAgentProtocol

    Interfaces List<GetAgentProtocolInterface>
    The connection details for the Agent.
    ProtocolVersion string
    The version of the protocol, for example, the A2A Agent Card version.
    Type string
    The type of the protocol.
    Interfaces []GetAgentProtocolInterface
    The connection details for the Agent.
    ProtocolVersion string
    The version of the protocol, for example, the A2A Agent Card version.
    Type string
    The type of the protocol.
    interfaces list(object)
    The connection details for the Agent.
    protocol_version string
    The version of the protocol, for example, the A2A Agent Card version.
    type string
    The type of the protocol.
    interfaces List<GetAgentProtocolInterface>
    The connection details for the Agent.
    protocolVersion String
    The version of the protocol, for example, the A2A Agent Card version.
    type String
    The type of the protocol.
    interfaces GetAgentProtocolInterface[]
    The connection details for the Agent.
    protocolVersion string
    The version of the protocol, for example, the A2A Agent Card version.
    type string
    The type of the protocol.
    interfaces Sequence[GetAgentProtocolInterface]
    The connection details for the Agent.
    protocol_version str
    The version of the protocol, for example, the A2A Agent Card version.
    type str
    The type of the protocol.
    interfaces List<Property Map>
    The connection details for the Agent.
    protocolVersion String
    The version of the protocol, for example, the A2A Agent Card version.
    type String
    The type of the protocol.

    GetAgentProtocolInterface

    ProtocolBinding string
    The protocol binding of the interface.
    Url string
    The destination URL.
    ProtocolBinding string
    The protocol binding of the interface.
    Url string
    The destination URL.
    protocol_binding string
    The protocol binding of the interface.
    url string
    The destination URL.
    protocolBinding String
    The protocol binding of the interface.
    url String
    The destination URL.
    protocolBinding string
    The protocol binding of the interface.
    url string
    The destination URL.
    protocol_binding str
    The protocol binding of the interface.
    url str
    The destination URL.
    protocolBinding String
    The protocol binding of the interface.
    url String
    The destination URL.

    GetAgentSkill

    Description string
    A more detailed description of the skill.
    Examples List<string>
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    Id string
    A unique identifier for the Agent's skill.
    Name string
    A human readable name for the Agent's skill.
    Tags List<string>
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    Description string
    A more detailed description of the skill.
    Examples []string
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    Id string
    A unique identifier for the Agent's skill.
    Name string
    A human readable name for the Agent's skill.
    Tags []string
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    description string
    A more detailed description of the skill.
    examples list(string)
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    id string
    A unique identifier for the Agent's skill.
    name string
    A human readable name for the Agent's skill.
    tags list(string)
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    description String
    A more detailed description of the skill.
    examples List<String>
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    id String
    A unique identifier for the Agent's skill.
    name String
    A human readable name for the Agent's skill.
    tags List<String>
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    description string
    A more detailed description of the skill.
    examples string[]
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    id string
    A unique identifier for the Agent's skill.
    name string
    A human readable name for the Agent's skill.
    tags string[]
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    description str
    A more detailed description of the skill.
    examples Sequence[str]
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    id str
    A unique identifier for the Agent's skill.
    name str
    A human readable name for the Agent's skill.
    tags Sequence[str]
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]
    description String
    A more detailed description of the skill.
    examples List<String>
    Example prompts or scenarios that this skill can handle. Provides a hint to the client on how to use the skill. Example: [["I need a recipe for bread"]]
    id String
    A unique identifier for the Agent's skill.
    name String
    A human readable name for the Agent's skill.
    tags List<String>
    A set of keywords describing the skills. Example: [["cooking", "customer support", "billing"]]

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Viewing docs for Google Cloud v9.32.1
    published on Wednesday, Jul 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial