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

octopusdeploy.getKubernetesAgentWorkers

Explore with Pulumi AI

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

    Provides information about existing kubernetes agent workers.

    Using getKubernetesAgentWorkers

    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 getKubernetesAgentWorkers(args: GetKubernetesAgentWorkersArgs, opts?: InvokeOptions): Promise<GetKubernetesAgentWorkersResult>
function getKubernetesAgentWorkersOutput(args: GetKubernetesAgentWorkersOutputArgs, opts?: InvokeOptions): Output<GetKubernetesAgentWorkersResult>
    def get_kubernetes_agent_workers(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,
                                 thumbprint: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetKubernetesAgentWorkersResult
def get_kubernetes_agent_workers_output(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,
                                 thumbprint: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesAgentWorkersResult]
    func GetKubernetesAgentWorkers(ctx *Context, args *GetKubernetesAgentWorkersArgs, opts ...InvokeOption) (*GetKubernetesAgentWorkersResult, error)
func GetKubernetesAgentWorkersOutput(ctx *Context, args *GetKubernetesAgentWorkersOutputArgs, opts ...InvokeOption) GetKubernetesAgentWorkersResultOutput

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

    public static class GetKubernetesAgentWorkers 
{
    public static Task<GetKubernetesAgentWorkersResult> InvokeAsync(GetKubernetesAgentWorkersArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesAgentWorkersResult> Invoke(GetKubernetesAgentWorkersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKubernetesAgentWorkersResult> getKubernetesAgentWorkers(GetKubernetesAgentWorkersArgs args, InvokeOptions options)
public static Output<GetKubernetesAgentWorkersResult> getKubernetesAgentWorkers(GetKubernetesAgentWorkersArgs args, InvokeOptions options)

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

    The following arguments are supported:

    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.
    Thumbprint string
    The thumbprint of the deployment target to match in the query and/or search
    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.
    Thumbprint string
    The thumbprint of the deployment target to match in the query and/or search
    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.
    thumbprint String
    The thumbprint of the deployment target to match in the query and/or search
    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.
    thumbprint string
    The thumbprint of the deployment target to match in the query and/or search
    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.
    thumbprint str
    The thumbprint of the deployment target to match in the query and/or search
    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.
    thumbprint String
    The thumbprint of the deployment target to match in the query and/or search

    getKubernetesAgentWorkers Result

    The following output properties are available:

    Id string
    An auto-generated identifier that includes the timestamp when this data source was last modified.
    KubernetesAgentWorkers List<GetKubernetesAgentWorkersKubernetesAgentWorker>
    A list of kubernetes agent workers that match the filter(s).
    SpaceId string
    The space ID associated with this resource.
    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.
    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.
    KubernetesAgentWorkers []GetKubernetesAgentWorkersKubernetesAgentWorker
    A list of kubernetes agent workers that match the filter(s).
    SpaceId string
    The space ID associated with this resource.
    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.
    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.
    kubernetesAgentWorkers List<GetKubernetesAgentWorkersKubernetesAgentWorker>
    A list of kubernetes agent workers that match the filter(s).
    spaceId String
    The space ID associated with this resource.
    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.
    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.
    kubernetesAgentWorkers GetKubernetesAgentWorkersKubernetesAgentWorker[]
    A list of kubernetes agent workers that match the filter(s).
    spaceId string
    The space ID associated with this resource.
    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.
    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_workers Sequence[GetKubernetesAgentWorkersKubernetesAgentWorker]
    A list of kubernetes agent workers that match the filter(s).
    space_id str
    The space ID associated with this resource.
    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.
    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.
    kubernetesAgentWorkers List<Property Map>
    A list of kubernetes agent workers that match the filter(s).
    spaceId String
    The space ID associated with this resource.
    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.
    thumbprint String
    The thumbprint of the deployment target to match in the query and/or search

    Supporting Types

    GetKubernetesAgentWorkersKubernetesAgentWorker

    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