1. Packages
  2. Gcore Provider
  3. API Docs
  4. getRouter
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

gcore.getRouter

Explore with Pulumi AI

gcore logo
gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const pr = gcore.getProject({
        name: "test",
    });
    const rg = gcore.getRegion({
        name: "ED-10 Preprod",
    });
    const tr = Promise.all([rg, pr]).then(([rg, pr]) => gcore.getRouter({
        name: "test_router",
        regionId: rg.id,
        projectId: pr.id,
    }));
    export const view = tr;
    
    import pulumi
    import pulumi_gcore as gcore
    
    pr = gcore.get_project(name="test")
    rg = gcore.get_region(name="ED-10 Preprod")
    tr = gcore.get_router(name="test_router",
        region_id=rg.id,
        project_id=pr.id)
    pulumi.export("view", tr)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		pr, err := gcore.GetProject(ctx, &gcore.GetProjectArgs{
    			Name: "test",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		rg, err := gcore.GetRegion(ctx, &gcore.GetRegionArgs{
    			Name: "ED-10 Preprod",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		tr, err := gcore.LookupRouter(ctx, &gcore.LookupRouterArgs{
    			Name:      "test_router",
    			RegionId:  pulumi.Float64Ref(rg.Id),
    			ProjectId: pulumi.Float64Ref(pr.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("view", tr)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var pr = Gcore.GetProject.Invoke(new()
        {
            Name = "test",
        });
    
        var rg = Gcore.GetRegion.Invoke(new()
        {
            Name = "ED-10 Preprod",
        });
    
        var tr = Gcore.GetRouter.Invoke(new()
        {
            Name = "test_router",
            RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
            ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
        });
    
        return new Dictionary<string, object?>
        {
            ["view"] = tr,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetProjectArgs;
    import com.pulumi.gcore.inputs.GetRegionArgs;
    import com.pulumi.gcore.inputs.GetRouterArgs;
    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 pr = GcoreFunctions.getProject(GetProjectArgs.builder()
                .name("test")
                .build());
    
            final var rg = GcoreFunctions.getRegion(GetRegionArgs.builder()
                .name("ED-10 Preprod")
                .build());
    
            final var tr = GcoreFunctions.getRouter(GetRouterArgs.builder()
                .name("test_router")
                .regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
                .projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
                .build());
    
            ctx.export("view", tr.applyValue(getRouterResult -> getRouterResult));
        }
    }
    
    variables:
      pr:
        fn::invoke:
          function: gcore:getProject
          arguments:
            name: test
      rg:
        fn::invoke:
          function: gcore:getRegion
          arguments:
            name: ED-10 Preprod
      tr:
        fn::invoke:
          function: gcore:getRouter
          arguments:
            name: test_router
            regionId: ${rg.id}
            projectId: ${pr.id}
    outputs:
      view: ${tr}
    

    Using getRouter

    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 getRouter(args: GetRouterArgs, opts?: InvokeOptions): Promise<GetRouterResult>
    function getRouterOutput(args: GetRouterOutputArgs, opts?: InvokeOptions): Output<GetRouterResult>
    def get_router(id: Optional[str] = None,
                   name: Optional[str] = None,
                   project_id: Optional[float] = None,
                   project_name: Optional[str] = None,
                   region_id: Optional[float] = None,
                   region_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetRouterResult
    def get_router_output(id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   project_id: Optional[pulumi.Input[float]] = None,
                   project_name: Optional[pulumi.Input[str]] = None,
                   region_id: Optional[pulumi.Input[float]] = None,
                   region_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetRouterResult]
    func LookupRouter(ctx *Context, args *LookupRouterArgs, opts ...InvokeOption) (*LookupRouterResult, error)
    func LookupRouterOutput(ctx *Context, args *LookupRouterOutputArgs, opts ...InvokeOption) LookupRouterResultOutput

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

    public static class GetRouter 
    {
        public static Task<GetRouterResult> InvokeAsync(GetRouterArgs args, InvokeOptions? opts = null)
        public static Output<GetRouterResult> Invoke(GetRouterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRouterResult> getRouter(GetRouterArgs args, InvokeOptions options)
    public static Output<GetRouterResult> getRouter(GetRouterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getRouter:getRouter
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Id string
    The ID of this resource.
    ProjectId double
    ProjectName string
    RegionId double
    RegionName string
    Name string
    Id string
    The ID of this resource.
    ProjectId float64
    ProjectName string
    RegionId float64
    RegionName string
    name String
    id String
    The ID of this resource.
    projectId Double
    projectName String
    regionId Double
    regionName String
    name string
    id string
    The ID of this resource.
    projectId number
    projectName string
    regionId number
    regionName string
    name str
    id str
    The ID of this resource.
    project_id float
    project_name str
    region_id float
    region_name str
    name String
    id String
    The ID of this resource.
    projectId Number
    projectName String
    regionId Number
    regionName String

    getRouter Result

    The following output properties are available:

    Supporting Types

    GetRouterExternalGatewayInfo

    GetRouterExternalGatewayInfoExternalFixedIp

    IpAddress string
    SubnetId string
    IpAddress string
    SubnetId string
    ipAddress String
    subnetId String
    ipAddress string
    subnetId string
    ipAddress String
    subnetId String

    GetRouterInterface

    IpAddress string
    MacAddress string
    NetworkId string
    PortId string
    SubnetId string
    Type string
    IpAddress string
    MacAddress string
    NetworkId string
    PortId string
    SubnetId string
    Type string
    ipAddress String
    macAddress String
    networkId String
    portId String
    subnetId String
    type String
    ipAddress string
    macAddress string
    networkId string
    portId string
    subnetId string
    type string
    ipAddress String
    macAddress String
    networkId String
    portId String
    subnetId String
    type String

    GetRouterRoute

    Destination string
    Nexthop string
    Destination string
    Nexthop string
    destination String
    nexthop String
    destination string
    nexthop string
    destination String
    nexthop String

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    gcore 0.22.0 published on Wednesday, Apr 30, 2025 by g-core