getCloudNetwork

gcore 2.0.0-alpha.3, Mar 30 26

Viewing docs for gcore 2.0.0-alpha.3
published on Monday, Mar 30, 2026 by g-core

Example Usage

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

const exampleCloudNetwork = gcore.getCloudNetwork({
    projectId: 1,
    regionId: 1,
    networkId: "b39792c3-3160-4356-912e-ba396c95cdcf",
});

import pulumi
import pulumi_gcore as gcore

example_cloud_network = gcore.get_cloud_network(project_id=1,
    region_id=1,
    network_id="b39792c3-3160-4356-912e-ba396c95cdcf")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gcore.LookupCloudNetwork(ctx, &gcore.LookupCloudNetworkArgs{
			ProjectId: pulumi.Float64Ref(1),
			RegionId:  pulumi.Float64Ref(1),
			NetworkId: pulumi.StringRef("b39792c3-3160-4356-912e-ba396c95cdcf"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcore = Pulumi.Gcore;

return await Deployment.RunAsync(() => 
{
    var exampleCloudNetwork = Gcore.GetCloudNetwork.Invoke(new()
    {
        ProjectId = 1,
        RegionId = 1,
        NetworkId = "b39792c3-3160-4356-912e-ba396c95cdcf",
    });

});

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.GetCloudNetworkArgs;
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 exampleCloudNetwork = GcoreFunctions.getCloudNetwork(GetCloudNetworkArgs.builder()
            .projectId(1)
            .regionId(1)
            .networkId("b39792c3-3160-4356-912e-ba396c95cdcf")
            .build());

    }
}

variables:
  exampleCloudNetwork:
    fn::invoke:
      function: gcore:getCloudNetwork
      arguments:
        projectId: 1
        regionId: 1
        networkId: b39792c3-3160-4356-912e-ba396c95cdcf

Using getCloudNetwork

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 getCloudNetwork(args: GetCloudNetworkArgs, opts?: InvokeOptions): Promise<GetCloudNetworkResult>
function getCloudNetworkOutput(args: GetCloudNetworkOutputArgs, opts?: InvokeOptions): Output<GetCloudNetworkResult>

def get_cloud_network(find_one_by: Optional[GetCloudNetworkFindOneBy] = None,
                      network_id: Optional[str] = None,
                      project_id: Optional[float] = None,
                      region_id: Optional[float] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCloudNetworkResult
def get_cloud_network_output(find_one_by: Optional[pulumi.Input[GetCloudNetworkFindOneByArgs]] = None,
                      network_id: Optional[pulumi.Input[str]] = None,
                      project_id: Optional[pulumi.Input[float]] = None,
                      region_id: Optional[pulumi.Input[float]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCloudNetworkResult]

func LookupCloudNetwork(ctx *Context, args *LookupCloudNetworkArgs, opts ...InvokeOption) (*LookupCloudNetworkResult, error)
func LookupCloudNetworkOutput(ctx *Context, args *LookupCloudNetworkOutputArgs, opts ...InvokeOption) LookupCloudNetworkResultOutput

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

public static class GetCloudNetwork 
{
    public static Task<GetCloudNetworkResult> InvokeAsync(GetCloudNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudNetworkResult> Invoke(GetCloudNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudNetworkResult> getCloudNetwork(GetCloudNetworkArgs args, InvokeOptions options)
public static Output<GetCloudNetworkResult> getCloudNetwork(GetCloudNetworkArgs args, InvokeOptions options)

fn::invoke:
  function: gcore:index/getCloudNetwork:getCloudNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

FindOneBy GetCloudNetworkFindOneBy
NetworkId string: Network ID
ProjectId double: Project ID
RegionId double: Region ID

FindOneBy GetCloudNetworkFindOneBy
NetworkId string: Network ID
ProjectId float64: Project ID
RegionId float64: Region ID

findOneBy GetCloudNetworkFindOneBy
networkId String: Network ID
projectId Double: Project ID
regionId Double: Region ID

findOneBy GetCloudNetworkFindOneBy
networkId string: Network ID
projectId number: Project ID
regionId number: Region ID

find_one_by GetCloudNetworkFindOneBy
network_id str: Network ID
project_id float: Project ID
region_id float: Region ID

findOneBy Property Map
networkId String: Network ID
projectId Number: Project ID
regionId Number: Region ID

getCloudNetwork Result

The following output properties are available:

CreatedAt string: Datetime when the network was created
CreatorTaskId string: Task that created this entity
Default bool: True if network has is_default attribute
External bool: True if the network router:external attribute
Id string: Network ID
Mtu double: MTU (maximum transmission unit). Default value is 1450
Name string: Network name
PortSecurityEnabled bool: Indicates port_security_enabled status of all newly created in the network ports.
Region string: Region name
SegmentationId double: Id of network segment
Shared bool: True when the network is shared with your project by external owner
Subnets List<string>: List of subnetworks
Tags List<GetCloudNetworkTag>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
Type string: Network type (vlan, vxlan)
UpdatedAt string: Datetime when the network was last updated
FindOneBy GetCloudNetworkFindOneBy
NetworkId string: Network ID
ProjectId double: Project ID
RegionId double: Region ID

CreatedAt string: Datetime when the network was created
CreatorTaskId string: Task that created this entity
Default bool: True if network has is_default attribute
External bool: True if the network router:external attribute
Id string: Network ID
Mtu float64: MTU (maximum transmission unit). Default value is 1450
Name string: Network name
PortSecurityEnabled bool: Indicates port_security_enabled status of all newly created in the network ports.
Region string: Region name
SegmentationId float64: Id of network segment
Shared bool: True when the network is shared with your project by external owner
Subnets []string: List of subnetworks
Tags []GetCloudNetworkTag: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
Type string: Network type (vlan, vxlan)
UpdatedAt string: Datetime when the network was last updated
FindOneBy GetCloudNetworkFindOneBy
NetworkId string: Network ID
ProjectId float64: Project ID
RegionId float64: Region ID

createdAt String: Datetime when the network was created
creatorTaskId String: Task that created this entity
default_ Boolean: True if network has is_default attribute
external Boolean: True if the network router:external attribute
id String: Network ID
mtu Double: MTU (maximum transmission unit). Default value is 1450
name String: Network name
portSecurityEnabled Boolean: Indicates port_security_enabled status of all newly created in the network ports.
region String: Region name
segmentationId Double: Id of network segment
shared Boolean: True when the network is shared with your project by external owner
subnets List<String>: List of subnetworks
tags List<GetCloudNetworkTag>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
type String: Network type (vlan, vxlan)
updatedAt String: Datetime when the network was last updated
findOneBy GetCloudNetworkFindOneBy
networkId String: Network ID
projectId Double: Project ID
regionId Double: Region ID

createdAt string: Datetime when the network was created
creatorTaskId string: Task that created this entity
default boolean: True if network has is_default attribute
external boolean: True if the network router:external attribute
id string: Network ID
mtu number: MTU (maximum transmission unit). Default value is 1450
name string: Network name
portSecurityEnabled boolean: Indicates port_security_enabled status of all newly created in the network ports.
region string: Region name
segmentationId number: Id of network segment
shared boolean: True when the network is shared with your project by external owner
subnets string[]: List of subnetworks
tags GetCloudNetworkTag[]: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
type string: Network type (vlan, vxlan)
updatedAt string: Datetime when the network was last updated
findOneBy GetCloudNetworkFindOneBy
networkId string: Network ID
projectId number: Project ID
regionId number: Region ID

created_at str: Datetime when the network was created
creator_task_id str: Task that created this entity
default bool: True if network has is_default attribute
external bool: True if the network router:external attribute
id str: Network ID
mtu float: MTU (maximum transmission unit). Default value is 1450
name str: Network name
port_security_enabled bool: Indicates port_security_enabled status of all newly created in the network ports.
region str: Region name
segmentation_id float: Id of network segment
shared bool: True when the network is shared with your project by external owner
subnets Sequence[str]: List of subnetworks
tags Sequence[GetCloudNetworkTag]: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
type str: Network type (vlan, vxlan)
updated_at str: Datetime when the network was last updated
find_one_by GetCloudNetworkFindOneBy
network_id str: Network ID
project_id float: Project ID
region_id float: Region ID

createdAt String: Datetime when the network was created
creatorTaskId String: Task that created this entity
default Boolean: True if network has is_default attribute
external Boolean: True if the network router:external attribute
id String: Network ID
mtu Number: MTU (maximum transmission unit). Default value is 1450
name String: Network name
portSecurityEnabled Boolean: Indicates port_security_enabled status of all newly created in the network ports.
region String: Region name
segmentationId Number: Id of network segment
shared Boolean: True when the network is shared with your project by external owner
subnets List<String>: List of subnetworks
tags List<Property Map>: List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
type String: Network type (vlan, vxlan)
updatedAt String: Datetime when the network was last updated
findOneBy Property Map
networkId String: Network ID
projectId Number: Project ID
regionId Number: Region ID

Supporting Types

GetCloudNetworkFindOneBy

OrderBy string: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
OwnedBy string: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
External bool: Filter by external network status
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys List<string>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

OrderBy string: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
OwnedBy string: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
External bool: Filter by external network status
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys []string: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

orderBy String: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
ownedBy String: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
external Boolean: Filter by external network status
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

orderBy string: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
ownedBy string: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
external boolean: Filter by external network status
name string: Filter networks by name
networkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
tagKeyValue string: Optional. Filter by tag key-value pairs.
tagKeys string[]: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

order_by str: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
owned_by str: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
external bool: Filter by external network status
name str: Filter networks by name
network_type str: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
tag_key_value str: Optional. Filter by tag key-value pairs.
tag_keys Sequence[str]: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

orderBy String: Ordering networks list result by name, created_at or priority fields and directions (e.g. created_at.desc). Default is created_at.desc. Use priority.desc to sort by shared network priority (relevant when owned_by=any). Available values: "createdat.asc", "createdat.desc", "name.asc", "name.desc", "priority.desc".
ownedBy String: Controls which networks are returned. 'project' (default) returns only networks owned by the project. 'any' returns all networks that the project can use, including shared networks from other projects. Available values: "any", "project".
external Boolean: Filter by external network status
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

GetCloudNetworkTag

Key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
ReadOnly bool: If true, the tag is read-only and cannot be modified by the user
Value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

Key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
ReadOnly bool: If true, the tag is read-only and cannot be modified by the user
Value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key String: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly Boolean: If true, the tag is read-only and cannot be modified by the user
value String: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key string: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly boolean: If true, the tag is read-only and cannot be modified by the user
value string: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key str: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
read_only bool: If true, the tag is read-only and cannot be modified by the user
value str: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

key String: Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
readOnly Boolean: If true, the tag is read-only and cannot be modified by the user
value String: Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.