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

ibm.getPiWorkspace

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 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",
});
Copy
import pulumi
import pulumi_ibm as ibm

workspace = ibm.get_pi_workspace(pi_cloud_instance_id="99fba9c9-66f9-99bc-9999-aca999ee9d9b")
Copy
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
	})
}
Copy
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",
    });

});
Copy
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());

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

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";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
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) {
    }
}
Copy
{}
Copy

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>
Copy
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]
Copy
func LookupPiWorkspace(ctx *Context, args *LookupPiWorkspaceArgs, opts ...InvokeOption) (*LookupPiWorkspaceResult, error)
func LookupPiWorkspaceOutput(ctx *Context, args *LookupPiWorkspaceOutputArgs, opts ...InvokeOption) LookupPiWorkspaceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPiWorkspaceResult> getPiWorkspace(GetPiWorkspaceArgs args, InvokeOptions options)
public static Output<GetPiWorkspaceResult> getPiWorkspace(GetPiWorkspaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getPiWorkspace:getPiWorkspace
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PiCloudInstanceId This property is required. string
Cloud Instance ID of a PCloud Instance under your account.
Id string
(String) Workspace ID.
PiCloudInstanceId This property is required. string
Cloud Instance ID of a PCloud Instance under your account.
Id string
(String) Workspace ID.
piCloudInstanceId This property is required. String
Cloud Instance ID of a PCloud Instance under your account.
id String
(String) Workspace ID.
piCloudInstanceId This property is required. string
Cloud Instance ID of a PCloud Instance under your account.
id string
(String) Workspace ID.
pi_cloud_instance_id This property is required. str
Cloud Instance ID of a PCloud Instance under your account.
id str
(String) Workspace ID.
piCloudInstanceId This property is required. 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 This property is required. string
(String) Date of workspace creation.
Crn This property is required. string
(String) Workspace crn.
NetworkSecurityGroups This property is required. List<GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup>
(List) Network security groups configuration.
PowerEdgeRouters This property is required. List<GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter>
(List) Power Edge Router information.
CreationDate This property is required. string
(String) Date of workspace creation.
Crn This property is required. string
(String) Workspace crn.
NetworkSecurityGroups This property is required. []GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup
(List) Network security groups configuration.
PowerEdgeRouters This property is required. []GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter
(List) Power Edge Router information.
creationDate This property is required. String
(String) Date of workspace creation.
crn This property is required. String
(String) Workspace crn.
networkSecurityGroups This property is required. List<GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup>
(List) Network security groups configuration.
powerEdgeRouters This property is required. List<GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter>
(List) Power Edge Router information.
creationDate This property is required. string
(String) Date of workspace creation.
crn This property is required. string
(String) Workspace crn.
networkSecurityGroups This property is required. GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup[]
(List) Network security groups configuration.
powerEdgeRouters This property is required. GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter[]
(List) Power Edge Router information.
creation_date This property is required. str
(String) Date of workspace creation.
crn This property is required. str
(String) Workspace crn.
network_security_groups This property is required. Sequence[GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup]
(List) Network security groups configuration.
power_edge_routers This property is required. Sequence[GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter]
(List) Power Edge Router information.
creationDate This property is required. String
(String) Date of workspace creation.
crn This property is required. String
(String) Workspace crn.
networkSecurityGroups This property is required. List<Property Map>
(List) Network security groups configuration.
powerEdgeRouters This property is required. List<Property Map>
(List) Power Edge Router information.

GetPiWorkspacePiWorkspaceDetailNetworkSecurityGroup

State This property is required. string
(String) The state of a network security groups configuration.
State This property is required. string
(String) The state of a network security groups configuration.
state This property is required. String
(String) The state of a network security groups configuration.
state This property is required. string
(String) The state of a network security groups configuration.
state This property is required. str
(String) The state of a network security groups configuration.
state This property is required. String
(String) The state of a network security groups configuration.

GetPiWorkspacePiWorkspaceDetailPowerEdgeRouter

MigrationStatus This property is required. string
(String) The migration status of a Power Edge Router.
State This property is required. string
(String) The state of a network security groups configuration.
Type This property is required. string
(String) Workspace location region type.
MigrationStatus This property is required. string
(String) The migration status of a Power Edge Router.
State This property is required. string
(String) The state of a network security groups configuration.
Type This property is required. string
(String) Workspace location region type.
migrationStatus This property is required. String
(String) The migration status of a Power Edge Router.
state This property is required. String
(String) The state of a network security groups configuration.
type This property is required. String
(String) Workspace location region type.
migrationStatus This property is required. string
(String) The migration status of a Power Edge Router.
state This property is required. string
(String) The state of a network security groups configuration.
type This property is required. string
(String) Workspace location region type.
migration_status This property is required. str
(String) The migration status of a Power Edge Router.
state This property is required. str
(String) The state of a network security groups configuration.
type This property is required. str
(String) Workspace location region type.
migrationStatus This property is required. String
(String) The migration status of a Power Edge Router.
state This property is required. String
(String) The state of a network security groups configuration.
type This property is required. 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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm