Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Octopusdeploy Provider
  3. API Docs
  4. KubernetesAgentDeploymentTarget
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

octopusdeploy.KubernetesAgentDeploymentTarget

Explore with Pulumi AI

octopusdeploy logo
octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
octopusdeploylabs/terraform-provider-octopusdeploy

    This resource manages Kubernetes agent deployment targets in Octopus Deploy.

    Example Usage

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

const minimal = new octopusdeploy.KubernetesAgentDeploymentTarget("minimal", {
    environments: ["environments-1"],
    roles: [
        "role-1",
        "role-2",
    ],
    thumbprint: "96203ED84246201C26A2F4360D7CBC36AC1D232D",
    uri: "poll://kcxzcv2fpsxkn6tk9u6d/",
});
const optionals = new octopusdeploy.KubernetesAgentDeploymentTarget("optionals", {
    defaultNamespace: "kubernetes-namespace",
    environments: ["environments-1"],
    isDisabled: true,
    machinePolicyId: "machinepolicies-1",
    roles: [
        "role-1",
        "role-2",
    ],
    thumbprint: "96203ED84246201C26A2F4360D7CBC36AC1D232D",
    upgradeLocked: true,
    uri: "poll://kcxzcv2fpsxkn6tk9u6d/",
});
const tenantedAgent = new octopusdeploy.KubernetesAgentDeploymentTarget("tenantedAgent", {
    environments: ["environments-1"],
    roles: [
        "role-1",
        "role-2",
    ],
    tenantTags: ["TagSets-1/Tags-1"],
    tenantedDeploymentParticipation: "Tenanted",
    tenants: ["tenants-1"],
    thumbprint: "96203ED84246201C26A2F4360D7CBC36AC1D232D",
    uri: "poll://kcxzcv2fpsxkn6tk9u6d/",
});

    import pulumi
import pulumi_octopusdeploy as octopusdeploy

minimal = octopusdeploy.KubernetesAgentDeploymentTarget("minimal",
    environments=["environments-1"],
    roles=[
        "role-1",
        "role-2",
    ],
    thumbprint="96203ED84246201C26A2F4360D7CBC36AC1D232D",
    uri="poll://kcxzcv2fpsxkn6tk9u6d/")
optionals = octopusdeploy.KubernetesAgentDeploymentTarget("optionals",
    default_namespace="kubernetes-namespace",
    environments=["environments-1"],
    is_disabled=True,
    machine_policy_id="machinepolicies-1",
    roles=[
        "role-1",
        "role-2",
    ],
    thumbprint="96203ED84246201C26A2F4360D7CBC36AC1D232D",
    upgrade_locked=True,
    uri="poll://kcxzcv2fpsxkn6tk9u6d/")
tenanted_agent = octopusdeploy.KubernetesAgentDeploymentTarget("tenantedAgent",
    environments=["environments-1"],
    roles=[
        "role-1",
        "role-2",
    ],
    tenant_tags=["TagSets-1/Tags-1"],
    tenanted_deployment_participation="Tenanted",
    tenants=["tenants-1"],
    thumbprint="96203ED84246201C26A2F4360D7CBC36AC1D232D",
    uri="poll://kcxzcv2fpsxkn6tk9u6d/")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/octopusdeploy/octopusdeploy"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := octopusdeploy.NewKubernetesAgentDeploymentTarget(ctx, "minimal", &octopusdeploy.KubernetesAgentDeploymentTargetArgs{
			Environments: pulumi.StringArray{
				pulumi.String("environments-1"),
			},
			Roles: pulumi.StringArray{
				pulumi.String("role-1"),
				pulumi.String("role-2"),
			},
			Thumbprint: pulumi.String("96203ED84246201C26A2F4360D7CBC36AC1D232D"),
			Uri:        pulumi.String("poll://kcxzcv2fpsxkn6tk9u6d/"),
		})
		if err != nil {
			return err
		}
		_, err = octopusdeploy.NewKubernetesAgentDeploymentTarget(ctx, "optionals", &octopusdeploy.KubernetesAgentDeploymentTargetArgs{
			DefaultNamespace: pulumi.String("kubernetes-namespace"),
			Environments: pulumi.StringArray{
				pulumi.String("environments-1"),
			},
			IsDisabled:      pulumi.Bool(true),
			MachinePolicyId: pulumi.String("machinepolicies-1"),
			Roles: pulumi.StringArray{
				pulumi.String("role-1"),
				pulumi.String("role-2"),
			},
			Thumbprint:    pulumi.String("96203ED84246201C26A2F4360D7CBC36AC1D232D"),
			UpgradeLocked: pulumi.Bool(true),
			Uri:           pulumi.String("poll://kcxzcv2fpsxkn6tk9u6d/"),
		})
		if err != nil {
			return err
		}
		_, err = octopusdeploy.NewKubernetesAgentDeploymentTarget(ctx, "tenantedAgent", &octopusdeploy.KubernetesAgentDeploymentTargetArgs{
			Environments: pulumi.StringArray{
				pulumi.String("environments-1"),
			},
			Roles: pulumi.StringArray{
				pulumi.String("role-1"),
				pulumi.String("role-2"),
			},
			TenantTags: pulumi.StringArray{
				pulumi.String("TagSets-1/Tags-1"),
			},
			TenantedDeploymentParticipation: pulumi.String("Tenanted"),
			Tenants: pulumi.StringArray{
				pulumi.String("tenants-1"),
			},
			Thumbprint: pulumi.String("96203ED84246201C26A2F4360D7CBC36AC1D232D"),
			Uri:        pulumi.String("poll://kcxzcv2fpsxkn6tk9u6d/"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var minimal = new Octopusdeploy.KubernetesAgentDeploymentTarget("minimal", new()
    {
        Environments = new[]
        {
            "environments-1",
        },
        Roles = new[]
        {
            "role-1",
            "role-2",
        },
        Thumbprint = "96203ED84246201C26A2F4360D7CBC36AC1D232D",
        Uri = "poll://kcxzcv2fpsxkn6tk9u6d/",
    });

    var optionals = new Octopusdeploy.KubernetesAgentDeploymentTarget("optionals", new()
    {
        DefaultNamespace = "kubernetes-namespace",
        Environments = new[]
        {
            "environments-1",
        },
        IsDisabled = true,
        MachinePolicyId = "machinepolicies-1",
        Roles = new[]
        {
            "role-1",
            "role-2",
        },
        Thumbprint = "96203ED84246201C26A2F4360D7CBC36AC1D232D",
        UpgradeLocked = true,
        Uri = "poll://kcxzcv2fpsxkn6tk9u6d/",
    });

    var tenantedAgent = new Octopusdeploy.KubernetesAgentDeploymentTarget("tenantedAgent", new()
    {
        Environments = new[]
        {
            "environments-1",
        },
        Roles = new[]
        {
            "role-1",
            "role-2",
        },
        TenantTags = new[]
        {
            "TagSets-1/Tags-1",
        },
        TenantedDeploymentParticipation = "Tenanted",
        Tenants = new[]
        {
            "tenants-1",
        },
        Thumbprint = "96203ED84246201C26A2F4360D7CBC36AC1D232D",
        Uri = "poll://kcxzcv2fpsxkn6tk9u6d/",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.KubernetesAgentDeploymentTarget;
import com.pulumi.octopusdeploy.KubernetesAgentDeploymentTargetArgs;
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) {
        var minimal = new KubernetesAgentDeploymentTarget("minimal", KubernetesAgentDeploymentTargetArgs.builder()
            .environments("environments-1")
            .roles(            
                "role-1",
                "role-2")
            .thumbprint("96203ED84246201C26A2F4360D7CBC36AC1D232D")
            .uri("poll://kcxzcv2fpsxkn6tk9u6d/")
            .build());

        var optionals = new KubernetesAgentDeploymentTarget("optionals", KubernetesAgentDeploymentTargetArgs.builder()
            .defaultNamespace("kubernetes-namespace")
            .environments("environments-1")
            .isDisabled(true)
            .machinePolicyId("machinepolicies-1")
            .roles(            
                "role-1",
                "role-2")
            .thumbprint("96203ED84246201C26A2F4360D7CBC36AC1D232D")
            .upgradeLocked(true)
            .uri("poll://kcxzcv2fpsxkn6tk9u6d/")
            .build());

        var tenantedAgent = new KubernetesAgentDeploymentTarget("tenantedAgent", KubernetesAgentDeploymentTargetArgs.builder()
            .environments("environments-1")
            .roles(            
                "role-1",
                "role-2")
            .tenantTags("TagSets-1/Tags-1")
            .tenantedDeploymentParticipation("Tenanted")
            .tenants("tenants-1")
            .thumbprint("96203ED84246201C26A2F4360D7CBC36AC1D232D")
            .uri("poll://kcxzcv2fpsxkn6tk9u6d/")
            .build());

    }
}

    resources:
  minimal:
    type: octopusdeploy:KubernetesAgentDeploymentTarget
    properties:
      environments:
        - environments-1
      roles:
        - role-1
        - role-2
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      uri: poll://kcxzcv2fpsxkn6tk9u6d/
  optionals:
    type: octopusdeploy:KubernetesAgentDeploymentTarget
    properties:
      defaultNamespace: kubernetes-namespace
      environments:
        - environments-1
      isDisabled: true
      machinePolicyId: machinepolicies-1
      roles:
        - role-1
        - role-2
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      upgradeLocked: true
      uri: poll://kcxzcv2fpsxkn6tk9u6d/
  tenantedAgent:
    type: octopusdeploy:KubernetesAgentDeploymentTarget
    properties:
      environments:
        - environments-1
      roles:
        - role-1
        - role-2
      tenantTags:
        - TagSets-1/Tags-1
      tenantedDeploymentParticipation: Tenanted
      tenants:
        - tenants-1
      thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D
      uri: poll://kcxzcv2fpsxkn6tk9u6d/

    Create KubernetesAgentDeploymentTarget Resource

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

    Constructor syntax

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

@overload
def KubernetesAgentDeploymentTarget(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    roles: Optional[Sequence[str]] = None,
                                    uri: Optional[str] = None,
                                    environments: Optional[Sequence[str]] = None,
                                    thumbprint: Optional[str] = None,
                                    name: Optional[str] = None,
                                    machine_policy_id: Optional[str] = None,
                                    communication_mode: Optional[str] = None,
                                    kubernetes_agent_deployment_target_id: Optional[str] = None,
                                    space_id: Optional[str] = None,
                                    tenant_tags: Optional[Sequence[str]] = None,
                                    tenanted_deployment_participation: Optional[str] = None,
                                    tenants: Optional[Sequence[str]] = None,
                                    is_disabled: Optional[bool] = None,
                                    upgrade_locked: Optional[bool] = None,
                                    default_namespace: Optional[str] = None)
    func NewKubernetesAgentDeploymentTarget(ctx *Context, name string, args KubernetesAgentDeploymentTargetArgs, opts ...ResourceOption) (*KubernetesAgentDeploymentTarget, error)
    public KubernetesAgentDeploymentTarget(string name, KubernetesAgentDeploymentTargetArgs args, CustomResourceOptions? opts = null)
    public KubernetesAgentDeploymentTarget(String name, KubernetesAgentDeploymentTargetArgs args)
public KubernetesAgentDeploymentTarget(String name, KubernetesAgentDeploymentTargetArgs args, CustomResourceOptions options)

    type: octopusdeploy:KubernetesAgentDeploymentTarget
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args KubernetesAgentDeploymentTargetArgs
    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 KubernetesAgentDeploymentTargetArgs
    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 KubernetesAgentDeploymentTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KubernetesAgentDeploymentTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KubernetesAgentDeploymentTargetArgs
    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 kubernetesAgentDeploymentTargetResource = new Octopusdeploy.KubernetesAgentDeploymentTarget("kubernetesAgentDeploymentTargetResource", new()
{
    Roles = new[]
    {
        "string",
    },
    Uri = "string",
    Environments = new[]
    {
        "string",
    },
    Thumbprint = "string",
    Name = "string",
    MachinePolicyId = "string",
    CommunicationMode = "string",
    KubernetesAgentDeploymentTargetId = "string",
    SpaceId = "string",
    TenantTags = new[]
    {
        "string",
    },
    TenantedDeploymentParticipation = "string",
    Tenants = new[]
    {
        "string",
    },
    IsDisabled = false,
    UpgradeLocked = false,
    DefaultNamespace = "string",
});

    example, err := octopusdeploy.NewKubernetesAgentDeploymentTarget(ctx, "kubernetesAgentDeploymentTargetResource", &octopusdeploy.KubernetesAgentDeploymentTargetArgs{
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Uri: pulumi.String("string"),
	Environments: pulumi.StringArray{
		pulumi.String("string"),
	},
	Thumbprint:                        pulumi.String("string"),
	Name:                              pulumi.String("string"),
	MachinePolicyId:                   pulumi.String("string"),
	CommunicationMode:                 pulumi.String("string"),
	KubernetesAgentDeploymentTargetId: pulumi.String("string"),
	SpaceId:                           pulumi.String("string"),
	TenantTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantedDeploymentParticipation: pulumi.String("string"),
	Tenants: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsDisabled:       pulumi.Bool(false),
	UpgradeLocked:    pulumi.Bool(false),
	DefaultNamespace: pulumi.String("string"),
})

    var kubernetesAgentDeploymentTargetResource = new KubernetesAgentDeploymentTarget("kubernetesAgentDeploymentTargetResource", KubernetesAgentDeploymentTargetArgs.builder()
    .roles("string")
    .uri("string")
    .environments("string")
    .thumbprint("string")
    .name("string")
    .machinePolicyId("string")
    .communicationMode("string")
    .kubernetesAgentDeploymentTargetId("string")
    .spaceId("string")
    .tenantTags("string")
    .tenantedDeploymentParticipation("string")
    .tenants("string")
    .isDisabled(false)
    .upgradeLocked(false)
    .defaultNamespace("string")
    .build());

    kubernetes_agent_deployment_target_resource = octopusdeploy.KubernetesAgentDeploymentTarget("kubernetesAgentDeploymentTargetResource",
    roles=["string"],
    uri="string",
    environments=["string"],
    thumbprint="string",
    name="string",
    machine_policy_id="string",
    communication_mode="string",
    kubernetes_agent_deployment_target_id="string",
    space_id="string",
    tenant_tags=["string"],
    tenanted_deployment_participation="string",
    tenants=["string"],
    is_disabled=False,
    upgrade_locked=False,
    default_namespace="string")

    const kubernetesAgentDeploymentTargetResource = new octopusdeploy.KubernetesAgentDeploymentTarget("kubernetesAgentDeploymentTargetResource", {
    roles: ["string"],
    uri: "string",
    environments: ["string"],
    thumbprint: "string",
    name: "string",
    machinePolicyId: "string",
    communicationMode: "string",
    kubernetesAgentDeploymentTargetId: "string",
    spaceId: "string",
    tenantTags: ["string"],
    tenantedDeploymentParticipation: "string",
    tenants: ["string"],
    isDisabled: false,
    upgradeLocked: false,
    defaultNamespace: "string",
});

    type: octopusdeploy:KubernetesAgentDeploymentTarget
properties:
    communicationMode: string
    defaultNamespace: string
    environments:
        - string
    isDisabled: false
    kubernetesAgentDeploymentTargetId: string
    machinePolicyId: string
    name: string
    roles:
        - string
    spaceId: string
    tenantTags:
        - string
    tenantedDeploymentParticipation: string
    tenants:
        - string
    thumbprint: string
    upgradeLocked: false
    uri: string

    KubernetesAgentDeploymentTarget 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 KubernetesAgentDeploymentTarget resource accepts the following input properties:

    Environments List<string>
    A list of environment IDs this Kubernetes agent can deploy to.
    Roles List<string>
    A list of target roles that are associated to this Kubernetes agent.
    Thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    Uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    CommunicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    DefaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    IsDisabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    KubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    MachinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    UpgradeLocked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    Environments []string
    A list of environment IDs this Kubernetes agent can deploy to.
    Roles []string
    A list of target roles that are associated to this Kubernetes agent.
    Thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    Uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    CommunicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    DefaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    IsDisabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    KubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    MachinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    Name string
    The name of this resource.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    UpgradeLocked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    environments List<String>
    A list of environment IDs this Kubernetes agent can deploy to.
    roles List<String>
    A list of target roles that are associated to this Kubernetes agent.
    thumbprint String
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    uri String
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    communicationMode String
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace String
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    isDisabled Boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId String
    The unique ID for this resource.
    machinePolicyId String
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    upgradeLocked Boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    environments string[]
    A list of environment IDs this Kubernetes agent can deploy to.
    roles string[]
    A list of target roles that are associated to this Kubernetes agent.
    thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    communicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    isDisabled boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    machinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name string
    The name of this resource.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    upgradeLocked boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    environments Sequence[str]
    A list of environment IDs this Kubernetes agent can deploy to.
    roles Sequence[str]
    A list of target roles that are associated to this Kubernetes agent.
    thumbprint str
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    uri str
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    communication_mode str
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    default_namespace str
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    is_disabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetes_agent_deployment_target_id str
    The unique ID for this resource.
    machine_policy_id str
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name str
    The name of this resource.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    upgrade_locked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    environments List<String>
    A list of environment IDs this Kubernetes agent can deploy to.
    roles List<String>
    A list of target roles that are associated to this Kubernetes agent.
    thumbprint String
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    uri String
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    communicationMode String
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace String
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    isDisabled Boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId String
    The unique ID for this resource.
    machinePolicyId String
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name String
    The name of this resource.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    upgradeLocked Boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.

    Outputs

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

    AgentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    AgentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    AgentTentacleVersion string
    Current Tentacle version of the agent
    AgentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    AgentVersion string
    Current Helm chart version of the agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    AgentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    AgentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    AgentTentacleVersion string
    Current Tentacle version of the agent
    AgentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    AgentVersion string
    Current Helm chart version of the agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    agentHelmReleaseName String
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace String
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion String
    Current Tentacle version of the agent
    agentUpgradeStatus String
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion String
    Current Helm chart version of the agent.
    id String
    The provider-assigned unique ID for this managed resource.
    agentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion string
    Current Tentacle version of the agent
    agentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion string
    Current Helm chart version of the agent.
    id string
    The provider-assigned unique ID for this managed resource.
    agent_helm_release_name str
    Name of the Helm release that the agent belongs to.
    agent_kubernetes_namespace str
    Name of the Kubernetes namespace where the agent is installed.
    agent_tentacle_version str
    Current Tentacle version of the agent
    agent_upgrade_status str
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agent_version str
    Current Helm chart version of the agent.
    id str
    The provider-assigned unique ID for this managed resource.
    agentHelmReleaseName String
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace String
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion String
    Current Tentacle version of the agent
    agentUpgradeStatus String
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion String
    Current Helm chart version of the agent.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing KubernetesAgentDeploymentTarget Resource

    Get an existing KubernetesAgentDeploymentTarget 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?: KubernetesAgentDeploymentTargetState, opts?: CustomResourceOptions): KubernetesAgentDeploymentTarget
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_helm_release_name: Optional[str] = None,
        agent_kubernetes_namespace: Optional[str] = None,
        agent_tentacle_version: Optional[str] = None,
        agent_upgrade_status: Optional[str] = None,
        agent_version: Optional[str] = None,
        communication_mode: Optional[str] = None,
        default_namespace: Optional[str] = None,
        environments: Optional[Sequence[str]] = None,
        is_disabled: Optional[bool] = None,
        kubernetes_agent_deployment_target_id: Optional[str] = None,
        machine_policy_id: Optional[str] = None,
        name: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        space_id: Optional[str] = None,
        tenant_tags: Optional[Sequence[str]] = None,
        tenanted_deployment_participation: Optional[str] = None,
        tenants: Optional[Sequence[str]] = None,
        thumbprint: Optional[str] = None,
        upgrade_locked: Optional[bool] = None,
        uri: Optional[str] = None) -> KubernetesAgentDeploymentTarget
    func GetKubernetesAgentDeploymentTarget(ctx *Context, name string, id IDInput, state *KubernetesAgentDeploymentTargetState, opts ...ResourceOption) (*KubernetesAgentDeploymentTarget, error)
    public static KubernetesAgentDeploymentTarget Get(string name, Input<string> id, KubernetesAgentDeploymentTargetState? state, CustomResourceOptions? opts = null)
    public static KubernetesAgentDeploymentTarget get(String name, Output<String> id, KubernetesAgentDeploymentTargetState state, CustomResourceOptions options)
    resources:  _:    type: octopusdeploy:KubernetesAgentDeploymentTarget    get:      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:
    AgentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    AgentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    AgentTentacleVersion string
    Current Tentacle version of the agent
    AgentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    AgentVersion string
    Current Helm chart version of the agent.
    CommunicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    DefaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    Environments List<string>
    A list of environment IDs this Kubernetes agent can deploy to.
    IsDisabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    KubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    MachinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    Name string
    The name of this resource.
    Roles List<string>
    A list of target roles that are associated to this Kubernetes agent.
    SpaceId string
    The space ID associated with this resource.
    TenantTags List<string>
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants List<string>
    A list of tenant IDs associated with this resource.
    Thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    UpgradeLocked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    Uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    AgentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    AgentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    AgentTentacleVersion string
    Current Tentacle version of the agent
    AgentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    AgentVersion string
    Current Helm chart version of the agent.
    CommunicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    DefaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    Environments []string
    A list of environment IDs this Kubernetes agent can deploy to.
    IsDisabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    KubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    MachinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    Name string
    The name of this resource.
    Roles []string
    A list of target roles that are associated to this Kubernetes agent.
    SpaceId string
    The space ID associated with this resource.
    TenantTags []string
    A list of tenant tags associated with this resource.
    TenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    Tenants []string
    A list of tenant IDs associated with this resource.
    Thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    UpgradeLocked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    Uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    agentHelmReleaseName String
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace String
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion String
    Current Tentacle version of the agent
    agentUpgradeStatus String
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion String
    Current Helm chart version of the agent.
    communicationMode String
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace String
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    environments List<String>
    A list of environment IDs this Kubernetes agent can deploy to.
    isDisabled Boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId String
    The unique ID for this resource.
    machinePolicyId String
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name String
    The name of this resource.
    roles List<String>
    A list of target roles that are associated to this Kubernetes agent.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    thumbprint String
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    upgradeLocked Boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    uri String
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    agentHelmReleaseName string
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace string
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion string
    Current Tentacle version of the agent
    agentUpgradeStatus string
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion string
    Current Helm chart version of the agent.
    communicationMode string
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace string
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    environments string[]
    A list of environment IDs this Kubernetes agent can deploy to.
    isDisabled boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId string
    The unique ID for this resource.
    machinePolicyId string
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name string
    The name of this resource.
    roles string[]
    A list of target roles that are associated to this Kubernetes agent.
    spaceId string
    The space ID associated with this resource.
    tenantTags string[]
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation string
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants string[]
    A list of tenant IDs associated with this resource.
    thumbprint string
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    upgradeLocked boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    uri string
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    agent_helm_release_name str
    Name of the Helm release that the agent belongs to.
    agent_kubernetes_namespace str
    Name of the Kubernetes namespace where the agent is installed.
    agent_tentacle_version str
    Current Tentacle version of the agent
    agent_upgrade_status str
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agent_version str
    Current Helm chart version of the agent.
    communication_mode str
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    default_namespace str
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    environments Sequence[str]
    A list of environment IDs this Kubernetes agent can deploy to.
    is_disabled bool
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetes_agent_deployment_target_id str
    The unique ID for this resource.
    machine_policy_id str
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name str
    The name of this resource.
    roles Sequence[str]
    A list of target roles that are associated to this Kubernetes agent.
    space_id str
    The space ID associated with this resource.
    tenant_tags Sequence[str]
    A list of tenant tags associated with this resource.
    tenanted_deployment_participation str
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants Sequence[str]
    A list of tenant IDs associated with this resource.
    thumbprint str
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    upgrade_locked bool
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    uri str
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.
    agentHelmReleaseName String
    Name of the Helm release that the agent belongs to.
    agentKubernetesNamespace String
    Name of the Kubernetes namespace where the agent is installed.
    agentTentacleVersion String
    Current Tentacle version of the agent
    agentUpgradeStatus String
    Current upgrade availability status of the agent. One of 'NoUpgrades', 'UpgradeAvailable', 'UpgradeSuggested', 'UpgradeRequired'
    agentVersion String
    Current Helm chart version of the agent.
    communicationMode String
    The communication mode used by the Kubernetes agent to communicate with Octopus Server. Currently, the only supported value is 'Polling'.
    defaultNamespace String
    Optional default namespace that will be used when using Kubernetes deployment steps, can be overrides within step configurations.
    environments List<String>
    A list of environment IDs this Kubernetes agent can deploy to.
    isDisabled Boolean
    Whether the Kubernetes agent is disabled. If the agent is disabled, it will not be included in any deployments.
    kubernetesAgentDeploymentTargetId String
    The unique ID for this resource.
    machinePolicyId String
    Optional ID of the machine policy that the Kubernetes agent will use. If not provided the default machine policy will be used.
    name String
    The name of this resource.
    roles List<String>
    A list of target roles that are associated to this Kubernetes agent.
    spaceId String
    The space ID associated with this resource.
    tenantTags List<String>
    A list of tenant tags associated with this resource.
    tenantedDeploymentParticipation String
    The tenanted deployment mode of the resource. Valid account types are Untenanted, TenantedOrUntenanted, or Tenanted.
    tenants List<String>
    A list of tenant IDs associated with this resource.
    thumbprint String
    The thumbprint of the Kubernetes agent's certificate used by server to verify the identity of the agent. This is the same thumbprint that was used when installing the agent.
    upgradeLocked Boolean
    If enabled the Kubernetes agent will not automatically upgrade and will stay on the currently installed version, even if the associated machine policy is configured to automatically upgrade.
    uri String
    The URI of the Kubernetes agent's used by the server to queue messages. This is the same subscription uri that was used when installing the agent.

    Import

    $ pulumi import octopusdeploy:index/kubernetesAgentDeploymentTarget:KubernetesAgentDeploymentTarget [options] octopusdeploy_kubernetes_agent_deployment_target.<name> <machine-id>

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

    Package Details

    Repository
    octopusdeploy octopusdeploylabs/terraform-provider-octopusdeploy
    License
    Notes
    This Pulumi package is based on the octopusdeploy Terraform Provider.
    octopusdeploy logo
    octopusdeploy 0.43.1 published on Wednesday, Apr 30, 2025 by octopusdeploylabs
    octopusdeploylabs/terraform-provider-octopusdeploy