Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Google Cloud (GCP) Classic
  4. API Docs
  5. agentregistry
  6. Binding
Viewing docs for Google Cloud v9.32.1
published on Wednesday, Jul 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

gcp.agentregistry.Binding

gcp logo
Viewing docs for Google Cloud v9.32.1
published on Wednesday, Jul 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-gcp

    Represents a user-defined Binding.

    Example Usage

    Agent Registry Binding Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as google from "@pulumi/google";

const _default = gcp.agentregistry.getAgent({
    location: "global",
    filter: "displayName:Workspace Agent",
});
const defaultIamConnectorsConnector = new google.index.IamConnectorsConnector("default", {
    location: "us-central1",
    connectorId: "ar-binding",
    connectorTypeParams: [{
        connectorVersion: "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1",
    }],
});
const defaultBinding = new gcp.agentregistry.Binding("default", {
    location: "us-central1",
    bindingId: "ar-binding",
    displayName: "My Binding",
    description: "My GA agent registry binding",
    source: {
        identifier: _default.then(_default => _default.urn),
    },
    target: {
        identifier: _default.then(_default => _default.urn),
    },
    authProviderBinding: {
        authProvider: defaultIamConnectorsConnector.id,
        scopes: ["https://www.googleapis.com/auth/cloud-platform"],
        continueUri: "https://example.com/continue",
    },
}, {
    dependsOn: [defaultIamConnectorsConnector],
});

    import pulumi
import pulumi_gcp as gcp
import pulumi_google as google

default = gcp.agentregistry.get_agent(location="global",
    filter="displayName:Workspace Agent")
default_iam_connectors_connector = google.IamConnectorsConnector("default",
    location=us-central1,
    connector_id=ar-binding,
    connector_type_params=[{
        connectorVersion: projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1,
    }])
