ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
For more information, about container worker pool, see adding worker nodes and zones to clusters.
Example Usage
The following example shows how to import information about Kubernetes clusters.
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const testaccDsWorkerPool = ibm.getContainerWorkerPool({
workerPoolName: testPool.workerPoolName,
cluster: testaccCluster.id,
});
import pulumi
import pulumi_ibm as ibm
testacc_ds_worker_pool = ibm.get_container_worker_pool(worker_pool_name=test_pool["workerPoolName"],
cluster=testacc_cluster["id"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.LookupContainerWorkerPool(ctx, &ibm.LookupContainerWorkerPoolArgs{
WorkerPoolName: testPool.WorkerPoolName,
Cluster: testaccCluster.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var testaccDsWorkerPool = Ibm.GetContainerWorkerPool.Invoke(new()
{
WorkerPoolName = testPool.WorkerPoolName,
Cluster = testaccCluster.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetContainerWorkerPoolArgs;
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 testaccDsWorkerPool = IbmFunctions.getContainerWorkerPool(GetContainerWorkerPoolArgs.builder()
.workerPoolName(testPool.workerPoolName())
.cluster(testaccCluster.id())
.build());
}
}
variables:
testaccDsWorkerPool:
fn::invoke:
function: ibm:getContainerWorkerPool
arguments:
workerPoolName: ${testPool.workerPoolName}
cluster: ${testaccCluster.id}
Using getContainerWorkerPool
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 getContainerWorkerPool(args: GetContainerWorkerPoolArgs, opts?: InvokeOptions): Promise<GetContainerWorkerPoolResult>
function getContainerWorkerPoolOutput(args: GetContainerWorkerPoolOutputArgs, opts?: InvokeOptions): Output<GetContainerWorkerPoolResult>def get_container_worker_pool(cluster: Optional[str] = None,
id: Optional[str] = None,
worker_pool_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetContainerWorkerPoolResult
def get_container_worker_pool_output(cluster: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
worker_pool_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetContainerWorkerPoolResult]func LookupContainerWorkerPool(ctx *Context, args *LookupContainerWorkerPoolArgs, opts ...InvokeOption) (*LookupContainerWorkerPoolResult, error)
func LookupContainerWorkerPoolOutput(ctx *Context, args *LookupContainerWorkerPoolOutputArgs, opts ...InvokeOption) LookupContainerWorkerPoolResultOutput> Note: This function is named LookupContainerWorkerPool in the Go SDK.
public static class GetContainerWorkerPool
{
public static Task<GetContainerWorkerPoolResult> InvokeAsync(GetContainerWorkerPoolArgs args, InvokeOptions? opts = null)
public static Output<GetContainerWorkerPoolResult> Invoke(GetContainerWorkerPoolInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetContainerWorkerPoolResult> getContainerWorkerPool(GetContainerWorkerPoolArgs args, InvokeOptions options)
public static Output<GetContainerWorkerPoolResult> getContainerWorkerPool(GetContainerWorkerPoolArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getContainerWorkerPool:getContainerWorkerPool
arguments:
# arguments dictionaryThe following arguments are supported:
- Cluster string
- The name or ID of the cluster.
- Worker
Pool stringName - The name of the worker pool that need to be retrieved.
- Id string
- (String) The unique identifier of the worker pool.
- Cluster string
- The name or ID of the cluster.
- Worker
Pool stringName - The name of the worker pool that need to be retrieved.
- Id string
- (String) The unique identifier of the worker pool.
- cluster String
- The name or ID of the cluster.
- worker
Pool StringName - The name of the worker pool that need to be retrieved.
- id String
- (String) The unique identifier of the worker pool.
- cluster string
- The name or ID of the cluster.
- worker
Pool stringName - The name of the worker pool that need to be retrieved.
- id string
- (String) The unique identifier of the worker pool.
- cluster str
- The name or ID of the cluster.
- worker_
pool_ strname - The name of the worker pool that need to be retrieved.
- id str
- (String) The unique identifier of the worker pool.
- cluster String
- The name or ID of the cluster.
- worker
Pool StringName - The name of the worker pool that need to be retrieved.
- id String
- (String) The unique identifier of the worker pool.
getContainerWorkerPool Result
The following output properties are available:
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Cluster string
- Disk
Encryption bool - (String) Disk encryption on a worker.
- Hardware string
- (String) The level of hardware isolation for your worker node.
- Id string
- (String) The unique identifier of the worker pool.
- Labels Dictionary<string, string>
- (String) Labels on all the workers in the worker pool.
- Machine
Type string - (String) The machine type of the worker node.
- Operating
System string - (String) The operating system of the workers in the worker pool.
- Resource
Group stringId - (String) The ID of the worker pool resource group.
- Size
Per doubleZone - (String) Number of workers per zone in this pool.
- State string
- (String) Worker pool state.
- Worker
Pool stringName - Zones
List<Get
Container Worker Pool Zone> - (String) List of zones attached to the worker_pool.
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Cluster string
- Disk
Encryption bool - (String) Disk encryption on a worker.
- Hardware string
- (String) The level of hardware isolation for your worker node.
- Id string
- (String) The unique identifier of the worker pool.
- Labels map[string]string
- (String) Labels on all the workers in the worker pool.
- Machine
Type string - (String) The machine type of the worker node.
- Operating
System string - (String) The operating system of the workers in the worker pool.
- Resource
Group stringId - (String) The ID of the worker pool resource group.
- Size
Per float64Zone - (String) Number of workers per zone in this pool.
- State string
- (String) Worker pool state.
- Worker
Pool stringName - Zones
[]Get
Container Worker Pool Zone - (String) List of zones attached to the worker_pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster String
- disk
Encryption Boolean - (String) Disk encryption on a worker.
- hardware String
- (String) The level of hardware isolation for your worker node.
- id String
- (String) The unique identifier of the worker pool.
- labels Map<String,String>
- (String) Labels on all the workers in the worker pool.
- machine
Type String - (String) The machine type of the worker node.
- operating
System String - (String) The operating system of the workers in the worker pool.
- resource
Group StringId - (String) The ID of the worker pool resource group.
- size
Per DoubleZone - (String) Number of workers per zone in this pool.
- state String
- (String) Worker pool state.
- worker
Pool StringName - zones
List<Get
Container Worker Pool Zone> - (String) List of zones attached to the worker_pool.
- autoscale
Enabled boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster string
- disk
Encryption boolean - (String) Disk encryption on a worker.
- hardware string
- (String) The level of hardware isolation for your worker node.
- id string
- (String) The unique identifier of the worker pool.
- labels {[key: string]: string}
- (String) Labels on all the workers in the worker pool.
- machine
Type string - (String) The machine type of the worker node.
- operating
System string - (String) The operating system of the workers in the worker pool.
- resource
Group stringId - (String) The ID of the worker pool resource group.
- size
Per numberZone - (String) Number of workers per zone in this pool.
- state string
- (String) Worker pool state.
- worker
Pool stringName - zones
Get
Container Worker Pool Zone[] - (String) List of zones attached to the worker_pool.
- autoscale_
enabled bool - (Bool) Autoscaling is enabled on the workerpool
- cluster str
- disk_
encryption bool - (String) Disk encryption on a worker.
- hardware str
- (String) The level of hardware isolation for your worker node.
- id str
- (String) The unique identifier of the worker pool.
- labels Mapping[str, str]
- (String) Labels on all the workers in the worker pool.
- machine_
type str - (String) The machine type of the worker node.
- operating_
system str - (String) The operating system of the workers in the worker pool.
- resource_
group_ strid - (String) The ID of the worker pool resource group.
- size_
per_ floatzone - (String) Number of workers per zone in this pool.
- state str
- (String) Worker pool state.
- worker_
pool_ strname - zones
Sequence[Get
Container Worker Pool Zone] - (String) List of zones attached to the worker_pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster String
- disk
Encryption Boolean - (String) Disk encryption on a worker.
- hardware String
- (String) The level of hardware isolation for your worker node.
- id String
- (String) The unique identifier of the worker pool.
- labels Map<String>
- (String) Labels on all the workers in the worker pool.
- machine
Type String - (String) The machine type of the worker node.
- operating
System String - (String) The operating system of the workers in the worker pool.
- resource
Group StringId - (String) The ID of the worker pool resource group.
- size
Per NumberZone - (String) Number of workers per zone in this pool.
- state String
- (String) Worker pool state.
- worker
Pool StringName - zones List<Property Map>
- (String) List of zones attached to the worker_pool.
Supporting Types
GetContainerWorkerPoolZone
- Private
Vlan string - (String) The ID of the private VLAN.
- Public
Vlan string - (String) The ID of the public VLAN.
- Worker
Count double - (String) Number of workers attached to this zone.
- Zone string
- (String) Zone name.
- Private
Vlan string - (String) The ID of the private VLAN.
- Public
Vlan string - (String) The ID of the public VLAN.
- Worker
Count float64 - (String) Number of workers attached to this zone.
- Zone string
- (String) Zone name.
- private
Vlan String - (String) The ID of the private VLAN.
- public
Vlan String - (String) The ID of the public VLAN.
- worker
Count Double - (String) Number of workers attached to this zone.
- zone String
- (String) Zone name.
- private
Vlan string - (String) The ID of the private VLAN.
- public
Vlan string - (String) The ID of the public VLAN.
- worker
Count number - (String) Number of workers attached to this zone.
- zone string
- (String) Zone name.
- private_
vlan str - (String) The ID of the private VLAN.
- public_
vlan str - (String) The ID of the public VLAN.
- worker_
count float - (String) Number of workers attached to this zone.
- zone str
- (String) Zone name.
- private
Vlan String - (String) The ID of the private VLAN.
- public
Vlan String - (String) The ID of the public VLAN.
- worker
Count Number - (String) Number of workers attached to this zone.
- zone String
- (String) Zone name.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.
ibm 1.85.0 published on Sunday, Nov 9, 2025 by ibm-cloud
