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

ibm.getPiTenant

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 the tenants that are configured for your Power Systems Virtual Server instance. For more information, about power virtual server tenants, see network security.

    Example Usage

    The following example retrieves all tenants for the Power Systems Virtual Server instance with the ID.

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

const dsTenant = ibm.getPiTenant({
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
});

    import pulumi
import pulumi_ibm as ibm

ds_tenant = ibm.get_pi_tenant(pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b")

    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.GetPiTenant(ctx, &ibm.GetPiTenantArgs{
			PiCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
		}, 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 dsTenant = Ibm.GetPiTenant.Invoke(new()
    {
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    });

});

    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.GetPiTenantArgs;
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 dsTenant = IbmFunctions.getPiTenant(GetPiTenantArgs.builder()
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .build());

    }
}

    variables:
  dsTenant:
    fn::invoke:
      function: ibm:getPiTenant
      arguments:
        piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b

    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 getPiTenant

    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 getPiTenant(args: GetPiTenantArgs, opts?: InvokeOptions): Promise<GetPiTenantResult>
function getPiTenantOutput(args: GetPiTenantOutputArgs, opts?: InvokeOptions): Output<GetPiTenantResult>
    def get_pi_tenant(id: Optional[str] = None,
                  pi_cloud_instance_id: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetPiTenantResult
def get_pi_tenant_output(id: Optional[pulumi.Input[str]] = None,
                  pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetPiTenantResult]
    func GetPiTenant(ctx *Context, args *GetPiTenantArgs, opts ...InvokeOption) (*GetPiTenantResult, error)
func GetPiTenantOutput(ctx *Context, args *GetPiTenantOutputArgs, opts ...InvokeOption) GetPiTenantResultOutput

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

    public static class GetPiTenant 
{
    public static Task<GetPiTenantResult> InvokeAsync(GetPiTenantArgs args, InvokeOptions? opts = null)
    public static Output<GetPiTenantResult> Invoke(GetPiTenantInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiTenantResult> getPiTenant(GetPiTenantArgs args, InvokeOptions options)
public static Output<GetPiTenantResult> getPiTenant(GetPiTenantArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The ID of the tenant.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The ID of the tenant.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The ID of the tenant.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The ID of the tenant.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The ID of the tenant.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The ID of the tenant.

    getPiTenant Result

    The following output properties are available:

    CloudInstances List<GetPiTenantCloudInstance>
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    CreationDate string
    (String) Date of tenant creation.
    Enabled bool
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    Id string
    (String) The ID of the tenant.
    PiCloudInstanceId string
    TenantName string
    (String) The name of the tenant.
    CloudInstances []GetPiTenantCloudInstance
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    CreationDate string
    (String) Date of tenant creation.
    Enabled bool
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    Id string
    (String) The ID of the tenant.
    PiCloudInstanceId string
    TenantName string
    (String) The name of the tenant.
    cloudInstances List<GetPiTenantCloudInstance>
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    creationDate String
    (String) Date of tenant creation.
    enabled Boolean
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    id String
    (String) The ID of the tenant.
    piCloudInstanceId String
    tenantName String
    (String) The name of the tenant.
    cloudInstances GetPiTenantCloudInstance[]
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    creationDate string
    (String) Date of tenant creation.
    enabled boolean
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    id string
    (String) The ID of the tenant.
    piCloudInstanceId string
    tenantName string
    (String) The name of the tenant.
    cloud_instances Sequence[GetPiTenantCloudInstance]
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    creation_date str
    (String) Date of tenant creation.
    enabled bool
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    id str
    (String) The ID of the tenant.
    pi_cloud_instance_id str
    tenant_name str
    (String) The name of the tenant.
    cloudInstances List<Property Map>
    (Set) Set of regions and Power Systems Virtual Server instance IDs that the tenant owns.
    creationDate String
    (String) Date of tenant creation.
    enabled Boolean
    (Boolean) Indicates if the tenant is enabled for the Power Systems Virtual Server instance ID.
    id String
    (String) The ID of the tenant.
    piCloudInstanceId String
    tenantName String
    (String) The name of the tenant.

    Supporting Types

    GetPiTenantCloudInstance

    CloudInstanceId string
    (String) The unique identifier of the cloud instance.
    Region string
    (String) The region of the cloud instance.
    CloudInstanceId string
    (String) The unique identifier of the cloud instance.
    Region string
    (String) The region of the cloud instance.
    cloudInstanceId String
    (String) The unique identifier of the cloud instance.
    region String
    (String) The region of the cloud instance.
    cloudInstanceId string
    (String) The unique identifier of the cloud instance.
    region string
    (String) The region of the cloud instance.
    cloud_instance_id str
    (String) The unique identifier of the cloud instance.
    region str
    (String) The region of the cloud instance.
    cloudInstanceId String
    (String) The unique identifier of the cloud instance.
    region String
    (String) The region of the cloud instance.

    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