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

octopusdeploy.getWorkerPools

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 worker pools.

    Using getWorkerPools

    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 getWorkerPools(args: GetWorkerPoolsArgs, opts?: InvokeOptions): Promise<GetWorkerPoolsResult>
function getWorkerPoolsOutput(args: GetWorkerPoolsOutputArgs, opts?: InvokeOptions): Output<GetWorkerPoolsResult>
    def get_worker_pools(id: Optional[str] = None,
                     ids: Optional[Sequence[str]] = None,
                     name: Optional[str] = None,
                     partial_name: Optional[str] = None,
                     skip: Optional[float] = None,
                     space_id: Optional[str] = None,
                     take: Optional[float] = None,
                     opts: Optional[InvokeOptions] = None) -> GetWorkerPoolsResult
def get_worker_pools_output(id: Optional[pulumi.Input[str]] = None,
                     ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     partial_name: Optional[pulumi.Input[str]] = None,
                     skip: Optional[pulumi.Input[float]] = None,
                     space_id: Optional[pulumi.Input[str]] = None,
                     take: Optional[pulumi.Input[float]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetWorkerPoolsResult]
    func GetWorkerPools(ctx *Context, args *GetWorkerPoolsArgs, opts ...InvokeOption) (*GetWorkerPoolsResult, error)
func GetWorkerPoolsOutput(ctx *Context, args *GetWorkerPoolsOutputArgs, opts ...InvokeOption) GetWorkerPoolsResultOutput

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

    public static class GetWorkerPools 
{
    public static Task<GetWorkerPoolsResult> InvokeAsync(GetWorkerPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkerPoolsResult> Invoke(GetWorkerPoolsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkerPoolsResult> getWorkerPools(GetWorkerPoolsArgs args, InvokeOptions options)
public static Output<GetWorkerPoolsResult> getWorkerPools(GetWorkerPoolsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    The ID of this resource.
    Ids List<string>
    A filter to search by a list of IDs.
    Name string
    A filter to search by name.
    PartialName string
    A filter to search by the partial match of a name.
    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.
    Id string
    The ID of this resource.
    Ids []string
    A filter to search by a list of IDs.
    Name string
    A filter to search by name.
    PartialName string
    A filter to search by the partial match of a name.
    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.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    A filter to search by name.
    partialName String
    A filter to search by the partial match of a name.
    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.
    id string
    The ID of this resource.
    ids string[]
    A filter to search by a list of IDs.
    name string
    A filter to search by name.
    partialName string
    A filter to search by the partial match of a name.
    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.
    id str
    The ID of this resource.
    ids Sequence[str]
    A filter to search by a list of IDs.
    name str
    A filter to search by name.
    partial_name str
    A filter to search by the partial match of a name.
    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.
    id String
    The ID of this resource.
    ids List<String>
    A filter to search by a list of IDs.
    name String
    A filter to search by name.
    partialName String
    A filter to search by the partial match of a name.
    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.

    getWorkerPools Result

    The following output properties are available:

    Id string
    The ID of this resource.
    SpaceId string
    The space ID associated with this resource.
    WorkerPools List<GetWorkerPoolsWorkerPool>
    A list of worker pools that match the filter(s).
    Ids List<string>
    A filter to search by a list of IDs.
    Name string
    A filter to search by name.
    PartialName string
    A filter to search by the partial match of a name.
    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.
    Id string
    The ID of this resource.
    SpaceId string
    The space ID associated with this resource.
    WorkerPools []GetWorkerPoolsWorkerPool
    A list of worker pools that match the filter(s).
    Ids []string
    A filter to search by a list of IDs.
    Name string
    A filter to search by name.
    PartialName string
    A filter to search by the partial match of a name.
    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.
    id String
    The ID of this resource.
    spaceId String
    The space ID associated with this resource.
    workerPools List<GetWorkerPoolsWorkerPool>
    A list of worker pools that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    name String
    A filter to search by name.
    partialName String
    A filter to search by the partial match of a name.
    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.
    id string
    The ID of this resource.
    spaceId string
    The space ID associated with this resource.
    workerPools GetWorkerPoolsWorkerPool[]
    A list of worker pools that match the filter(s).
    ids string[]
    A filter to search by a list of IDs.
    name string
    A filter to search by name.
    partialName string
    A filter to search by the partial match of a name.
    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.
    id str
    The ID of this resource.
    space_id str
    The space ID associated with this resource.
    worker_pools Sequence[GetWorkerPoolsWorkerPool]
    A list of worker pools that match the filter(s).
    ids Sequence[str]
    A filter to search by a list of IDs.
    name str
    A filter to search by name.
    partial_name str
    A filter to search by the partial match of a name.
    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.
    id String
    The ID of this resource.
    spaceId String
    The space ID associated with this resource.
    workerPools List<Property Map>
    A list of worker pools that match the filter(s).
    ids List<String>
    A filter to search by a list of IDs.
    name String
    A filter to search by name.
    partialName String
    A filter to search by the partial match of a name.
    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.

    Supporting Types

    GetWorkerPoolsWorkerPool

    CanAddWorkers bool
    Description string
    Id string
    IsDefault bool
    Name string
    SortOrder double
    SpaceId string
    WorkerPoolType string
    WorkerType string
    CanAddWorkers bool
    Description string
    Id string
    IsDefault bool
    Name string
    SortOrder float64
    SpaceId string
    WorkerPoolType string
    WorkerType string
    canAddWorkers Boolean
    description String
    id String
    isDefault Boolean
    name String
    sortOrder Double
    spaceId String
    workerPoolType String
    workerType String
    canAddWorkers boolean
    description string
    id string
    isDefault boolean
    name string
    sortOrder number
    spaceId string
    workerPoolType string
    workerType string
    canAddWorkers Boolean
    description String
    id String
    isDefault Boolean
    name String
    sortOrder Number
    spaceId String
    workerPoolType String
    workerType String

    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