harness.platform.getDelegateList

Harness v0.11.6, Mar 12 26

Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

Example Usage

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

// Get all delegates in an account
const all = harness.platform.getDelegateList({
    accountId: "your_account_id",
    filterType: "Delegate",
    fetchAll: true,
});
// Get only connected delegates with specific tags
const connectedWithTags = harness.platform.getDelegateList({
    accountId: "your_account_id",
    orgId: "your_org_id",
    projectId: "your_project_id",
    filterType: "Delegate",
    status: "CONNECTED",
    delegateTags: [
        "production",
        "kubernetes",
    ],
});
// Get delegates by name pattern and group
const specificGroup = harness.platform.getDelegateList({
    accountId: "your_account_id",
    filterType: "Delegate",
    delegateName: "prod-delegate",
    delegateGroupIdentifier: "production-group",
    versionStatus: "ACTIVE",
});

import pulumi
import pulumi_harness as harness

# Get all delegates in an account
all = harness.platform.get_delegate_list(account_id="your_account_id",
    filter_type="Delegate",
    fetch_all=True)
# Get only connected delegates with specific tags
connected_with_tags = harness.platform.get_delegate_list(account_id="your_account_id",
    org_id="your_org_id",
    project_id="your_project_id",
    filter_type="Delegate",
    status="CONNECTED",
    delegate_tags=[
        "production",
        "kubernetes",
    ])
# Get delegates by name pattern and group
specific_group = harness.platform.get_delegate_list(account_id="your_account_id",
    filter_type="Delegate",
    delegate_name="prod-delegate",
    delegate_group_identifier="production-group",
    version_status="ACTIVE")

package main

import (
	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Get all delegates in an account
		_, err := platform.GetDelegateList(ctx, &platform.GetDelegateListArgs{
			AccountId:  "your_account_id",
			FilterType: "Delegate",
			FetchAll:   pulumi.BoolRef(true),
		}, nil)
		if err != nil {
			return err
		}
		// Get only connected delegates with specific tags
		_, err = platform.GetDelegateList(ctx, &platform.GetDelegateListArgs{
			AccountId:  "your_account_id",
			OrgId:      pulumi.StringRef("your_org_id"),
			ProjectId:  pulumi.StringRef("your_project_id"),
			FilterType: "Delegate",
			Status:     pulumi.StringRef("CONNECTED"),
			DelegateTags: []string{
				"production",
				"kubernetes",
			},
		}, nil)
		if err != nil {
			return err
		}
		// Get delegates by name pattern and group
		_, err = platform.GetDelegateList(ctx, &platform.GetDelegateListArgs{
			AccountId:               "your_account_id",
			FilterType:              "Delegate",
			DelegateName:            pulumi.StringRef("prod-delegate"),
			DelegateGroupIdentifier: pulumi.StringRef("production-group"),
			VersionStatus:           pulumi.StringRef("ACTIVE"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Get all delegates in an account
    var all = Harness.Platform.GetDelegateList.Invoke(new()
    {
        AccountId = "your_account_id",
        FilterType = "Delegate",
        FetchAll = true,
    });

    // Get only connected delegates with specific tags
    var connectedWithTags = Harness.Platform.GetDelegateList.Invoke(new()
    {
        AccountId = "your_account_id",
        OrgId = "your_org_id",
        ProjectId = "your_project_id",
        FilterType = "Delegate",
        Status = "CONNECTED",
        DelegateTags = new[]
        {
            "production",
            "kubernetes",
        },
    });

    // Get delegates by name pattern and group
    var specificGroup = Harness.Platform.GetDelegateList.Invoke(new()
    {
        AccountId = "your_account_id",
        FilterType = "Delegate",
        DelegateName = "prod-delegate",
        DelegateGroupIdentifier = "production-group",
        VersionStatus = "ACTIVE",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.harness.platform.PlatformFunctions;
import com.pulumi.harness.platform.inputs.GetDelegateListArgs;
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) {
        // Get all delegates in an account
        final var all = PlatformFunctions.getDelegateList(GetDelegateListArgs.builder()
            .accountId("your_account_id")
            .filterType("Delegate")
            .fetchAll(true)
            .build());

        // Get only connected delegates with specific tags
        final var connectedWithTags = PlatformFunctions.getDelegateList(GetDelegateListArgs.builder()
            .accountId("your_account_id")
            .orgId("your_org_id")
            .projectId("your_project_id")
            .filterType("Delegate")
            .status("CONNECTED")
            .delegateTags(            
                "production",
                "kubernetes")
            .build());

        // Get delegates by name pattern and group
        final var specificGroup = PlatformFunctions.getDelegateList(GetDelegateListArgs.builder()
            .accountId("your_account_id")
            .filterType("Delegate")
            .delegateName("prod-delegate")
            .delegateGroupIdentifier("production-group")
            .versionStatus("ACTIVE")
            .build());

    }
}

variables:
  # Get all delegates in an account
  all:
    fn::invoke:
      function: harness:platform:getDelegateList
      arguments:
        accountId: your_account_id
        filterType: Delegate
        fetchAll: true
  # Get only connected delegates with specific tags
  connectedWithTags:
    fn::invoke:
      function: harness:platform:getDelegateList
      arguments:
        accountId: your_account_id
        orgId: your_org_id
        projectId: your_project_id
        filterType: Delegate
        status: CONNECTED
        delegateTags:
          - production
          - kubernetes
  # Get delegates by name pattern and group
  specificGroup:
    fn::invoke:
      function: harness:platform:getDelegateList
      arguments:
        accountId: your_account_id
        filterType: Delegate
        delegateName: prod-delegate
        delegateGroupIdentifier: production-group
        versionStatus: ACTIVE

Using getDelegateList

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 getDelegateList(args: GetDelegateListArgs, opts?: InvokeOptions): Promise<GetDelegateListResult>
function getDelegateListOutput(args: GetDelegateListOutputArgs, opts?: InvokeOptions): Output<GetDelegateListResult>

def get_delegate_list(account_id: Optional[str] = None,
                      auto_upgrade: Optional[str] = None,
                      delegate_group_identifier: Optional[str] = None,
                      delegate_instance_filter: Optional[str] = None,
                      delegate_name: Optional[str] = None,
                      delegate_tags: Optional[Sequence[str]] = None,
                      fetch_all: Optional[bool] = None,
                      filter_type: Optional[str] = None,
                      org_id: Optional[str] = None,
                      project_id: Optional[str] = None,
                      status: Optional[str] = None,
                      version_status: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDelegateListResult
def get_delegate_list_output(account_id: Optional[pulumi.Input[str]] = None,
                      auto_upgrade: Optional[pulumi.Input[str]] = None,
                      delegate_group_identifier: Optional[pulumi.Input[str]] = None,
                      delegate_instance_filter: Optional[pulumi.Input[str]] = None,
                      delegate_name: Optional[pulumi.Input[str]] = None,
                      delegate_tags: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                      fetch_all: Optional[pulumi.Input[bool]] = None,
                      filter_type: Optional[pulumi.Input[str]] = None,
                      org_id: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[str]] = None,
                      status: Optional[pulumi.Input[str]] = None,
                      version_status: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDelegateListResult]

func GetDelegateList(ctx *Context, args *GetDelegateListArgs, opts ...InvokeOption) (*GetDelegateListResult, error)
func GetDelegateListOutput(ctx *Context, args *GetDelegateListOutputArgs, opts ...InvokeOption) GetDelegateListResultOutput

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

public static class GetDelegateList 
{
    public static Task<GetDelegateListResult> InvokeAsync(GetDelegateListArgs args, InvokeOptions? opts = null)
    public static Output<GetDelegateListResult> Invoke(GetDelegateListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDelegateListResult> getDelegateList(GetDelegateListArgs args, InvokeOptions options)
public static Output<GetDelegateListResult> getDelegateList(GetDelegateListArgs args, InvokeOptions options)

fn::invoke:
  function: harness:platform/getDelegateList:getDelegateList
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: Account identifier.
FilterType string: Filter type for delegates.
AutoUpgrade string: Filter delegates by auto upgrade setting.
DelegateGroupIdentifier string: Filter delegates by group identifier.
DelegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
DelegateName string: Filter delegates by name.
DelegateTags List<string>: Filter delegates by tags.
FetchAll bool: Whether to fetch all delegates. Defaults to false.
OrgId string: Organization identifier.
ProjectId string: Project identifier.
Status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
VersionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

AccountId string: Account identifier.
FilterType string: Filter type for delegates.
AutoUpgrade string: Filter delegates by auto upgrade setting.
DelegateGroupIdentifier string: Filter delegates by group identifier.
DelegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
DelegateName string: Filter delegates by name.
DelegateTags []string: Filter delegates by tags.
FetchAll bool: Whether to fetch all delegates. Defaults to false.
OrgId string: Organization identifier.
ProjectId string: Project identifier.
Status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
VersionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId String: Account identifier.
filterType String: Filter type for delegates.
autoUpgrade String: Filter delegates by auto upgrade setting.
delegateGroupIdentifier String: Filter delegates by group identifier.
delegateInstanceFilter String: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName String: Filter delegates by name.
delegateTags List<String>: Filter delegates by tags.
fetchAll Boolean: Whether to fetch all delegates. Defaults to false.
orgId String: Organization identifier.
projectId String: Project identifier.
status String: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus String: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId string: Account identifier.
filterType string: Filter type for delegates.
autoUpgrade string: Filter delegates by auto upgrade setting.
delegateGroupIdentifier string: Filter delegates by group identifier.
delegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName string: Filter delegates by name.
delegateTags string[]: Filter delegates by tags.
fetchAll boolean: Whether to fetch all delegates. Defaults to false.
orgId string: Organization identifier.
projectId string: Project identifier.
status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

account_id str: Account identifier.
filter_type str: Filter type for delegates.
auto_upgrade str: Filter delegates by auto upgrade setting.
delegate_group_identifier str: Filter delegates by group identifier.
delegate_instance_filter str: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegate_name str: Filter delegates by name.
delegate_tags Sequence[str]: Filter delegates by tags.
fetch_all bool: Whether to fetch all delegates. Defaults to false.
org_id str: Organization identifier.
project_id str: Project identifier.
status str: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
version_status str: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId String: Account identifier.
filterType String: Filter type for delegates.
autoUpgrade String: Filter delegates by auto upgrade setting.
delegateGroupIdentifier String: Filter delegates by group identifier.
delegateInstanceFilter String: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName String: Filter delegates by name.
delegateTags List<String>: Filter delegates by tags.
fetchAll Boolean: Whether to fetch all delegates. Defaults to false.
orgId String: Organization identifier.
projectId String: Project identifier.
status String: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus String: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

getDelegateList Result

The following output properties are available:

AccountId string: Account identifier.
Delegates List<GetDelegateListDelegate>: List of delegates.
FilterType string: Filter type for delegates.
Id string: The provider-assigned unique ID for this managed resource.
AutoUpgrade string: Filter delegates by auto upgrade setting.
DelegateGroupIdentifier string: Filter delegates by group identifier.
DelegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
DelegateName string: Filter delegates by name.
DelegateTags List<string>: Filter delegates by tags.
FetchAll bool: Whether to fetch all delegates. Defaults to false.
OrgId string: Organization identifier.
ProjectId string: Project identifier.
Status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
VersionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

AccountId string: Account identifier.
Delegates []GetDelegateListDelegate: List of delegates.
FilterType string: Filter type for delegates.
Id string: The provider-assigned unique ID for this managed resource.
AutoUpgrade string: Filter delegates by auto upgrade setting.
DelegateGroupIdentifier string: Filter delegates by group identifier.
DelegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
DelegateName string: Filter delegates by name.
DelegateTags []string: Filter delegates by tags.
FetchAll bool: Whether to fetch all delegates. Defaults to false.
OrgId string: Organization identifier.
ProjectId string: Project identifier.
Status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
VersionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId String: Account identifier.
delegates List<GetDelegateListDelegate>: List of delegates.
filterType String: Filter type for delegates.
id String: The provider-assigned unique ID for this managed resource.
autoUpgrade String: Filter delegates by auto upgrade setting.
delegateGroupIdentifier String: Filter delegates by group identifier.
delegateInstanceFilter String: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName String: Filter delegates by name.
delegateTags List<String>: Filter delegates by tags.
fetchAll Boolean: Whether to fetch all delegates. Defaults to false.
orgId String: Organization identifier.
projectId String: Project identifier.
status String: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus String: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId string: Account identifier.
delegates GetDelegateListDelegate[]: List of delegates.
filterType string: Filter type for delegates.
id string: The provider-assigned unique ID for this managed resource.
autoUpgrade string: Filter delegates by auto upgrade setting.
delegateGroupIdentifier string: Filter delegates by group identifier.
delegateInstanceFilter string: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName string: Filter delegates by name.
delegateTags string[]: Filter delegates by tags.
fetchAll boolean: Whether to fetch all delegates. Defaults to false.
orgId string: Organization identifier.
projectId string: Project identifier.
status string: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus string: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

account_id str: Account identifier.
delegates Sequence[GetDelegateListDelegate]: List of delegates.
filter_type str: Filter type for delegates.
id str: The provider-assigned unique ID for this managed resource.
auto_upgrade str: Filter delegates by auto upgrade setting.
delegate_group_identifier str: Filter delegates by group identifier.
delegate_instance_filter str: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegate_name str: Filter delegates by name.
delegate_tags Sequence[str]: Filter delegates by tags.
fetch_all bool: Whether to fetch all delegates. Defaults to false.
org_id str: Organization identifier.
project_id str: Project identifier.
status str: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
version_status str: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

accountId String: Account identifier.
delegates List<Property Map>: List of delegates.
filterType String: Filter type for delegates.
id String: The provider-assigned unique ID for this managed resource.
autoUpgrade String: Filter delegates by auto upgrade setting.
delegateGroupIdentifier String: Filter delegates by group identifier.
delegateInstanceFilter String: Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
delegateName String: Filter delegates by name.
delegateTags List<String>: Filter delegates by tags.
fetchAll Boolean: Whether to fetch all delegates. Defaults to false.
orgId String: Organization identifier.
projectId String: Project identifier.
status String: Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
versionStatus String: Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.

Supporting Types

GetDelegateListDelegate

AutoUpgrade string: Auto upgrade setting.
Connected bool: Whether the delegate is connected.
Description string: Delegate description.
Legacy bool: Whether this is a legacy delegate.
Name string: Delegate name.
Tags List<string>: Delegate tags.
Type string: Delegate type (e.g., HELM_DELEGATE).

AutoUpgrade string: Auto upgrade setting.
Connected bool: Whether the delegate is connected.
Description string: Delegate description.
Legacy bool: Whether this is a legacy delegate.
Name string: Delegate name.
Tags []string: Delegate tags.
Type string: Delegate type (e.g., HELM_DELEGATE).

autoUpgrade String: Auto upgrade setting.
connected Boolean: Whether the delegate is connected.
description String: Delegate description.
legacy Boolean: Whether this is a legacy delegate.
name String: Delegate name.
tags List<String>: Delegate tags.
type String: Delegate type (e.g., HELM_DELEGATE).

autoUpgrade string: Auto upgrade setting.
connected boolean: Whether the delegate is connected.
description string: Delegate description.
legacy boolean: Whether this is a legacy delegate.
name string: Delegate name.
tags string[]: Delegate tags.
type string: Delegate type (e.g., HELM_DELEGATE).

auto_upgrade str: Auto upgrade setting.
connected bool: Whether the delegate is connected.
description str: Delegate description.
legacy bool: Whether this is a legacy delegate.
name str: Delegate name.
tags Sequence[str]: Delegate tags.
type str: Delegate type (e.g., HELM_DELEGATE).

autoUpgrade String: Auto upgrade setting.
connected Boolean: Whether the delegate is connected.
description String: Delegate description.
legacy Boolean: Whether this is a legacy delegate.
name String: Delegate name.
tags List<String>: Delegate tags.
type String: Delegate type (e.g., HELM_DELEGATE).

Package Details

Repository: harness pulumi/pulumi-harness
License: Apache-2.0
Notes: This Pulumi package is based on the harness Terraform Provider.

Viewing docs for Harness v0.11.6
published on Thursday, Mar 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-harness

harness.platform.getDelegateList

On this page

On this page

Example Usage

Using getDelegateList

getDelegateList Result

Supporting Types

GetDelegateListDelegate

Package Details

On this page

On this page