Data source for retrieving a list of Harness delegates.
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 dictionaryThe following arguments are supported:
- Account
Id string - Account identifier.
- Filter
Type string - Filter type for delegates.
- Auto
Upgrade string - Filter delegates by auto upgrade setting.
- Delegate
Group stringIdentifier - Filter delegates by group identifier.
- Delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- Delegate
Name string - Filter delegates by name.
- List<string>
- Filter delegates by tags.
- Fetch
All bool - Whether to fetch all delegates. Defaults to
false. - Org
Id string - Organization identifier.
- Project
Id string - Project identifier.
- Status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- Version
Status string - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- Account
Id string - Account identifier.
- Filter
Type string - Filter type for delegates.
- Auto
Upgrade string - Filter delegates by auto upgrade setting.
- Delegate
Group stringIdentifier - Filter delegates by group identifier.
- Delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- Delegate
Name string - Filter delegates by name.
- []string
- Filter delegates by tags.
- Fetch
All bool - Whether to fetch all delegates. Defaults to
false. - Org
Id string - Organization identifier.
- Project
Id string - Project identifier.
- Status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- Version
Status string - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- account
Id String - Account identifier.
- filter
Type String - Filter type for delegates.
- auto
Upgrade String - Filter delegates by auto upgrade setting.
- delegate
Group StringIdentifier - Filter delegates by group identifier.
- delegate
Instance StringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name String - Filter delegates by name.
- List<String>
- Filter delegates by tags.
- fetch
All Boolean - Whether to fetch all delegates. Defaults to
false. - org
Id String - Organization identifier.
- project
Id String - Project identifier.
- status String
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status String - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- account
Id string - Account identifier.
- filter
Type string - Filter type for delegates.
- auto
Upgrade string - Filter delegates by auto upgrade setting.
- delegate
Group stringIdentifier - Filter delegates by group identifier.
- delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name string - Filter delegates by name.
- string[]
- Filter delegates by tags.
- fetch
All boolean - Whether to fetch all delegates. Defaults to
false. - org
Id string - Organization identifier.
- project
Id string - Project identifier.
- status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status 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_ stridentifier - Filter delegates by group identifier.
- delegate_
instance_ strfilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate_
name str - Filter delegates by name.
- 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.
- account
Id String - Account identifier.
- filter
Type String - Filter type for delegates.
- auto
Upgrade String - Filter delegates by auto upgrade setting.
- delegate
Group StringIdentifier - Filter delegates by group identifier.
- delegate
Instance StringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name String - Filter delegates by name.
- List<String>
- Filter delegates by tags.
- fetch
All Boolean - Whether to fetch all delegates. Defaults to
false. - org
Id String - Organization identifier.
- project
Id String - Project identifier.
- status String
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status String - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
getDelegateList Result
The following output properties are available:
- Account
Id string - Account identifier.
- Delegates
List<Get
Delegate List Delegate> - List of delegates.
- Filter
Type string - Filter type for delegates.
- Id string
- The provider-assigned unique ID for this managed resource.
- Auto
Upgrade string - Filter delegates by auto upgrade setting.
- Delegate
Group stringIdentifier - Filter delegates by group identifier.
- Delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- Delegate
Name string - Filter delegates by name.
- List<string>
- Filter delegates by tags.
- Fetch
All bool - Whether to fetch all delegates. Defaults to
false. - Org
Id string - Organization identifier.
- Project
Id string - Project identifier.
- Status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- Version
Status string - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- Account
Id string - Account identifier.
- Delegates
[]Get
Delegate List Delegate - List of delegates.
- Filter
Type string - Filter type for delegates.
- Id string
- The provider-assigned unique ID for this managed resource.
- Auto
Upgrade string - Filter delegates by auto upgrade setting.
- Delegate
Group stringIdentifier - Filter delegates by group identifier.
- Delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- Delegate
Name string - Filter delegates by name.
- []string
- Filter delegates by tags.
- Fetch
All bool - Whether to fetch all delegates. Defaults to
false. - Org
Id string - Organization identifier.
- Project
Id string - Project identifier.
- Status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- Version
Status string - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- account
Id String - Account identifier.
- delegates
List<Get
Delegate List Delegate> - List of delegates.
- filter
Type String - Filter type for delegates.
- id String
- The provider-assigned unique ID for this managed resource.
- auto
Upgrade String - Filter delegates by auto upgrade setting.
- delegate
Group StringIdentifier - Filter delegates by group identifier.
- delegate
Instance StringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name String - Filter delegates by name.
- List<String>
- Filter delegates by tags.
- fetch
All Boolean - Whether to fetch all delegates. Defaults to
false. - org
Id String - Organization identifier.
- project
Id String - Project identifier.
- status String
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status String - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- account
Id string - Account identifier.
- delegates
Get
Delegate List Delegate[] - List of delegates.
- filter
Type string - Filter type for delegates.
- id string
- The provider-assigned unique ID for this managed resource.
- auto
Upgrade string - Filter delegates by auto upgrade setting.
- delegate
Group stringIdentifier - Filter delegates by group identifier.
- delegate
Instance stringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name string - Filter delegates by name.
- string[]
- Filter delegates by tags.
- fetch
All boolean - Whether to fetch all delegates. Defaults to
false. - org
Id string - Organization identifier.
- project
Id string - Project identifier.
- status string
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status string - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
- account_
id str - Account identifier.
- delegates
Sequence[Get
Delegate List Delegate] - 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_ stridentifier - Filter delegates by group identifier.
- delegate_
instance_ strfilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate_
name str - Filter delegates by name.
- 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.
- account
Id String - Account identifier.
- delegates List<Property Map>
- List of delegates.
- filter
Type String - Filter type for delegates.
- id String
- The provider-assigned unique ID for this managed resource.
- auto
Upgrade String - Filter delegates by auto upgrade setting.
- delegate
Group StringIdentifier - Filter delegates by group identifier.
- delegate
Instance StringFilter - Filter delegate instances. Valid values: AVAILABLE, EXPIRED.
- delegate
Name String - Filter delegates by name.
- List<String>
- Filter delegates by tags.
- fetch
All Boolean - Whether to fetch all delegates. Defaults to
false. - org
Id String - Organization identifier.
- project
Id String - Project identifier.
- status String
- Filter delegates by status. Valid values: CONNECTED, DISCONNECTED, ENABLED, DISABLED, WAITINGFORAPPROVAL, DELETED.
- version
Status String - Filter delegates by version status. Valid values: ACTIVE, EXPIRED, EXPIRING, UNSUPPORTED.
Supporting Types
GetDelegateListDelegate
- Auto
Upgrade 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.
- List<string>
- Delegate tags.
- Type string
- Delegate type (e.g., HELM_DELEGATE).
- Auto
Upgrade 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.
- []string
- Delegate tags.
- Type string
- Delegate type (e.g., HELM_DELEGATE).
- auto
Upgrade 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.
- List<String>
- Delegate tags.
- type String
- Delegate type (e.g., HELM_DELEGATE).
- auto
Upgrade 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.
- 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.
- Sequence[str]
- Delegate tags.
- type str
- Delegate type (e.g., HELM_DELEGATE).
- auto
Upgrade 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.
- 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
harnessTerraform Provider.