default_binding = gcp.agentregistry.Binding("default",
    location="us-central1",
    binding_id="ar-binding",
    display_name="My Binding",
    description="My GA agent registry binding",
    source={
        "identifier": default.urn,
    },
    target={
        "identifier": default.urn,
    },
    auth_provider_binding={
        "auth_provider": default_iam_connectors_connector["id"],
        "scopes": ["https://www.googleapis.com/auth/cloud-platform"],
        "continue_uri": "https://example.com/continue",
    },
    opts = pulumi.ResourceOptions(depends_on=[default_iam_connectors_connector]))

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/agentregistry"
	"github.com/pulumi/pulumi-google/sdk/go/google"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := agentregistry.GetAgent(ctx, &agentregistry.GetAgentArgs{
			Location: "global",
			Filter:   pulumi.StringRef("displayName:Workspace Agent"),
		}, nil)
		if err != nil {
			return err
		}
		defaultIamConnectorsConnector, err := google.NewIamConnectorsConnector(ctx, "default", &google.IamConnectorsConnectorArgs{
			Location:    "us-central1",
			ConnectorId: "ar-binding",
			ConnectorTypeParams: []map[string]interface{}{
				map[string]interface{}{
					"connectorVersion": "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1",
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = agentregistry.NewBinding(ctx, "default", &agentregistry.BindingArgs{
			Location:    pulumi.String("us-central1"),
			BindingId:   pulumi.String("ar-binding"),
			DisplayName: pulumi.String("My Binding"),
			Description: pulumi.String("My GA agent registry binding"),
			Source: &agentregistry.BindingSourceArgs{
				Identifier: pulumi.String(_default.Urn),
			},
			Target: &agentregistry.BindingTargetArgs{
				Identifier: pulumi.String(_default.Urn),
			},
			AuthProviderBinding: &agentregistry.BindingAuthProviderBindingArgs{
				AuthProvider: defaultIamConnectorsConnector.Id,
				Scopes: pulumi.StringArray{
					pulumi.String("https://www.googleapis.com/auth/cloud-platform"),
				},
				ContinueUri: pulumi.String("https://example.com/continue"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			defaultIamConnectorsConnector,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Google = Pulumi.Google;

return await Deployment.RunAsync(() => 
{
    var @default = Gcp.AgentRegistry.GetAgent.Invoke(new()
    {
        Location = "global",
        Filter = "displayName:Workspace Agent",
    });

    var defaultIamConnectorsConnector = new Google.IamConnectorsConnector("default", new()
    {
        Location = "us-central1",
        ConnectorId = "ar-binding",
        ConnectorTypeParams = new[]
        {
            
            {
                { "connectorVersion", "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1" },
            },
        },
    });

    var defaultBinding = new Gcp.AgentRegistry.Binding("default", new()
    {
        Location = "us-central1",
        BindingId = "ar-binding",
        DisplayName = "My Binding",
        Description = "My GA agent registry binding",
        Source = new Gcp.AgentRegistry.Inputs.BindingSourceArgs
        {
            Identifier = @default.Apply(@default => @default.Apply(getAgentResult => getAgentResult.Urn)),
        },
        Target = new Gcp.AgentRegistry.Inputs.BindingTargetArgs
        {
            Identifier = @default.Apply(@default => @default.Apply(getAgentResult => getAgentResult.Urn)),
        },
        AuthProviderBinding = new Gcp.AgentRegistry.Inputs.BindingAuthProviderBindingArgs
        {
            AuthProvider = defaultIamConnectorsConnector.Id,
            Scopes = new[]
            {
                "https://www.googleapis.com/auth/cloud-platform",
            },
            ContinueUri = "https://example.com/continue",
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            defaultIamConnectorsConnector,
        },
    });

});

    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 com.pulumi.google.IamConnectorsConnector;
import com.pulumi.google.IamConnectorsConnectorArgs;
import com.pulumi.gcp.agentregistry.Binding;
import com.pulumi.gcp.agentregistry.BindingArgs;
import com.pulumi.gcp.agentregistry.inputs.BindingSourceArgs;
import com.pulumi.gcp.agentregistry.inputs.BindingTargetArgs;
import com.pulumi.gcp.agentregistry.inputs.BindingAuthProviderBindingArgs;
import com.pulumi.resources.CustomResourceOptions;
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("global")
            .filter("displayName:Workspace Agent")
            .build());

        var defaultIamConnectorsConnector = new IamConnectorsConnector("defaultIamConnectorsConnector", IamConnectorsConnectorArgs.builder()
            .location("us-central1")
            .connectorId("ar-binding")
            .connectorTypeParams(Arrays.asList(Map.of("connectorVersion", "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1")))
            .build());

        var defaultBinding = new Binding("defaultBinding", BindingArgs.builder()
            .location("us-central1")
            .bindingId("ar-binding")
            .displayName("My Binding")
            .description("My GA agent registry binding")
            .source(BindingSourceArgs.builder()
                .identifier(default_.urn())
                .build())
            .target(BindingTargetArgs.builder()
                .identifier(default_.urn())
                .build())
            .authProviderBinding(BindingAuthProviderBindingArgs.builder()
                .authProvider(defaultIamConnectorsConnector.id())
                .scopes("https://www.googleapis.com/auth/cloud-platform")
                .continueUri("https://example.com/continue")
                .build())
            .build(), CustomResourceOptions.builder()
                .dependsOn(defaultIamConnectorsConnector)
                .build());

    }
}

    resources:
  defaultBinding:
    type: gcp:agentregistry:Binding
    name: default
    properties:
      location: us-central1
      bindingId: ar-binding
      displayName: My Binding
      description: My GA agent registry binding
      source:
        identifier: ${default.urn}
      target:
        identifier: ${default.urn}
      authProviderBinding:
        authProvider: ${defaultIamConnectorsConnector.id}
        scopes:
          - https://www.googleapis.com/auth/cloud-platform
        continueUri: https://example.com/continue
    options:
      dependsOn:
        - ${defaultIamConnectorsConnector}
  defaultIamConnectorsConnector:
    type: google:IamConnectorsConnector
    name: default
    properties:
      location: us-central1
      connectorId: ar-binding
      connectorTypeParams:
        - connectorVersion: projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1
variables:
  default:
    fn::invoke:
      function: gcp:agentregistry:getAgent
      arguments:
        location: global
        filter: displayName:Workspace Agent

    pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_agentregistry_getagent" "default" {
  location = "global"
  filter   = "displayName:Workspace Agent"
}

resource "gcp_agentregistry_binding" "default" {
  depends_on   = [google_iamconnectorsconnector.default]
  location     = "us-central1"
  binding_id   = "ar-binding"
  display_name = "My Binding"
  description  = "My GA agent registry binding"
  source = {
    identifier = data.gcp_agentregistry_getagent.default.urn
  }
  target = {
    identifier = data.gcp_agentregistry_getagent.default.urn
  }
  auth_provider_binding = {
    auth_provider = google_iamconnectorsconnector.default.id
    scopes        = ["https://www.googleapis.com/auth/cloud-platform"]
    continue_uri  = "https://example.com/continue"
  }
}
resource "google_iamconnectorsconnector" "default" {
  location     = "us-central1"
  connector_id = "ar-binding"
  connector_type_params = [{
    "connectorVersion" = "projects/my-project-name/locations/global/providers/gcp/connectors/pubsub/versions/1"
  }]
}

    Create Binding Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Binding(name: string, args: BindingArgs, opts?: CustomResourceOptions);
    @overload
def Binding(resource_name: str,
            args: BindingArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Binding(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auth_provider_binding: Optional[BindingAuthProviderBindingArgs] = None,
            binding_id: Optional[str] = None,
            location: Optional[str] = None,
            source: Optional[BindingSourceArgs] = None,
            target: Optional[BindingTargetArgs] = None,
            deletion_policy: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            project: Optional[str] = None)
    func NewBinding(ctx *Context, name string, args BindingArgs, opts ...ResourceOption) (*Binding, error)
    public Binding(string name, BindingArgs args, CustomResourceOptions? opts = null)
    public Binding(String name, BindingArgs args)
public Binding(String name, BindingArgs args, CustomResourceOptions options)

    type: gcp:agentregistry:Binding
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "gcp_agentregistry_binding" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BindingArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var bindingResource = new Gcp.AgentRegistry.Binding("bindingResource", new()
{
    AuthProviderBinding = new Gcp.AgentRegistry.Inputs.BindingAuthProviderBindingArgs
    {
        AuthProvider = "string",
        ContinueUri = "string",
        Scopes = new[]
        {
            "string",
        },
    },
    BindingId = "string",
    Location = "string",
    Source = new Gcp.AgentRegistry.Inputs.BindingSourceArgs
    {
        Identifier = "string",
    },
    Target = new Gcp.AgentRegistry.Inputs.BindingTargetArgs
    {
        Identifier = "string",
    },
    DeletionPolicy = "string",
    Description = "string",
    DisplayName = "string",
    Project = "string",
});

    example, err := agentregistry.NewBinding(ctx, "bindingResource", &agentregistry.BindingArgs{
	AuthProviderBinding: &agentregistry.BindingAuthProviderBindingArgs{
		AuthProvider: pulumi.String("string"),
		ContinueUri:  pulumi.String("string"),
		Scopes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	BindingId: pulumi.String("string"),
	Location:  pulumi.String("string"),
	Source: &agentregistry.BindingSourceArgs{
		Identifier: pulumi.String("string"),
	},
	Target: &agentregistry.BindingTargetArgs{
		Identifier: pulumi.String("string"),
	},
	DeletionPolicy: pulumi.String("string"),
	Description:    pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
	Project:        pulumi.String("string"),
})

    resource "gcp_agentregistry_binding" "bindingResource" {
  lifecycle {
    create_before_destroy = true
  }
  auth_provider_binding = {
    auth_provider = "string"
    continue_uri  = "string"
    scopes        = ["string"]
  }
  binding_id = "string"
  location   = "string"
  source = {
    identifier = "string"
  }
  target = {
    identifier = "string"
  }
  deletion_policy = "string"
  description     = "string"
  display_name    = "string"
  project         = "string"
}

    var bindingResource = new Binding("bindingResource", BindingArgs.builder()
    .authProviderBinding(BindingAuthProviderBindingArgs.builder()
        .authProvider("string")
        .continueUri("string")
        .scopes("string")
        .build())
    .bindingId("string")
    .location("string")
    .source(BindingSourceArgs.builder()
        .identifier("string")
        .build())
    .target(BindingTargetArgs.builder()
        .identifier("string")
        .build())
    .deletionPolicy("string")
    .description("string")
    .displayName("string")
    .project("string")
    .build());

    binding_resource = gcp.agentregistry.Binding("bindingResource",
    auth_provider_binding={
        "auth_provider": "string",
        "continue_uri": "string",
        "scopes": ["string"],
    },
    binding_id="string",
    location="string",
    source={
        "identifier": "string",
    },
    target={
        "identifier": "string",
    },
    deletion_policy="string",
    description="string",
    display_name="string",
    project="string")

    const bindingResource = new gcp.agentregistry.Binding("bindingResource", {
    authProviderBinding: {
        authProvider: "string",
        continueUri: "string",
        scopes: ["string"],
    },
    bindingId: "string",
    location: "string",
    source: {
        identifier: "string",
    },
    target: {
        identifier: "string",
    },
    deletionPolicy: "string",
    description: "string",
    displayName: "string",
    project: "string",
});

    type: gcp:agentregistry:Binding
properties:
    authProviderBinding:
        authProvider: string
        continueUri: string
        scopes:
            - string
    bindingId: string
    deletionPolicy: string
    description: string
    displayName: string
    location: string
    project: string
    source:
        identifier: string
    target:
        identifier: string

    Binding Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Binding resource accepts the following input properties:

    AuthProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    BindingId string
    The name of the Binding.
    Location string
    The location of the resource.
    Source BindingSource
    The source of the Binding. Structure is documented below.
    Target BindingTarget
    The target of the Binding. Structure is documented below.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    The description of the Binding.
    DisplayName string
    User-defined display name for the Binding.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    AuthProviderBinding BindingAuthProviderBindingArgs
    The auth provider of the Binding. Structure is documented below.
    BindingId string
    The name of the Binding.
    Location string
    The location of the resource.
    Source BindingSourceArgs
    The source of the Binding. Structure is documented below.
    Target BindingTargetArgs
    The target of the Binding. Structure is documented below.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    The description of the Binding.
    DisplayName string
    User-defined display name for the Binding.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    auth_provider_binding object
    The auth provider of the Binding. Structure is documented below.
    binding_id string
    The name of the Binding.
    location string
    The location of the resource.
    source object
    The source of the Binding. Structure is documented below.
    target object
    The target of the Binding. Structure is documented below.
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    The description of the Binding.
    display_name string
    User-defined display name for the Binding.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    authProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    bindingId String
    The name of the Binding.
    location String
    The location of the resource.
    source BindingSource
    The source of the Binding. Structure is documented below.
    target BindingTarget
    The target of the Binding. Structure is documented below.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    The description of the Binding.
    displayName String
    User-defined display name for the Binding.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    authProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    bindingId string
    The name of the Binding.
    location string
    The location of the resource.
    source BindingSource
    The source of the Binding. Structure is documented below.
    target BindingTarget
    The target of the Binding. Structure is documented below.
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    The description of the Binding.
    displayName string
    User-defined display name for the Binding.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    auth_provider_binding BindingAuthProviderBindingArgs
    The auth provider of the Binding. Structure is documented below.
    binding_id str
    The name of the Binding.
    location str
    The location of the resource.
    source BindingSourceArgs
    The source of the Binding. Structure is documented below.
    target BindingTargetArgs
    The target of the Binding. Structure is documented below.
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    The description of the Binding.
    display_name str
    User-defined display name for the Binding.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    authProviderBinding Property Map
    The auth provider of the Binding. Structure is documented below.
    bindingId String
    The name of the Binding.
    location String
    The location of the resource.
    source Property Map
    The source of the Binding. Structure is documented below.
    target Property Map
    The target of the Binding. Structure is documented below.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    The description of the Binding.
    displayName String
    User-defined display name for the Binding.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Binding resource produces the following output properties:

    CreateTime string
    The timestamp when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Binding.
    UpdateTime string
    The timestamp when the resource was updated.
    CreateTime string
    The timestamp when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the Binding.
    UpdateTime string
    The timestamp when the resource was updated.
    create_time string
    The timestamp when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the Binding.
    update_time string
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Binding.
    updateTime String
    The timestamp when the resource was updated.
    createTime string
    The timestamp when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the Binding.
    updateTime string
    The timestamp when the resource was updated.
    create_time str
    The timestamp when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the Binding.
    update_time str
    The timestamp when the resource was updated.
    createTime String
    The timestamp when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the Binding.
    updateTime String
    The timestamp when the resource was updated.

    Look up Existing Binding Resource

    Get an existing Binding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: BindingState, opts?: CustomResourceOptions): Binding
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_provider_binding: Optional[BindingAuthProviderBindingArgs] = None,
        binding_id: Optional[str] = None,
        create_time: Optional[str] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        source: Optional[BindingSourceArgs] = None,
        target: Optional[BindingTargetArgs] = None,
        update_time: Optional[str] = None) -> Binding
    func GetBinding(ctx *Context, name string, id IDInput, state *BindingState, opts ...ResourceOption) (*Binding, error)
    public static Binding Get(string name, Input<string> id, BindingState? state, CustomResourceOptions? opts = null)
    public static Binding get(String name, Output<String> id, BindingState state, CustomResourceOptions options)
    resources:  _:    type: gcp:agentregistry:Binding    get:      id: ${id}
    import {
  to = gcp_agentregistry_binding.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    BindingId string
    The name of the Binding.
    CreateTime string
    The timestamp when the resource was created.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    The description of the Binding.
    DisplayName string
    User-defined display name for the Binding.
    Location string
    The location of the resource.
    Name string
    The resource name of the Binding.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Source BindingSource
    The source of the Binding. Structure is documented below.
    Target BindingTarget
    The target of the Binding. Structure is documented below.
    UpdateTime string
    The timestamp when the resource was updated.
    AuthProviderBinding BindingAuthProviderBindingArgs
    The auth provider of the Binding. Structure is documented below.
    BindingId string
    The name of the Binding.
    CreateTime string
    The timestamp when the resource was created.
    DeletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    Description string
    The description of the Binding.
    DisplayName string
    User-defined display name for the Binding.
    Location string
    The location of the resource.
    Name string
    The resource name of the Binding.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Source BindingSourceArgs
    The source of the Binding. Structure is documented below.
    Target BindingTargetArgs
    The target of the Binding. Structure is documented below.
    UpdateTime string
    The timestamp when the resource was updated.
    auth_provider_binding object
    The auth provider of the Binding. Structure is documented below.
    binding_id string
    The name of the Binding.
    create_time string
    The timestamp when the resource was created.
    deletion_policy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    The description of the Binding.
    display_name string
    User-defined display name for the Binding.
    location string
    The location of the resource.
    name string
    The resource name of the Binding.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    source object
    The source of the Binding. Structure is documented below.
    target object
    The target of the Binding. Structure is documented below.
    update_time string
    The timestamp when the resource was updated.
    authProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    bindingId String
    The name of the Binding.
    createTime String
    The timestamp when the resource was created.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    The description of the Binding.
    displayName String
    User-defined display name for the Binding.
    location String
    The location of the resource.
    name String
    The resource name of the Binding.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    source BindingSource
    The source of the Binding. Structure is documented below.
    target BindingTarget
    The target of the Binding. Structure is documented below.
    updateTime String
    The timestamp when the resource was updated.
    authProviderBinding BindingAuthProviderBinding
    The auth provider of the Binding. Structure is documented below.
    bindingId string
    The name of the Binding.
    createTime string
    The timestamp when the resource was created.
    deletionPolicy string
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description string
    The description of the Binding.
    displayName string
    User-defined display name for the Binding.
    location string
    The location of the resource.
    name string
    The resource name of the Binding.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    source BindingSource
    The source of the Binding. Structure is documented below.
    target BindingTarget
    The target of the Binding. Structure is documented below.
    updateTime string
    The timestamp when the resource was updated.
    auth_provider_binding BindingAuthProviderBindingArgs
    The auth provider of the Binding. Structure is documented below.
    binding_id str
    The name of the Binding.
    create_time str
    The timestamp when the resource was created.
    deletion_policy str
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description str
    The description of the Binding.
    display_name str
    User-defined display name for the Binding.
    location str
    The location of the resource.
    name str
    The resource name of the Binding.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    source BindingSourceArgs
    The source of the Binding. Structure is documented below.
    target BindingTargetArgs
    The target of the Binding. Structure is documented below.
    update_time str
    The timestamp when the resource was updated.
    authProviderBinding Property Map
    The auth provider of the Binding. Structure is documented below.
    bindingId String
    The name of the Binding.
    createTime String
    The timestamp when the resource was created.
    deletionPolicy String
    Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
    description String
    The description of the Binding.
    displayName String
    User-defined display name for the Binding.
    location String
    The location of the resource.
    name String
    The resource name of the Binding.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    source Property Map
    The source of the Binding. Structure is documented below.
    target Property Map
    The target of the Binding. Structure is documented below.
    updateTime String
    The timestamp when the resource was updated.

    Supporting Types

    BindingAuthProviderBinding, BindingAuthProviderBindingArgs

    AuthProvider string
    The resource name of the target auth provider.
    ContinueUri string
    The continue URI of the auth provider.
    Scopes List<string>
    The list of OAuth2 scopes of the auth provider.
    AuthProvider string
    The resource name of the target auth provider.
    ContinueUri string
    The continue URI of the auth provider.
    Scopes []string
    The list of OAuth2 scopes of the auth provider.
    auth_provider string
    The resource name of the target auth provider.
    continue_uri string
    The continue URI of the auth provider.
    scopes list(string)
    The list of OAuth2 scopes of the auth provider.
    authProvider String
    The resource name of the target auth provider.
    continueUri String
    The continue URI of the auth provider.
    scopes List<String>
    The list of OAuth2 scopes of the auth provider.
    authProvider string
    The resource name of the target auth provider.
    continueUri string
    The continue URI of the auth provider.
    scopes string[]
    The list of OAuth2 scopes of the auth provider.
    auth_provider str
    The resource name of the target auth provider.
    continue_uri str
    The continue URI of the auth provider.
    scopes Sequence[str]
    The list of OAuth2 scopes of the auth provider.
    authProvider String
    The resource name of the target auth provider.
    continueUri String
    The continue URI of the auth provider.
    scopes List<String>
    The list of OAuth2 scopes of the auth provider.

    BindingSource, BindingSourceArgs

    Identifier string
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    Identifier string
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    identifier string
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    identifier String
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    identifier string
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    identifier str
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}
    identifier String
    The identifier of the source Agent. Format: urn:agent:{publisher}:{namespace}:{name}

    BindingTarget, BindingTargetArgs

    Identifier string
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    Identifier string
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    identifier string
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    identifier String
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    identifier string
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    identifier str
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}
    identifier String
    The identifier of the target Agent, MCP Server, or Endpoint. Format:

    • urn:agent:{publisher}:{namespace}:{name}
    • urn:mcp:{publisher}:{namespace}:{name}
    • urn:endpoint:{publisher}:{namespace}:{name}

    Import

    Binding can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/bindings/{{binding_id}}
    • {{project}}/{{location}}/{{binding_id}}
    • {{location}}/{{binding_id}}

    When using the pulumi import command, Binding can be imported using one of the formats above. For example:

    $ pulumi import gcp:agentregistry/binding:Binding default projects/{{project}}/locations/{{location}}/bindings/{{binding_id}}
$ pulumi import gcp:agentregistry/binding:Binding default {{project}}/{{location}}/{{binding_id}}
$ pulumi import gcp:agentregistry/binding:Binding default {{location}}/{{binding_id}}

    To learn more about importing existing cloud resources, see Importing resources.

    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
    Schema (JSON)
    pulumi/pulumi-gcp

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial