1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiWorkspaces
ibm 1.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud
ibm logo
ibm 1.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud

    Retrieve information about Power Systems workspaces.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const workspaces = ibm.getPiWorkspaces({});
    
    import pulumi
    import pulumi_ibm as ibm
    
    workspaces = ibm.get_pi_workspaces()
    
    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.GetPiWorkspaces(ctx, &ibm.GetPiWorkspacesArgs{}, 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 workspaces = Ibm.GetPiWorkspaces.Invoke();
    
    });
    
    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.GetPiWorkspacesArgs;
    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 workspaces = IbmFunctions.getPiWorkspaces(GetPiWorkspacesArgs.builder()
                .build());
    
        }
    }
    
    variables:
      workspaces:
        fn::invoke:
          function: ibm:getPiWorkspaces
          arguments: {}
    

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Using getPiWorkspaces

    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 getPiWorkspaces(args: GetPiWorkspacesArgs, opts?: InvokeOptions): Promise<GetPiWorkspacesResult>
    function getPiWorkspacesOutput(args: GetPiWorkspacesOutputArgs, opts?: InvokeOptions): Output<GetPiWorkspacesResult>
    def get_pi_workspaces(id: Optional[str] = None,
                          pi_cloud_instance_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPiWorkspacesResult
    def get_pi_workspaces_output(id: Optional[pulumi.Input[str]] = None,
                          pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPiWorkspacesResult]
    func GetPiWorkspaces(ctx *Context, args *GetPiWorkspacesArgs, opts ...InvokeOption) (*GetPiWorkspacesResult, error)
    func GetPiWorkspacesOutput(ctx *Context, args *GetPiWorkspacesOutputArgs, opts ...InvokeOption) GetPiWorkspacesResultOutput

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

    public static class GetPiWorkspaces 
    {
        public static Task<GetPiWorkspacesResult> InvokeAsync(GetPiWorkspacesArgs args, InvokeOptions? opts = null)
        public static Output<GetPiWorkspacesResult> Invoke(GetPiWorkspacesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPiWorkspacesResult> getPiWorkspaces(GetPiWorkspacesArgs args, InvokeOptions options)
    public static Output<GetPiWorkspacesResult> getPiWorkspaces(GetPiWorkspacesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getPiWorkspaces:getPiWorkspaces
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    id String
    piCloudInstanceId String
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    id string
    piCloudInstanceId string
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    id str
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    id String
    piCloudInstanceId String
    The GUID of the service instance associated with an account. This field is deprecated and will be removed in a future release.

    Deprecated: Deprecated

    getPiWorkspaces Result

    The following output properties are available:

    Id string
    Workspaces List<GetPiWorkspacesWorkspace>
    (List) List of all Workspaces. Nested schema for workspaces
    PiCloudInstanceId string

    Deprecated: Deprecated

    Id string
    Workspaces []GetPiWorkspacesWorkspace
    (List) List of all Workspaces. Nested schema for workspaces
    PiCloudInstanceId string

    Deprecated: Deprecated

    id String
    workspaces List<GetPiWorkspacesWorkspace>
    (List) List of all Workspaces. Nested schema for workspaces
    piCloudInstanceId String

    Deprecated: Deprecated

    id string
    workspaces GetPiWorkspacesWorkspace[]
    (List) List of all Workspaces. Nested schema for workspaces
    piCloudInstanceId string

    Deprecated: Deprecated

    id str
    workspaces Sequence[GetPiWorkspacesWorkspace]
    (List) List of all Workspaces. Nested schema for workspaces
    pi_cloud_instance_id str

    Deprecated: Deprecated

    id String
    workspaces List<Property Map>
    (List) List of all Workspaces. Nested schema for workspaces
    piCloudInstanceId String

    Deprecated: Deprecated

    Supporting Types

    GetPiWorkspacesWorkspace

    PiWorkspaceCapabilities Dictionary<string, bool>
    (Map) Workspace Capabilities. Capabilities are true or false.
    PiWorkspaceDetails List<GetPiWorkspacesWorkspacePiWorkspaceDetail>
    (List) Workspace information.
    PiWorkspaceId string
    (String) Workspace ID.
    PiWorkspaceLocation Dictionary<string, string>
    (Map) Workspace location.
    PiWorkspaceName string
    (String) Workspace name.
    PiWorkspaceStatus string
    (String) Workspace status, active, critical, failed, provisioning.
    PiWorkspaceType string
    (String) Workspace type, off-premises or on-premises.
    PiWorkspaceCapabilities map[string]bool
    (Map) Workspace Capabilities. Capabilities are true or false.
    PiWorkspaceDetails []GetPiWorkspacesWorkspacePiWorkspaceDetail
    (List) Workspace information.
    PiWorkspaceId string
    (String) Workspace ID.
    PiWorkspaceLocation map[string]string
    (Map) Workspace location.
    PiWorkspaceName string
    (String) Workspace name.
    PiWorkspaceStatus string
    (String) Workspace status, active, critical, failed, provisioning.
    PiWorkspaceType string
    (String) Workspace type, off-premises or on-premises.
    piWorkspaceCapabilities Map<String,Boolean>
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails List<GetPiWorkspacesWorkspacePiWorkspaceDetail>
    (List) Workspace information.
    piWorkspaceId String
    (String) Workspace ID.
    piWorkspaceLocation Map<String,String>
    (Map) Workspace location.
    piWorkspaceName String
    (String) Workspace name.
    piWorkspaceStatus String
    (String) Workspace status, active, critical, failed, provisioning.
    piWorkspaceType String
    (String) Workspace type, off-premises or on-premises.
    piWorkspaceCapabilities {[key: string]: boolean}
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails GetPiWorkspacesWorkspacePiWorkspaceDetail[]
    (List) Workspace information.
    piWorkspaceId string
    (String) Workspace ID.
    piWorkspaceLocation {[key: string]: string}
    (Map) Workspace location.
    piWorkspaceName string
    (String) Workspace name.
    piWorkspaceStatus string
    (String) Workspace status, active, critical, failed, provisioning.
    piWorkspaceType string
    (String) Workspace type, off-premises or on-premises.
    pi_workspace_capabilities Mapping[str, bool]
    (Map) Workspace Capabilities. Capabilities are true or false.
    pi_workspace_details Sequence[GetPiWorkspacesWorkspacePiWorkspaceDetail]
    (List) Workspace information.
    pi_workspace_id str
    (String) Workspace ID.
    pi_workspace_location Mapping[str, str]
    (Map) Workspace location.
    pi_workspace_name str
    (String) Workspace name.
    pi_workspace_status str
    (String) Workspace status, active, critical, failed, provisioning.
    pi_workspace_type str
    (String) Workspace type, off-premises or on-premises.
    piWorkspaceCapabilities Map<Boolean>
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails List<Property Map>
    (List) Workspace information.
    piWorkspaceId String
    (String) Workspace ID.
    piWorkspaceLocation Map<String>
    (Map) Workspace location.
    piWorkspaceName String
    (String) Workspace name.
    piWorkspaceStatus String
    (String) Workspace status, active, critical, failed, provisioning.
    piWorkspaceType String
    (String) Workspace type, off-premises or on-premises.

    GetPiWorkspacesWorkspacePiWorkspaceDetail

    CreationDate string
    (String) Date of workspace creation.
    Crn string
    (String) Workspace crn.
    NetworkSecurityGroups List<GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup>
    (List) Network security groups configuration.
    PowerEdgeRouters List<GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter>
    (List) Power Edge Router information.
    CreationDate string
    (String) Date of workspace creation.
    Crn string
    (String) Workspace crn.
    NetworkSecurityGroups []GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup
    (List) Network security groups configuration.
    PowerEdgeRouters []GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter
    (List) Power Edge Router information.
    creationDate String
    (String) Date of workspace creation.
    crn String
    (String) Workspace crn.
    networkSecurityGroups List<GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup>
    (List) Network security groups configuration.
    powerEdgeRouters List<GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter>
    (List) Power Edge Router information.
    creationDate string
    (String) Date of workspace creation.
    crn string
    (String) Workspace crn.
    networkSecurityGroups GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup[]
    (List) Network security groups configuration.
    powerEdgeRouters GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter[]
    (List) Power Edge Router information.
    creation_date str
    (String) Date of workspace creation.
    crn str
    (String) Workspace crn.
    network_security_groups Sequence[GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup]
    (List) Network security groups configuration.
    power_edge_routers Sequence[GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter]
    (List) Power Edge Router information.
    creationDate String
    (String) Date of workspace creation.
    crn String
    (String) Workspace crn.
    networkSecurityGroups List<Property Map>
    (List) Network security groups configuration.
    powerEdgeRouters List<Property Map>
    (List) Power Edge Router information.

    GetPiWorkspacesWorkspacePiWorkspaceDetailNetworkSecurityGroup

    State string
    (String) The state of a network security groups configuration.
    State string
    (String) The state of a network security groups configuration.
    state String
    (String) The state of a network security groups configuration.
    state string
    (String) The state of a network security groups configuration.
    state str
    (String) The state of a network security groups configuration.
    state String
    (String) The state of a network security groups configuration.

    GetPiWorkspacesWorkspacePiWorkspaceDetailPowerEdgeRouter

    MigrationStatus string
    (String) The migration status of a Power Edge Router.
    State string
    (String) The state of a network security groups configuration.
    Type string
    (String) Workspace location region type.
    MigrationStatus string
    (String) The migration status of a Power Edge Router.
    State string
    (String) The state of a network security groups configuration.
    Type string
    (String) Workspace location region type.
    migrationStatus String
    (String) The migration status of a Power Edge Router.
    state String
    (String) The state of a network security groups configuration.
    type String
    (String) Workspace location region type.
    migrationStatus string
    (String) The migration status of a Power Edge Router.
    state string
    (String) The state of a network security groups configuration.
    type string
    (String) Workspace location region type.
    migration_status str
    (String) The migration status of a Power Edge Router.
    state str
    (String) The state of a network security groups configuration.
    type str
    (String) Workspace location region type.
    migrationStatus String
    (String) The migration status of a Power Edge Router.
    state String
    (String) The state of a network security groups configuration.
    type String
    (String) Workspace location region type.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.87.0-beta0 published on Friday, Dec 19, 2025 by ibm-cloud
      Meet Neo: Your AI Platform Teammate