gcore 0.20.0 published on Tuesday, Apr 22, 2025 by g-core
gcore.getSubnet
Explore with Pulumi AI
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 tsn = Promise.all([rg, pr]).then(([rg, pr]) => gcore.getSubnet({
    name: "subtest",
    regionId: rg.id,
    projectId: pr.id,
}));
export const view = tsn;
import pulumi
import pulumi_gcore as gcore
pr = gcore.get_project(name="test")
rg = gcore.get_region(name="ED-10 Preprod")
tsn = gcore.get_subnet(name="subtest",
    region_id=rg.id,
    project_id=pr.id)
pulumi.export("view", tsn)
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
		}
		tsn, err := gcore.LookupSubnet(ctx, &gcore.LookupSubnetArgs{
			Name:      "subtest",
			RegionId:  pulumi.Float64Ref(rg.Id),
			ProjectId: pulumi.Float64Ref(pr.Id),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("view", tsn)
		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 tsn = Gcore.GetSubnet.Invoke(new()
    {
        Name = "subtest",
        RegionId = rg.Apply(getRegionResult => getRegionResult.Id),
        ProjectId = pr.Apply(getProjectResult => getProjectResult.Id),
    });
    return new Dictionary<string, object?>
    {
        ["view"] = tsn,
    };
});
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.GetSubnetArgs;
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 tsn = GcoreFunctions.getSubnet(GetSubnetArgs.builder()
            .name("subtest")
            .regionId(rg.applyValue(getRegionResult -> getRegionResult.id()))
            .projectId(pr.applyValue(getProjectResult -> getProjectResult.id()))
            .build());
        ctx.export("view", tsn.applyValue(getSubnetResult -> getSubnetResult));
    }
}
variables:
  pr:
    fn::invoke:
      function: gcore:getProject
      arguments:
        name: test
  rg:
    fn::invoke:
      function: gcore:getRegion
      arguments:
        name: ED-10 Preprod
  tsn:
    fn::invoke:
      function: gcore:getSubnet
      arguments:
        name: subtest
        regionId: ${rg.id}
        projectId: ${pr.id}
outputs:
  view: ${tsn}
Using getSubnet
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 getSubnet(args: GetSubnetArgs, opts?: InvokeOptions): Promise<GetSubnetResult>
function getSubnetOutput(args: GetSubnetOutputArgs, opts?: InvokeOptions): Output<GetSubnetResult>def get_subnet(id: Optional[str] = None,
               metadata_k: Optional[str] = None,
               metadata_kv: Optional[Mapping[str, str]] = None,
               name: Optional[str] = None,
               network_id: 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) -> GetSubnetResult
