Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiWorkspace
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiWorkspace

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about your Power Systems account workspace.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const workspace = ibm.getPiWorkspace({
    piCloudInstanceId: "99fba9c9-66f9-99bc-9999-aca999ee9d9b",
});

    import pulumi
import pulumi_ibm as ibm

workspace = ibm.get_pi_workspace(pi_cloud_instance_id="99fba9c9-66f9-99bc-9999-aca999ee9d9b")

    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.LookupPiWorkspace(ctx, &ibm.LookupPiWorkspaceArgs{
			PiCloudInstanceId: "99fba9c9-66f9-99bc-9999-aca999ee9d9b",
		}, 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 workspace = Ibm.GetPiWorkspace.Invoke(new()
    {
        PiCloudInstanceId = "99fba9c9-66f9-99bc-9999-aca999ee9d9b",
    });

});

    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.GetPiWorkspaceArgs;
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 workspace = IbmFunctions.getPiWorkspace(GetPiWorkspaceArgs.builder()
            .piCloudInstanceId("99fba9c9-66f9-99bc-9999-aca999ee9d9b")
            .build());

    }
}

    variables:
  workspace:
    fn::invoke:
      function: ibm:getPiWorkspace
      arguments:
        piCloudInstanceId: 99fba9c9-66f9-99bc-9999-aca999ee9d9b

    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 getPiWorkspace

    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 getPiWorkspace(args: GetPiWorkspaceArgs, opts?: InvokeOptions): Promise<GetPiWorkspaceResult>
function getPiWorkspaceOutput(args: GetPiWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetPiWorkspaceResult>
    def get_pi_workspace(id: Optional[str] = None,
                     pi_cloud_instance_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPiWorkspaceResult
def get_pi_workspace_output(id: Optional[pulumi.Input[str]] = None,
                     pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPiWorkspaceResult]
    func LookupPiWorkspace(ctx *Context, args *LookupPiWorkspaceArgs, opts ...InvokeOption) (*LookupPiWorkspaceResult, error)
func LookupPiWorkspaceOutput(ctx *Context, args *LookupPiWorkspaceOutputArgs, opts ...InvokeOption) LookupPiWorkspaceResultOutput

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

    public static class GetPiWorkspace 
{
    public static Task<GetPiWorkspaceResult> InvokeAsync(GetPiWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetPiWorkspaceResult> Invoke(GetPiWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiWorkspaceResult> getPiWorkspace(GetPiWorkspaceArgs args, InvokeOptions options)
public static Output<GetPiWorkspaceResult> getPiWorkspace(GetPiWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiWorkspace:getPiWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    Cloud Instance ID of a PCloud Instance under your account.
    Id string
    (String) Workspace ID.
    PiCloudInstanceId string
    Cloud Instance ID of a PCloud Instance under your account.
    Id string
    (String) Workspace ID.
    piCloudInstanceId String
    Cloud Instance ID of a PCloud Instance under your account.
    id String
    (String) Workspace ID.
    piCloudInstanceId string
    Cloud Instance ID of a PCloud Instance under your account.
    id string
    (String) Workspace ID.
    pi_cloud_instance_id str
    Cloud Instance ID of a PCloud Instance under your account.
    id str
    (String) Workspace ID.
    piCloudInstanceId String
    Cloud Instance ID of a PCloud Instance under your account.
    id String
    (String) Workspace ID.

    getPiWorkspace Result

    The following output properties are available:

    Id string
    (String) Workspace ID.
    PiCloudInstanceId string
    PiWorkspaceCapabilities Dictionary<string, bool>
    (Map) Workspace Capabilities. Capabilities are true or false.
    PiWorkspaceDetails List<GetPiWorkspacePiWorkspaceDetail>
    (List) Workspace information.
    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.
    Id string
    (String) Workspace ID.
    PiCloudInstanceId string
    PiWorkspaceCapabilities map[string]bool
    (Map) Workspace Capabilities. Capabilities are true or false.
    PiWorkspaceDetails []GetPiWorkspacePiWorkspaceDetail
    (List) Workspace information.
    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.
    id String
    (String) Workspace ID.
    piCloudInstanceId String
    piWorkspaceCapabilities Map<String,Boolean>
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails List<GetPiWorkspacePiWorkspaceDetail>
    (List) Workspace information.
    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.
    id string
    (String) Workspace ID.
    piCloudInstanceId string
    piWorkspaceCapabilities {[key: string]: boolean}
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails GetPiWorkspacePiWorkspaceDetail[]
    (List) Workspace information.
    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.
    id str
    (String) Workspace ID.
    pi_cloud_instance_id str
    pi_workspace_capabilities Mapping[str, bool]
    (Map) Workspace Capabilities. Capabilities are true or false.
    pi_workspace_details Sequence[GetPiWorkspacePiWorkspaceDetail]
    (List) Workspace information.
    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.
    id String
    (String) Workspace ID.
    piCloudInstanceId String
    piWorkspaceCapabilities Map<Boolean>
    (Map) Workspace Capabilities. Capabilities are true or false.
    piWorkspaceDetails List<Property Map>
    (List) Workspace information.
    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.

    Supporting Types

    GetPiWorkspacePiWorkspaceDetail

    CreationDate string
    (String) Date of workspace creation.
    Crn string
    (String) Workspace crn.
    NetworkSecurityGroups List<GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup>
    (List) Network security groups configuration.
    PowerEdgeRouters List<GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter>
    (List) Power Edge Router information.
    CreationDate string
    (String) Date of workspace creation.
    Crn string
    (String) Workspace crn.
    NetworkSecurityGroups []GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup
    (List) Network security groups configuration.
    PowerEdgeRouters []GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter
    (List) Power Edge Router information.
    creationDate String
    (String) Date of workspace creation.
    crn String
    (String) Workspace crn.
    networkSecurityGroups List<GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup>
    (List) Network security groups configuration.
    powerEdgeRouters List<GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter>
    (List) Power Edge Router information.
    creationDate string
    (String) Date of workspace creation.
    crn string
    (String) Workspace crn.
    networkSecurityGroups GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup[]
    (List) Network security groups configuration.
    powerEdgeRouters GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter[]
    (List) Power Edge Router information.
    creation_date str
    (String) Date of workspace creation.
    crn str
    (String) Workspace crn.
    network_security_groups Sequence[GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup]
    (List) Network security groups configuration.
    power_edge_routers Sequence[GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter]
    (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.

    GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup

    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.

    GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm