octopusdeploy.getKubernetesAgentDeploymentTargets

Start a Neo task

Explain and create an octopusdeploy.getKubernetesAgentDeploymentTargets resource

octopusdeploy 0.43.2 published on Friday, May 30, 2025 by octopusdeploylabs

octopusdeploylabs/terraform-provider-octopusdeploy

Example Usage

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

const kubernetesAgentDeploymentTargets = octopusdeploy.getKubernetesAgentDeploymentTargets({
    deploymentId: "Deployments-123",
    environments: [
        "Environments-123",
        "Environments-321",
    ],
    healthStatuses: ["HasWarnings"],
    ids: [
        "Machines-123",
        "Machines-321",
    ],
    isDisabled: false,
    name: "Kubernetes Agent",
    partialName: "Kubernetes Age",
    roles: [
        "Roles-123",
        "Roles-321",
    ],
    shellNames: [],
    skip: 5,
    take: 100,
    tenantTags: ["TagSet1/Tag"],
    tenants: ["Tenants-123"],
    thumbprint: "96203ED84246201C26A2F4360D7CBC36AC1D232D",
});

import pulumi
import pulumi_octopusdeploy as octopusdeploy

kubernetes_agent_deployment_targets = octopusdeploy.get_kubernetes_agent_deployment_targets(deployment_id="Deployments-123",
    environments=[
        "Environments-123",
        "Environments-321",
    ],
    health_statuses=["HasWarnings"],
    ids=[
        "Machines-123",
        "Machines-321",
    ],
    is_disabled=False,
    name="Kubernetes Agent",
    partial_name="Kubernetes Age",
    roles=[
        "Roles-123",
        "Roles-321",
    ],
    shell_names=[],
    skip=5,
    take=100,
    tenant_tags=["TagSet1/Tag"],
    tenants=["Tenants-123"],
    thumbprint="96203ED84246201C26A2F4360D7CBC36AC1D232D")

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.GetKubernetesAgentDeploymentTargets(ctx, &octopusdeploy.GetKubernetesAgentDeploymentTargetsArgs{
			DeploymentId: pulumi.StringRef("Deployments-123"),
			Environments: []string{
				"Environments-123",
				"Environments-321",
			},
			HealthStatuses: []string{
				"HasWarnings",
			},
			Ids: []string{
				"Machines-123",
				"Machines-321",
			},
			IsDisabled:  pulumi.BoolRef(false),
			Name:        pulumi.StringRef("Kubernetes Agent"),
			PartialName: pulumi.StringRef("Kubernetes Age"),
			Roles: []string{
				"Roles-123",
				"Roles-321",
			},
			ShellNames: []interface{}{},
			Skip:       pulumi.Float64Ref(5),
			Take:       pulumi.Float64Ref(100),
			TenantTags: []string{
				"TagSet1/Tag",
			},
			Tenants: []string{
				"Tenants-123",
			},
			Thumbprint: pulumi.StringRef("96203ED84246201C26A2F4360D7CBC36AC1D232D"),
		}, nil)
		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 kubernetesAgentDeploymentTargets = Octopusdeploy.GetKubernetesAgentDeploymentTargets.Invoke(new()
    {
        DeploymentId = "Deployments-123",
        Environments = new[]
        {
            "Environments-123",
            "Environments-321",
        },
        HealthStatuses = new[]
        {
            "HasWarnings",
        },
        Ids = new[]
        {
            "Machines-123",
            "Machines-321",
        },
        IsDisabled = false,
        Name = "Kubernetes Agent",
        PartialName = "Kubernetes Age",
        Roles = new[]
        {
            "Roles-123",
            "Roles-321",
        },
        ShellNames = new() { },
        Skip = 5,
        Take = 100,
        TenantTags = new[]
        {
            "TagSet1/Tag",
        },
        Tenants = new[]
        {
            "Tenants-123",
        },
        Thumbprint = "96203ED84246201C26A2F4360D7CBC36AC1D232D",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.octopusdeploy.OctopusdeployFunctions;
import com.pulumi.octopusdeploy.inputs.GetKubernetesAgentDeploymentTargetsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var kubernetesAgentDeploymentTargets = OctopusdeployFunctions.getKubernetesAgentDeploymentTargets(GetKubernetesAgentDeploymentTargetsArgs.builder()
            .deploymentId("Deployments-123")
            .environments(            
                "Environments-123",
                "Environments-321")
            .healthStatuses("HasWarnings")
            .ids(            
                "Machines-123",
                "Machines-321")
            .isDisabled(false)
            .name("Kubernetes Agent")
            .partialName("Kubernetes Age")
            .roles(            
                "Roles-123",
                "Roles-321")
            .shellNames()
            .skip(5)
            .take(100)
            .tenantTags("TagSet1/Tag")
            .tenants("Tenants-123")
            .thumbprint("96203ED84246201C26A2F4360D7CBC36AC1D232D")
            .build());

    }
}

variables:
  kubernetesAgentDeploymentTargets:
    fn::invoke:
      function: octopusdeploy:getKubernetesAgentDeploymentTargets
      arguments:
        deploymentId: Deployments-123
        environments:
          - Environments-123
          - Environments-321
        healthStatuses:
          - HasWarnings
        ids:
          - Machines-123
          - Machines-321
        isDisabled: false
        name: Kubernetes Agent
        partialName: Kubernetes Age
        roles:
          - Roles-123
          - Roles-321
        shellNames: []
        skip: 5
        take: 100
        tenantTags:
          - TagSet1/Tag
        tenants:
          - Tenants-123
        thumbprint: 96203ED84246201C26A2F4360D7CBC36AC1D232D

Using getKubernetesAgentDeploymentTargets

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getKubernetesAgentDeploymentTargets(args: GetKubernetesAgentDeploymentTargetsArgs, opts?: InvokeOptions): Promise<GetKubernetesAgentDeploymentTargetsResult>
function getKubernetesAgentDeploymentTargetsOutput(args: GetKubernetesAgentDeploymentTargetsOutputArgs, opts?: InvokeOptions): Output<GetKubernetesAgentDeploymentTargetsResult>

def get_kubernetes_agent_deployment_targets(deployment_id: Optional[str] = None,
                                            environments: Optional[Sequence[str]] = None,
                                            health_statuses: Optional[Sequence[str]] = None,
                                            ids: Optional[Sequence[str]] = None,
                                            is_disabled: Optional[bool] = None,
                                            name: Optional[str] = None,
                                            partial_name: Optional[str] = None,
                                            roles: Optional[Sequence[str]] = None,
                                            shell_names: Optional[Sequence[str]] = None,
                                            skip: Optional[float] = None,
                                            space_id: Optional[str] = None,
                                            take: Optional[float] = None,
                                            tenant_tags: Optional[Sequence[str]] = None,
                                            tenants: Optional[Sequence[str]] = None,
                                            thumbprint: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetKubernetesAgentDeploymentTargetsResult
def get_kubernetes_agent_deployment_targets_output(deployment_id: Optional[pulumi.Input[str]] = None,
                                            environments: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            health_statuses: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            is_disabled: Optional[pulumi.Input[bool]] = None,
                                            name: Optional[pulumi.Input[str]] = None,
                                            partial_name: Optional[pulumi.Input[str]] = None,
                                            roles: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            shell_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            skip: Optional[pulumi.Input[float]] = None,
                                            space_id: Optional[pulumi.Input[str]] = None,
                                            take: Optional[pulumi.Input[float]] = None,
                                            tenant_tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            tenants: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                            thumbprint: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesAgentDeploymentTargetsResult]

func GetKubernetesAgentDeploymentTargets(ctx *Context, args *GetKubernetesAgentDeploymentTargetsArgs, opts ...InvokeOption) (*GetKubernetesAgentDeploymentTargetsResult, error)
func GetKubernetesAgentDeploymentTargetsOutput(ctx *Context, args *GetKubernetesAgentDeploymentTargetsOutputArgs, opts ...InvokeOption) GetKubernetesAgentDeploymentTargetsResultOutput

> Note: This function is named GetKubernetesAgentDeploymentTargets in the Go SDK.

public static class GetKubernetesAgentDeploymentTargets 
{
    public static Task<GetKubernetesAgentDeploymentTargetsResult> InvokeAsync(GetKubernetesAgentDeploymentTargetsArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesAgentDeploymentTargetsResult> Invoke(GetKubernetesAgentDeploymentTargetsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetKubernetesAgentDeploymentTargetsResult> getKubernetesAgentDeploymentTargets(GetKubernetesAgentDeploymentTargetsArgs args, InvokeOptions options)
public static Output<GetKubernetesAgentDeploymentTargetsResult> getKubernetesAgentDeploymentTargets(GetKubernetesAgentDeploymentTargetsArgs args, InvokeOptions options)

fn::invoke:
  function: octopusdeploy:index/getKubernetesAgentDeploymentTargets:getKubernetesAgentDeploymentTargets
  arguments:
    # arguments dictionary

The following arguments are supported:

DeploymentId string: A filter to search by deployment ID.
Environments List<string>: A filter to search by a list of environment IDs.
HealthStatuses List<string>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
Ids List<string>: A filter to search by a list of IDs.
IsDisabled bool: A filter to search by the disabled status of a resource.
Name string: A filter to search by name.
PartialName string: A filter to search by the partial match of a name.
Roles List<string>: A filter to search by a list of role IDs.
ShellNames List<string>: A list of shell names to match in the query and/or search
Skip double: A filter to specify the number of items to skip in the response.
SpaceId string: The space ID associated with this resource.
Take double: A filter to specify the number of items to take (or return) in the response.
TenantTags List<string>: A filter to search by a list of tenant tags.
Tenants List<string>: A filter to search by a list of tenant IDs.
Thumbprint string: The thumbprint of the deployment target to match in the query and/or search

DeploymentId string: A filter to search by deployment ID.
Environments []string: A filter to search by a list of environment IDs.
HealthStatuses []string: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
Ids []string: A filter to search by a list of IDs.
IsDisabled bool: A filter to search by the disabled status of a resource.
Name string: A filter to search by name.
PartialName string: A filter to search by the partial match of a name.
Roles []string: A filter to search by a list of role IDs.
ShellNames []string: A list of shell names to match in the query and/or search
Skip float64: A filter to specify the number of items to skip in the response.
SpaceId string: The space ID associated with this resource.
Take float64: A filter to specify the number of items to take (or return) in the response.
TenantTags []string: A filter to search by a list of tenant tags.
Tenants []string: A filter to search by a list of tenant IDs.
Thumbprint string: The thumbprint of the deployment target to match in the query and/or search

deploymentId String: A filter to search by deployment ID.
environments List<String>: A filter to search by a list of environment IDs.
healthStatuses List<String>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids List<String>: A filter to search by a list of IDs.
isDisabled Boolean: A filter to search by the disabled status of a resource.
name String: A filter to search by name.
partialName String: A filter to search by the partial match of a name.
roles List<String>: A filter to search by a list of role IDs.
shellNames List<String>: A list of shell names to match in the query and/or search
skip Double: A filter to specify the number of items to skip in the response.
spaceId String: The space ID associated with this resource.
take Double: A filter to specify the number of items to take (or return) in the response.
tenantTags List<String>: A filter to search by a list of tenant tags.
tenants List<String>: A filter to search by a list of tenant IDs.
thumbprint String: The thumbprint of the deployment target to match in the query and/or search

deploymentId string: A filter to search by deployment ID.
environments string[]: A filter to search by a list of environment IDs.
healthStatuses string[]: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids string[]: A filter to search by a list of IDs.
isDisabled boolean: A filter to search by the disabled status of a resource.
name string: A filter to search by name.
partialName string: A filter to search by the partial match of a name.
roles string[]: A filter to search by a list of role IDs.
shellNames string[]: A list of shell names to match in the query and/or search
skip number: A filter to specify the number of items to skip in the response.
spaceId string: The space ID associated with this resource.
take number: A filter to specify the number of items to take (or return) in the response.
tenantTags string[]: A filter to search by a list of tenant tags.
tenants string[]: A filter to search by a list of tenant IDs.
thumbprint string: The thumbprint of the deployment target to match in the query and/or search

deployment_id str: A filter to search by deployment ID.
environments Sequence[str]: A filter to search by a list of environment IDs.
health_statuses Sequence[str]: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids Sequence[str]: A filter to search by a list of IDs.
is_disabled bool: A filter to search by the disabled status of a resource.
name str: A filter to search by name.
partial_name str: A filter to search by the partial match of a name.
roles Sequence[str]: A filter to search by a list of role IDs.
shell_names Sequence[str]: A list of shell names to match in the query and/or search
skip float: A filter to specify the number of items to skip in the response.
space_id str: The space ID associated with this resource.
take float: A filter to specify the number of items to take (or return) in the response.
tenant_tags Sequence[str]: A filter to search by a list of tenant tags.
tenants Sequence[str]: A filter to search by a list of tenant IDs.
thumbprint str: The thumbprint of the deployment target to match in the query and/or search

deploymentId String: A filter to search by deployment ID.
environments List<String>: A filter to search by a list of environment IDs.
healthStatuses List<String>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids List<String>: A filter to search by a list of IDs.
isDisabled Boolean: A filter to search by the disabled status of a resource.
name String: A filter to search by name.
partialName String: A filter to search by the partial match of a name.
roles List<String>: A filter to search by a list of role IDs.
shellNames List<String>: A list of shell names to match in the query and/or search
skip Number: A filter to specify the number of items to skip in the response.
spaceId String: The space ID associated with this resource.
take Number: A filter to specify the number of items to take (or return) in the response.
tenantTags List<String>: A filter to search by a list of tenant tags.
tenants List<String>: A filter to search by a list of tenant IDs.
thumbprint String: The thumbprint of the deployment target to match in the query and/or search

getKubernetesAgentDeploymentTargets Result

The following output properties are available:

Id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
KubernetesAgentDeploymentTargets List<GetKubernetesAgentDeploymentTargetsKubernetesAgentDeploymentTarget>: A list of kubernetes agent deployment targets that match the filter(s).
SpaceId string: The space ID associated with this resource.
DeploymentId string: A filter to search by deployment ID.
Environments List<string>: A filter to search by a list of environment IDs.
HealthStatuses List<string>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
Ids List<string>: A filter to search by a list of IDs.
IsDisabled bool: A filter to search by the disabled status of a resource.
Name string: A filter to search by name.
PartialName string: A filter to search by the partial match of a name.
Roles List<string>: A filter to search by a list of role IDs.
ShellNames List<string>: A list of shell names to match in the query and/or search
Skip double: A filter to specify the number of items to skip in the response.
Take double: A filter to specify the number of items to take (or return) in the response.
TenantTags List<string>: A filter to search by a list of tenant tags.
Tenants List<string>: A filter to search by a list of tenant IDs.
Thumbprint string: The thumbprint of the deployment target to match in the query and/or search

Id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
KubernetesAgentDeploymentTargets []GetKubernetesAgentDeploymentTargetsKubernetesAgentDeploymentTarget: A list of kubernetes agent deployment targets that match the filter(s).
SpaceId string: The space ID associated with this resource.
DeploymentId string: A filter to search by deployment ID.
Environments []string: A filter to search by a list of environment IDs.
HealthStatuses []string: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
Ids []string: A filter to search by a list of IDs.
IsDisabled bool: A filter to search by the disabled status of a resource.
Name string: A filter to search by name.
PartialName string: A filter to search by the partial match of a name.
Roles []string: A filter to search by a list of role IDs.
ShellNames []string: A list of shell names to match in the query and/or search
Skip float64: A filter to specify the number of items to skip in the response.
Take float64: A filter to specify the number of items to take (or return) in the response.
TenantTags []string: A filter to search by a list of tenant tags.
Tenants []string: A filter to search by a list of tenant IDs.
Thumbprint string: The thumbprint of the deployment target to match in the query and/or search

id String: An auto-generated identifier that includes the timestamp when this data source was last modified.
kubernetesAgentDeploymentTargets List<GetKubernetesAgentDeploymentTargetsKubernetesAgentDeploymentTarget>: A list of kubernetes agent deployment targets that match the filter(s).
spaceId String: The space ID associated with this resource.
deploymentId String: A filter to search by deployment ID.
environments List<String>: A filter to search by a list of environment IDs.
healthStatuses List<String>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids List<String>: A filter to search by a list of IDs.
isDisabled Boolean: A filter to search by the disabled status of a resource.
name String: A filter to search by name.
partialName String: A filter to search by the partial match of a name.
roles List<String>: A filter to search by a list of role IDs.
shellNames List<String>: A list of shell names to match in the query and/or search
skip Double: A filter to specify the number of items to skip in the response.
take Double: A filter to specify the number of items to take (or return) in the response.
tenantTags List<String>: A filter to search by a list of tenant tags.
tenants List<String>: A filter to search by a list of tenant IDs.
thumbprint String: The thumbprint of the deployment target to match in the query and/or search

id string: An auto-generated identifier that includes the timestamp when this data source was last modified.
kubernetesAgentDeploymentTargets GetKubernetesAgentDeploymentTargetsKubernetesAgentDeploymentTarget[]: A list of kubernetes agent deployment targets that match the filter(s).
spaceId string: The space ID associated with this resource.
deploymentId string: A filter to search by deployment ID.
environments string[]: A filter to search by a list of environment IDs.
healthStatuses string[]: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids string[]: A filter to search by a list of IDs.
isDisabled boolean: A filter to search by the disabled status of a resource.
name string: A filter to search by name.
partialName string: A filter to search by the partial match of a name.
roles string[]: A filter to search by a list of role IDs.
shellNames string[]: A list of shell names to match in the query and/or search
skip number: A filter to specify the number of items to skip in the response.
take number: A filter to specify the number of items to take (or return) in the response.
tenantTags string[]: A filter to search by a list of tenant tags.
tenants string[]: A filter to search by a list of tenant IDs.
thumbprint string: The thumbprint of the deployment target to match in the query and/or search

id str: An auto-generated identifier that includes the timestamp when this data source was last modified.
kubernetes_agent_deployment_targets Sequence[GetKubernetesAgentDeploymentTargetsKubernetesAgentDeploymentTarget]: A list of kubernetes agent deployment targets that match the filter(s).
space_id str: The space ID associated with this resource.
deployment_id str: A filter to search by deployment ID.
environments Sequence[str]: A filter to search by a list of environment IDs.
health_statuses Sequence[str]: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids Sequence[str]: A filter to search by a list of IDs.
is_disabled bool: A filter to search by the disabled status of a resource.
name str: A filter to search by name.
partial_name str: A filter to search by the partial match of a name.
roles Sequence[str]: A filter to search by a list of role IDs.
shell_names Sequence[str]: A list of shell names to match in the query and/or search
skip float: A filter to specify the number of items to skip in the response.
take float: A filter to specify the number of items to take (or return) in the response.
tenant_tags Sequence[str]: A filter to search by a list of tenant tags.
tenants Sequence[str]: A filter to search by a list of tenant IDs.
thumbprint str: The thumbprint of the deployment target to match in the query and/or search

id String: An auto-generated identifier that includes the timestamp when this data source was last modified.
kubernetesAgentDeploymentTargets List<Property Map>: A list of kubernetes agent deployment targets that match the filter(s).
spaceId String: The space ID associated with this resource.
deploymentId String: A filter to search by deployment ID.
environments List<String>: A filter to search by a list of environment IDs.
healthStatuses List<String>: A filter to search by a list of health statuses of resources. Valid health statuses are HasWarnings, Healthy, Unavailable, Unhealthy, or Unknown.
ids List<String>: A filter to search by a list of IDs.
isDisabled Boolean: A filter to search by the disabled status of a resource.
name String: A filter to search by name.
partialName String: A filter to search by the partial match of a name.
roles List<String>: A filter to search by a list of role IDs.
shellNames List<String>: A list of shell names to match in the query and/or search
skip Number: A filter to specify the number of items to skip in the response.
take Number: A filter to specify the number of items to take (or return) in the response.
tenantTags List<String>: A filter to search by a list of tenant tags.
tenants List<String>: A filter to search by a list of tenant IDs.
thumbprint String: The thumbprint of the deployment target to match in the query and/or search