def get_subnet_output(id: Optional[pulumi.Input[str]] = None,
               metadata_k: Optional[pulumi.Input[str]] = None,
               metadata_kv: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
               name: Optional[pulumi.Input[str]] = None,
               network_id: 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[GetSubnetResult]func LookupSubnet(ctx *Context, args *LookupSubnetArgs, opts ...InvokeOption) (*LookupSubnetResult, error)
func LookupSubnetOutput(ctx *Context, args *LookupSubnetOutputArgs, opts ...InvokeOption) LookupSubnetResultOutput> Note: This function is named LookupSubnet in the Go SDK.
public static class GetSubnet 
{
    public static Task<GetSubnetResult> InvokeAsync(GetSubnetArgs args, InvokeOptions? opts = null)
    public static Output<GetSubnetResult> Invoke(GetSubnetInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
public static Output<GetSubnetResult> getSubnet(GetSubnetArgs args, InvokeOptions options)
fn::invoke:
  function: gcore:index/getSubnet:getSubnet
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
 - Id string
 - The ID of this resource.
 - Metadata
K string - Metadata
Kv Dictionary<string, string> - Network
Id string - Project
Id double - Project
Name string - Region
Id double - Region
Name string 
- Name string
 - Id string
 - The ID of this resource.
 - Metadata
K string - Metadata
Kv map[string]string - Network
Id string - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string 
- name String
 - id String
 - The ID of this resource.
 - metadata
K String - metadata
Kv Map<String,String> - network
Id String - project
Id Double - project
Name String - region
Id Double - region
Name String 
- name string
 - id string
 - The ID of this resource.
 - metadata
K string - metadata
Kv {[key: string]: string} - network
Id string - project
Id number - project
Name string - region
Id number - region
Name string 
- name str
 - id str
 - The ID of this resource.
 - metadata_
k str - metadata_
kv Mapping[str, str] - network_
id str - project_
id float - project_
name str - region_
id float - region_
name str 
- name String
 - id String
 - The ID of this resource.
 - metadata
K String - metadata
Kv Map<String> - network
Id String - project
Id Number - project
Name String - region
Id Number - region
Name String 
getSubnet Result
The following output properties are available:
- Cidr string
 - Connect
To boolNetwork Router  - Dns
Nameservers List<string> - Enable
Dhcp bool - Gateway
Ip string - Host
Routes List<GetSubnet Host Route>  - Id string
 - The ID of this resource.
 - Metadata
Read List<GetOnlies Subnet Metadata Read Only>  - Name string
 - Network
Id string - Metadata
K string - Metadata
Kv Dictionary<string, string> - Project
Id double - Project
Name string - Region
Id double - Region
Name string 
- Cidr string
 - Connect
To boolNetwork Router  - Dns
Nameservers []string - Enable
Dhcp bool - Gateway
Ip string - Host
Routes []GetSubnet Host Route  - Id string
 - The ID of this resource.
 - Metadata
Read []GetOnlies Subnet Metadata Read Only  - Name string
 - Network
Id string - Metadata
K string - Metadata
Kv map[string]string - Project
Id float64 - Project
Name string - Region
Id float64 - Region
Name string 
- cidr String
 - connect
To BooleanNetwork Router  - dns
Nameservers List<String> - enable
Dhcp Boolean - gateway
Ip String - host
Routes List<GetSubnet Host Route>  - id String
 - The ID of this resource.
 - metadata
Read List<GetOnlies Subnet Metadata Read Only>  - name String
 - network
Id String - metadata
K String - metadata
Kv Map<String,String> - project
Id Double - project
Name String - region
Id Double - region
Name String 
- cidr string
 - connect
To booleanNetwork Router  - dns
Nameservers string[] - enable
Dhcp boolean - gateway
Ip string - host
Routes GetSubnet Host Route[]  - id string
 - The ID of this resource.
 - metadata
Read GetOnlies Subnet Metadata Read Only[]  - name string
 - network
Id string - metadata
K string - metadata
Kv {[key: string]: string} - project
Id number - project
Name string - region
Id number - region
Name string 
- cidr str
 - connect_
to_ boolnetwork_ router  - dns_
nameservers Sequence[str] - enable_
dhcp bool - gateway_
ip str - host_
routes Sequence[GetSubnet Host Route]  - id str
 - The ID of this resource.
 - metadata_
read_ Sequence[Getonlies Subnet Metadata Read Only]  - name str
 - network_
id str - metadata_
k str - metadata_
kv Mapping[str, str] - project_
id float - project_
name str - region_
id float - region_
name str 
- cidr String
 - connect
To BooleanNetwork Router  - dns
Nameservers List<String> - enable
Dhcp Boolean - gateway
Ip String - host
Routes List<Property Map> - id String
 - The ID of this resource.
 - metadata
Read List<Property Map>Onlies  - name String
 - network
Id String - metadata
K String - metadata
Kv Map<String> - project
Id Number - project
Name String - region
Id Number - region
Name String 
Supporting Types
GetSubnetHostRoute   
- Destination string
 - Nexthop string
 
- Destination string
 - Nexthop string
 
- destination String
 - nexthop String
 
- destination string
 - nexthop string
 
- destination str
 - nexthop str
 
- destination String
 - nexthop String
 
GetSubnetMetadataReadOnly    
Package Details
- Repository
 - gcore g-core/terraform-provider-gcore
 - License
 - Notes
 - This Pulumi package is based on the 
gcoreTerraform Provider.