Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getPiRoute
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getPiRoute

Explore with Pulumi AI

ibm logo
ibm 1.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Retrieve information about a route. For more information, see getting started with IBM Power Systems Virtual Servers.

    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 getPiRoute

    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 getPiRoute(args: GetPiRouteArgs, opts?: InvokeOptions): Promise<GetPiRouteResult>
function getPiRouteOutput(args: GetPiRouteOutputArgs, opts?: InvokeOptions): Output<GetPiRouteResult>
    def get_pi_route(id: Optional[str] = None,
                 pi_cloud_instance_id: Optional[str] = None,
                 pi_route_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPiRouteResult
def get_pi_route_output(id: Optional[pulumi.Input[str]] = None,
                 pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                 pi_route_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPiRouteResult]
    func LookupPiRoute(ctx *Context, args *LookupPiRouteArgs, opts ...InvokeOption) (*LookupPiRouteResult, error)
func LookupPiRouteOutput(ctx *Context, args *LookupPiRouteOutputArgs, opts ...InvokeOption) LookupPiRouteResultOutput

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

    public static class GetPiRoute 
{
    public static Task<GetPiRouteResult> InvokeAsync(GetPiRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetPiRouteResult> Invoke(GetPiRouteInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiRouteResult> getPiRoute(GetPiRouteArgs args, InvokeOptions options)
public static Output<GetPiRouteResult> getPiRoute(GetPiRouteArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiRouteId string
    ID of route.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiRouteId string
    ID of route.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piRouteId String
    ID of route.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piRouteId string
    ID of route.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_route_id str
    ID of route.
    id str
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piRouteId String
    ID of route.
    id String

    getPiRoute Result

    The following output properties are available:

    Action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    Crn string
    (String) The CRN of this resource.
    Destination string
    (String) The route destination.
    DestinationType string
    (String) The destination type.
    Enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    Id string
    Name string
    (String) Name of the route.
    NextHop string
    (String) The next hop in the route.
    NextHopType string
    (String) The next hop type.
    PiCloudInstanceId string
    PiRouteId string
    State string
    (String) The state of the route.
    UserTags List<string>
    (Set of String) List of user tags attached to the resource.
    Action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    Crn string
    (String) The CRN of this resource.
    Destination string
    (String) The route destination.
    DestinationType string
    (String) The destination type.
    Enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    Id string
    Name string
    (String) Name of the route.
    NextHop string
    (String) The next hop in the route.
    NextHopType string
    (String) The next hop type.
    PiCloudInstanceId string
    PiRouteId string
    State string
    (String) The state of the route.
    UserTags []string
    (Set of String) List of user tags attached to the resource.
    action String
    (String) The route action.
    String
    (String) Indicates if the route is advertised.
    crn String
    (String) The CRN of this resource.
    destination String
    (String) The route destination.
    destinationType String
    (String) The destination type.
    enabled Boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    id String
    name String
    (String) Name of the route.
    nextHop String
    (String) The next hop in the route.
    nextHopType String
    (String) The next hop type.
    piCloudInstanceId String
    piRouteId String
    state String
    (String) The state of the route.
    userTags List<String>
    (Set of String) List of user tags attached to the resource.
    action string
    (String) The route action.
    string
    (String) Indicates if the route is advertised.
    crn string
    (String) The CRN of this resource.
    destination string
    (String) The route destination.
    destinationType string
    (String) The destination type.
    enabled boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    id string
    name string
    (String) Name of the route.
    nextHop string
    (String) The next hop in the route.
    nextHopType string
    (String) The next hop type.
    piCloudInstanceId string
    piRouteId string
    state string
    (String) The state of the route.
    userTags string[]
    (Set of String) List of user tags attached to the resource.
    action str
    (String) The route action.
    str
    (String) Indicates if the route is advertised.
    crn str
    (String) The CRN of this resource.
    destination str
    (String) The route destination.
    destination_type str
    (String) The destination type.
    enabled bool
    (Boolean) Indicates if the route should be enabled in the fabric.
    id str
    name str
    (String) Name of the route.
    next_hop str
    (String) The next hop in the route.
    next_hop_type str
    (String) The next hop type.
    pi_cloud_instance_id str
    pi_route_id str
    state str
    (String) The state of the route.
    user_tags Sequence[str]
    (Set of String) List of user tags attached to the resource.
    action String
    (String) The route action.
    String
    (String) Indicates if the route is advertised.
    crn String
    (String) The CRN of this resource.
    destination String
    (String) The route destination.
    destinationType String
    (String) The destination type.
    enabled Boolean
    (Boolean) Indicates if the route should be enabled in the fabric.
    id String
    name String
    (String) Name of the route.
    nextHop String
    (String) The next hop in the route.
    nextHopType String
    (String) The next hop type.
    piCloudInstanceId String
    piRouteId String
    state String
    (String) The state of the route.
    userTags List<String>
    (Set of String) List of user tags attached to the resource.

    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.81.1 published on Wednesday, Aug 6, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm