Service class

Service manages a service in a management boundary

Example Usage

Agent Registry Service Basic

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

const _default = new gcp.agentregistry.Service("default", {
    location: "us-central1",
    serviceId: "service",
    description: "My basic agent registry service",
    displayName: "My Service",
    interfaces: [{
        url: "https://www.google.com/service",
        protocolBinding: "GRPC",
    }],
    agentSpec: {
        type: "NO_SPEC",
    },
});

import pulumi
import pulumi_gcp as gcp

default = gcp.agentregistry.Service("default",
    location="us-central1",
    service_id="service",
    description="My basic agent registry service",
    display_name="My Service",
    interfaces=[{
        "url": "https://www.google.com/service",
        "protocol_binding": "GRPC",
    }],
    agent_spec={
        "type": "NO_SPEC",
    })

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.AgentRegistry.Service("default", new()
    {
        Location = "us-central1",
        ServiceId = "service",
        Description = "My basic agent registry service",
        DisplayName = "My Service",
        Interfaces = new[]
        {
            new Gcp.AgentRegistry.Inputs.ServiceInterfaceArgs
            {
                Url = "https://www.google.com/service",
                ProtocolBinding = "GRPC",
            },
        },
        AgentSpec = new Gcp.AgentRegistry.Inputs.ServiceAgentSpecArgs
        {
            Type = "NO_SPEC",
        },
    });

});

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.NewService(ctx, "default", &agentregistry.ServiceArgs{
			Location:    pulumi.String("us-central1"),
			ServiceId:   pulumi.String("service"),
			Description: pulumi.String("My basic agent registry service"),
			DisplayName: pulumi.String("My Service"),
			Interfaces: agentregistry.ServiceInterfaceArray{
				&agentregistry.ServiceInterfaceArgs{
					Url:             pulumi.String("https://www.google.com/service"),
					ProtocolBinding: pulumi.String("GRPC"),
				},
			},
			AgentSpec: &agentregistry.ServiceAgentSpecArgs{
				Type: pulumi.String("NO_SPEC"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_agentregistry_service" "default" {
  location     = "us-central1"
  service_id   = "service"
  description  = "My basic agent registry service"
  display_name = "My Service"
  interfaces {
    url              = "https://www.google.com/service"
    protocol_binding = "GRPC"
  }
  agent_spec = {
    type = "NO_SPEC"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.agentregistry.Service;
import com.pulumi.gcp.agentregistry.ServiceArgs;
import com.pulumi.gcp.agentregistry.inputs.ServiceInterfaceArgs;
import com.pulumi.gcp.agentregistry.inputs.ServiceAgentSpecArgs;
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) {
        var default_ = new Service("default", ServiceArgs.builder()
            .location("us-central1")
            .serviceId("service")
            .description("My basic agent registry service")
            .displayName("My Service")
            .interfaces(ServiceInterfaceArgs.builder()
                .url("https://www.google.com/service")
                .protocolBinding("GRPC")
                .build())
            .agentSpec(ServiceAgentSpecArgs.builder()
                .type("NO_SPEC")
                .build())
            .build());

    }
}

resources:
  default:
    type: gcp:agentregistry:Service
    properties:
      location: us-central1
      serviceId: service
      description: My basic agent registry service
      displayName: My Service
      interfaces:
        - url: https://www.google.com/service
          protocolBinding: GRPC
      agentSpec:
        type: NO_SPEC

Agent Registry Service Mcp Server

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

const _default = new gcp.agentregistry.Service("default", {
    location: "us-central1",
    serviceId: "service",
    description: "My MCP agent registry service",
    displayName: "My Service",
    interfaces: [{
        url: "https://example.com",
        protocolBinding: "JSONRPC",
    }],
    mcpServerSpec: {
        type: "TOOL_SPEC",
        content: "{\"tools\":[]}",
    },
});

import pulumi
import pulumi_gcp as gcp

default = gcp.agentregistry.Service("default",
    location="us-central1",
    service_id="service",
    description="My MCP agent registry service",
    display_name="My Service",
    interfaces=[{
        "url": "https://example.com",
        "protocol_binding": "JSONRPC",
    }],
    mcp_server_spec={
        "type": "TOOL_SPEC",
        "content": "{\"tools\":[]}",
    })

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.AgentRegistry.Service("default", new()
    {
        Location = "us-central1",
        ServiceId = "service",
        Description = "My MCP agent registry service",
        DisplayName = "My Service",
        Interfaces = new[]
        {
            new Gcp.AgentRegistry.Inputs.ServiceInterfaceArgs
            {
                Url = "https://example.com",
                ProtocolBinding = "JSONRPC",
            },
        },
        McpServerSpec = new Gcp.AgentRegistry.Inputs.ServiceMcpServerSpecArgs
        {
            Type = "TOOL_SPEC",
            Content = "{\"tools\":[]}",
        },
    });

});

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.NewService(ctx, "default", &agentregistry.ServiceArgs{
			Location:    pulumi.String("us-central1"),
			ServiceId:   pulumi.String("service"),
			Description: pulumi.String("My MCP agent registry service"),
			DisplayName: pulumi.String("My Service"),
			Interfaces: agentregistry.ServiceInterfaceArray{
				&agentregistry.ServiceInterfaceArgs{
					Url:             pulumi.String("https://example.com"),
					ProtocolBinding: pulumi.String("JSONRPC"),
				},
			},
			McpServerSpec: &agentregistry.ServiceMcpServerSpecArgs{
				Type:    pulumi.String("TOOL_SPEC"),
				Content: pulumi.String("{\"tools\":[]}"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_agentregistry_service" "default" {
  location     = "us-central1"
  service_id   = "service"
  description  = "My MCP agent registry service"
  display_name = "My Service"
  interfaces {
    url              = "https://example.com"
    protocol_binding = "JSONRPC"
  }
  mcp_server_spec = {
    type    = "TOOL_SPEC"
    content = "{\"tools\":[]}"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.agentregistry.Service;
import com.pulumi.gcp.agentregistry.ServiceArgs;
import com.pulumi.gcp.agentregistry.inputs.ServiceInterfaceArgs;
import com.pulumi.gcp.agentregistry.inputs.ServiceMcpServerSpecArgs;
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) {
        var default_ = new Service("default", ServiceArgs.builder()
            .location("us-central1")
            .serviceId("service")
            .description("My MCP agent registry service")
            .displayName("My Service")
            .interfaces(ServiceInterfaceArgs.builder()
                .url("https://example.com")
                .protocolBinding("JSONRPC")
                .build())
            .mcpServerSpec(ServiceMcpServerSpecArgs.builder()
                .type("TOOL_SPEC")
                .content("{\"tools\":[]}")
                .build())
            .build());

    }
}

resources:
  default:
    type: gcp:agentregistry:Service
    properties:
      location: us-central1
      serviceId: service
      description: My MCP agent registry service
      displayName: My Service
      interfaces:
        - url: https://example.com
          protocolBinding: JSONRPC
      mcpServerSpec:
        type: TOOL_SPEC
        content: '{"tools":[]}'

Import

Service can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/services/{{service_id}}
{{project}}/{{location}}/{{service_id}}
{{location}}/{{service_id}}

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

$ pulumi import gcp:agentregistry/service:Service default projects/{{project}}/locations/{{location}}/services/{{service_id}}
$ pulumi import gcp:agentregistry/service:Service default {{project}}/{{location}}/{{service_id}}
$ pulumi import gcp:agentregistry/service:Service default {{location}}/{{service_id}}

Constructors

Service(String name, {ServiceArgs? args, CustomResourceOptions? options}): Creates a new Service. name The Pulumi resource name. args Arguments used to configure this Service. The set of arguments for Service. options Resource options controlling this resource's behavior.
Service.reference(String urn): Creates a typed reference to an existing Service resource.

Properties

agentSpec ↔ Output<ServiceAgentSpec?>: The spec of the Agent. When set, the type of the Service is Agent. Structure is documented below.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: The timestamp when the resource was created.
latefinal
deletionPolicy ↔ Output<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.
latefinal
description ↔ Output<String?>: The description of the Service.
latefinal
displayName ↔ Output<String?>: User-defined display name for the Service. Can have a maximum length of 63 characters.
latefinal
endpointSpec ↔ Output<ServiceEndpointSpec?>: The spec of the Endpoint. When set, the type of the Service is Endpoint. Structure is documented below.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
interfaces ↔ Output<List<ServiceInterface>?>: The connection details for the Service. Structure is documented below.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
location ↔ Output<String>: The location of the resource.
latefinal
mcpServerSpec ↔ Output<ServiceMcpServerSpec?>: The spec of the MCP Server. When set, the type of the Service is MCP Server. Structure is documented below.
latefinal
name ↔ Output<String>: The resource name of the Service.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
registryResource ↔ Output<String>: The resource name of the resulting Agent, MCP Server, or Endpoint.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
serviceId ↔ Output<String>: The name of the Service.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
updateTime ↔ Output<String>: The timestamp when the resource was updated.
latefinal
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ServiceState? state, CustomResourceOptions? options}) → Service: Gets an existing Service resource's state with the given name and id.