getCloudNetworks

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 exampleCloudNetworks = gcore.getCloudNetworks({
    projectId: 1,
    regionId: 1,
    name: "my-network",
    tagKeys: [
        "key1",
        "key2",
    ],
    tagKeyValue: "tag_key_value",
});

import pulumi
import pulumi_gcore as gcore

example_cloud_networks = gcore.get_cloud_networks(project_id=1,
    region_id=1,
    name="my-network",
    tag_keys=[
        "key1",
        "key2",
    ],
    tag_key_value="tag_key_value")

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.GetCloudNetworks(ctx, &gcore.GetCloudNetworksArgs{
			ProjectId: pulumi.Float64Ref(1),
			RegionId:  pulumi.Float64Ref(1),
			Name:      pulumi.StringRef("my-network"),
			TagKeys: []string{
				"key1",
				"key2",
			},
			TagKeyValue: pulumi.StringRef("tag_key_value"),
		}, 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 exampleCloudNetworks = Gcore.GetCloudNetworks.Invoke(new()
    {
        ProjectId = 1,
        RegionId = 1,
        Name = "my-network",
        TagKeys = new[]
        {
            "key1",
            "key2",
        },
        TagKeyValue = "tag_key_value",
    });

});

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.GetCloudNetworksArgs;
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 exampleCloudNetworks = GcoreFunctions.getCloudNetworks(GetCloudNetworksArgs.builder()
            .projectId(1)
            .regionId(1)
            .name("my-network")
            .tagKeys(            
                "key1",
                "key2")
            .tagKeyValue("tag_key_value")
            .build());

    }
}

variables:
  exampleCloudNetworks:
    fn::invoke:
      function: gcore:getCloudNetworks
      arguments:
        projectId: 1
        regionId: 1
        name: my-network
        tagKeys:
          - key1
          - key2
        tagKeyValue: tag_key_value

Using getCloudNetworks

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 getCloudNetworks(args: GetCloudNetworksArgs, opts?: InvokeOptions): Promise<GetCloudNetworksResult>
function getCloudNetworksOutput(args: GetCloudNetworksOutputArgs, opts?: InvokeOptions): Output<GetCloudNetworksResult>

def get_cloud_networks(external: Optional[bool] = None,
                       max_items: Optional[float] = None,
                       name: Optional[str] = None,
                       network_type: Optional[str] = None,
                       order_by: Optional[str] = None,
                       owned_by: Optional[str] = None,
                       project_id: Optional[float] = None,
                       region_id: Optional[float] = None,
                       tag_key_value: Optional[str] = None,
                       tag_keys: Optional[Sequence[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetCloudNetworksResult
def get_cloud_networks_output(external: Optional[pulumi.Input[bool]] = None,
                       max_items: Optional[pulumi.Input[float]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       network_type: Optional[pulumi.Input[str]] = None,
                       order_by: Optional[pulumi.Input[str]] = None,
                       owned_by: Optional[pulumi.Input[str]] = None,
                       project_id: Optional[pulumi.Input[float]] = None,
                       region_id: Optional[pulumi.Input[float]] = None,
                       tag_key_value: Optional[pulumi.Input[str]] = None,
                       tag_keys: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetCloudNetworksResult]

func GetCloudNetworks(ctx *Context, args *GetCloudNetworksArgs, opts ...InvokeOption) (*GetCloudNetworksResult, error)
func GetCloudNetworksOutput(ctx *Context, args *GetCloudNetworksOutputArgs, opts ...InvokeOption) GetCloudNetworksResultOutput

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

public static class GetCloudNetworks 
{
    public static Task<GetCloudNetworksResult> InvokeAsync(GetCloudNetworksArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudNetworksResult> Invoke(GetCloudNetworksInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCloudNetworksResult> getCloudNetworks(GetCloudNetworksArgs args, InvokeOptions options)
public static Output<GetCloudNetworksResult> getCloudNetworks(GetCloudNetworksArgs args, InvokeOptions options)

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

The following arguments are supported:

External bool: Filter by external network status
MaxItems double: Max items to fetch, default: 1000
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
ProjectId double: Project ID
RegionId double: Region ID
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys List<string>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

External bool: Filter by external network status
MaxItems float64: Max items to fetch, default: 1000
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
ProjectId float64: Project ID
RegionId float64: Region ID
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys []string: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

external Boolean: Filter by external network status
maxItems Double: Max items to fetch, default: 1000
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
projectId Double: Project ID
regionId Double: Region ID
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

external boolean: Filter by external network status
maxItems number: Max items to fetch, default: 1000
name string: Filter networks by name
networkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
projectId number: Project ID
regionId number: Region ID
tagKeyValue string: Optional. Filter by tag key-value pairs.
tagKeys string[]: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

external bool: Filter by external network status
max_items float: Max items to fetch, default: 1000
name str: Filter networks by name
network_type str: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
project_id float: Project ID
region_id float: Region ID
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

external Boolean: Filter by external network status
maxItems Number: Max items to fetch, default: 1000
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
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".
projectId Number: Project ID
regionId Number: Region ID
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

getCloudNetworks Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Items List<GetCloudNetworksItem>: The items returned by the data source
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
MaxItems double: Max items to fetch, default: 1000
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
ProjectId double: Project ID
RegionId double: Region ID
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys List<string>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Id string: The provider-assigned unique ID for this managed resource.
Items []GetCloudNetworksItem: The items returned by the data source
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
MaxItems float64: Max items to fetch, default: 1000
Name string: Filter networks by name
NetworkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
ProjectId float64: Project ID
RegionId float64: Region ID
TagKeyValue string: Optional. Filter by tag key-value pairs.
TagKeys []string: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

id String: The provider-assigned unique ID for this managed resource.
items List<GetCloudNetworksItem>: The items returned by the data source
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
maxItems Double: Max items to fetch, default: 1000
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
projectId Double: Project ID
regionId Double: Region ID
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

id string: The provider-assigned unique ID for this managed resource.
items GetCloudNetworksItem[]: The items returned by the data source
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
maxItems number: Max items to fetch, default: 1000
name string: Filter networks by name
networkType string: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
projectId number: Project ID
regionId number: Region ID
tagKeyValue string: Optional. Filter by tag key-value pairs.
tagKeys string[]: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

id str: The provider-assigned unique ID for this managed resource.
items Sequence[GetCloudNetworksItem]: The items returned by the data source
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
max_items float: Max items to fetch, default: 1000
name str: Filter networks by name
network_type str: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
project_id float: Project ID
region_id float: Region ID
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

id String: The provider-assigned unique ID for this managed resource.
items List<Property Map>: The items returned by the data source
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
maxItems Number: Max items to fetch, default: 1000
name String: Filter networks by name
networkType String: Filter by network type (vlan or vxlan) Available values: "vlan", "vxlan".
projectId Number: Project ID
regionId Number: Region ID
tagKeyValue String: Optional. Filter by tag key-value pairs.
tagKeys List<String>: Optional. Filter by tag keys. ?tag_key=key1&tag_key=key2

Supporting Types

GetCloudNetworksItem

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.
ProjectId double: Project ID
Region string: Region name
RegionId double: Region ID
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<GetCloudNetworksItemTag>: 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

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.
ProjectId float64: Project ID
Region string: Region name
RegionId float64: Region ID
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 []GetCloudNetworksItemTag: 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

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.
projectId Double: Project ID
region String: Region name
regionId Double: Region ID
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<GetCloudNetworksItemTag>: 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

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.
projectId number: Project ID
region string: Region name
regionId number: Region ID
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 GetCloudNetworksItemTag[]: 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

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.
project_id float: Project ID
region str: Region name
region_id float: Region ID
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[GetCloudNetworksItemTag]: 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

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.
projectId Number: Project ID
region String: Region name
regionId Number: Region ID
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

GetCloudNetworksItemTag

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.