1. Packages
  2. Vra Provider
  3. API Docs
  4. getNetwork
Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-vra

vra.getNetwork

vra logo
Viewing docs for vra 0.17.0
published on Tuesday, Mar 10, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-vra

    Example Usage

    S

    This is an example of how to read a network data source.

    Network data source by id:

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

const test_network = vra.getNetwork({
    id: networkId,
});

    import pulumi
import pulumi_vra as vra

test_network = vra.get_network(id=network_id)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.LookupNetwork(ctx, &vra.LookupNetworkArgs{
			Id: pulumi.StringRef(networkId),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test_network = Vra.GetNetwork.Invoke(new()
    {
        Id = networkId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetNetworkArgs;
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 test-network = VraFunctions.getNetwork(GetNetworkArgs.builder()
            .id(networkId)
            .build());

    }
}

    variables:
  test-network:
    fn::invoke:
      function: vra:getNetwork
      arguments:
        id: ${networkId}

    Network data source by name:

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

const test_network = vra.getNetwork({
    name: networkName,
});

    import pulumi
import pulumi_vra as vra

test_network = vra.get_network(name=network_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.LookupNetwork(ctx, &vra.LookupNetworkArgs{
			Name: pulumi.StringRef(networkName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test_network = Vra.GetNetwork.Invoke(new()
    {
        Name = networkName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetNetworkArgs;
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 test-network = VraFunctions.getNetwork(GetNetworkArgs.builder()
            .name(networkName)
            .build());

    }
}

    variables:
  test-network:
    fn::invoke:
      function: vra:getNetwork
      arguments:
        name: ${networkName}

    Network data source by filter:

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

const test_network = vra.getNetwork({
    filter: `name eq '${networkName}'`,
});

    import pulumi
import pulumi_vra as vra

test_network = vra.get_network(filter=f"name eq '{network_name}'")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vra/vra"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vra.LookupNetwork(ctx, &vra.LookupNetworkArgs{
			Filter: pulumi.StringRef(fmt.Sprintf("name eq '%v'", networkName)),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test_network = Vra.GetNetwork.Invoke(new()
    {
        Filter = $"name eq '{networkName}'",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vra.VraFunctions;
import com.pulumi.vra.inputs.GetNetworkArgs;
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 test-network = VraFunctions.getNetwork(GetNetworkArgs.builder()
            .filter(String.format("name eq '%s'", networkName))
            .build());

    }
}

    variables:
  test-network:
    fn::invoke:
      function: vra:getNetwork
      arguments:
        filter: name eq '${networkName}'

    Using getNetwork

    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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
    def get_network(filter: Optional[str] = None,
                id: Optional[str] = None,
                name: Optional[str] = None,
                return_first: Optional[bool] = None,
                tags: Optional[Sequence[GetNetworkTag]] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(filter: Optional[pulumi.Input[str]] = None,
                id: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                return_first: Optional[pulumi.Input[bool]] = None,
                tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkTagArgs]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
    func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

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

    public static class GetNetwork 
{
    public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)

    fn::invoke:
  function: vra:index/getNetwork:getNetwork
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Filter string
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    Id string
    The id of the network instance. Only one of id, name, or filter must be specified.
    Name string
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    ReturnFirst bool
    Return the first matching network instance when set to true.
    Tags List<GetNetworkTag>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    Filter string
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    Id string
    The id of the network instance. Only one of id, name, or filter must be specified.
    Name string
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    ReturnFirst bool
    Return the first matching network instance when set to true.
    Tags []GetNetworkTag
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter String
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    id String
    The id of the network instance. Only one of id, name, or filter must be specified.
    name String
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    returnFirst Boolean
    Return the first matching network instance when set to true.
    tags List<GetNetworkTag>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter string
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    id string
    The id of the network instance. Only one of id, name, or filter must be specified.
    name string
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    returnFirst boolean
    Return the first matching network instance when set to true.
    tags GetNetworkTag[]
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter str
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    id str
    The id of the network instance. Only one of id, name, or filter must be specified.
    name str
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    return_first bool
    Return the first matching network instance when set to true.
    tags Sequence[GetNetworkTag]
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter String
    The search criteria to narrow down the network instance. Only one of id, name, or filter must be specified.
    id String
    The id of the network instance. Only one of id, name, or filter must be specified.
    name String
    The human-friendly name of the network instance. Only one of id, name, or filter must be specified.
    returnFirst Boolean
    Return the first matching network instance when set to true.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    getNetwork Result

    The following output properties are available:

    Cidr string
    IPv4 address range of the network in CIDR format.
    CloudAccountIds List<string>
    Set of ids of the cloud accounts this resource belongs to.
    CustomProperties Dictionary<string, string>
    Additional properties that may be used to extend the base resource.
    DeploymentId string
    Deployment id that is associated with this resource.
    Description string
    A human-friendly description.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external zoneId of the resource.
    Id string
    Links List<GetNetworkLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user or display name of the group that owns the entity.
    ProjectId string
    The id of the project this resource belongs to.
    UpdatedAt string
    Filter string
    ReturnFirst bool
    Tags List<GetNetworkTag>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    Cidr string
    IPv4 address range of the network in CIDR format.
    CloudAccountIds []string
    Set of ids of the cloud accounts this resource belongs to.
    CustomProperties map[string]string
    Additional properties that may be used to extend the base resource.
    DeploymentId string
    Deployment id that is associated with this resource.
    Description string
    A human-friendly description.
    ExternalId string
    External entity Id on the provider side.
    ExternalRegionId string
    The external regionId of the resource.
    ExternalZoneId string
    The external zoneId of the resource.
    Id string
    Links []GetNetworkLink
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user or display name of the group that owns the entity.
    ProjectId string
    The id of the project this resource belongs to.
    UpdatedAt string
    Filter string
    ReturnFirst bool
    Tags []GetNetworkTag
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    cidr String
    IPv4 address range of the network in CIDR format.
    cloudAccountIds List<String>
    Set of ids of the cloud accounts this resource belongs to.
    customProperties Map<String,String>
    Additional properties that may be used to extend the base resource.
    deploymentId String
    Deployment id that is associated with this resource.
    description String
    A human-friendly description.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external zoneId of the resource.
    id String
    links List<GetNetworkLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user or display name of the group that owns the entity.
    projectId String
    The id of the project this resource belongs to.
    updatedAt String
    filter String
    returnFirst Boolean
    tags List<GetNetworkTag>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    cidr string
    IPv4 address range of the network in CIDR format.
    cloudAccountIds string[]
    Set of ids of the cloud accounts this resource belongs to.
    customProperties {[key: string]: string}
    Additional properties that may be used to extend the base resource.
    deploymentId string
    Deployment id that is associated with this resource.
    description string
    A human-friendly description.
    externalId string
    External entity Id on the provider side.
    externalRegionId string
    The external regionId of the resource.
    externalZoneId string
    The external zoneId of the resource.
    id string
    links GetNetworkLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name string
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user or display name of the group that owns the entity.
    projectId string
    The id of the project this resource belongs to.
    updatedAt string
    filter string
    returnFirst boolean
    tags GetNetworkTag[]
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    cidr str
    IPv4 address range of the network in CIDR format.
    cloud_account_ids Sequence[str]
    Set of ids of the cloud accounts this resource belongs to.
    custom_properties Mapping[str, str]
    Additional properties that may be used to extend the base resource.
    deployment_id str
    Deployment id that is associated with this resource.
    description str
    A human-friendly description.
    external_id str
    External entity Id on the provider side.
    external_region_id str
    The external regionId of the resource.
    external_zone_id str
    The external zoneId of the resource.
    id str
    links Sequence[GetNetworkLink]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name str
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user or display name of the group that owns the entity.
    project_id str
    The id of the project this resource belongs to.
    updated_at str
    filter str
    return_first bool
    tags Sequence[GetNetworkTag]
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    cidr String
    IPv4 address range of the network in CIDR format.
    cloudAccountIds List<String>
    Set of ids of the cloud accounts this resource belongs to.
    customProperties Map<String>
    Additional properties that may be used to extend the base resource.
    deploymentId String
    Deployment id that is associated with this resource.
    description String
    A human-friendly description.
    externalId String
    External entity Id on the provider side.
    externalRegionId String
    The external regionId of the resource.
    externalZoneId String
    The external zoneId of the resource.
    id String
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user or display name of the group that owns the entity.
    projectId String
    The id of the project this resource belongs to.
    updatedAt String
    filter String
    returnFirst Boolean
    tags List<Property Map>
    A set of tag keys and optional values that were set on this resource. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    Supporting Types

    Href string
    Hrefs List<string>
    Rel string
    Href string
    Hrefs []string
    Rel string
    href String
    hrefs List<String>
    rel String
    href string
    hrefs string[]
    rel string
    href str
    hrefs Sequence[str]
    rel str
    href String
    hrefs List<String>
    rel String

    GetNetworkTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    vra vmware/terraform-provider-vra
    License
    Notes
    This Pulumi package is based on the vra Terraform Provider.
    vra logo
    Viewing docs for vra 0.17.0
    published on Tuesday, Mar 10, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-vra
      Try Pulumi Cloud free. Your team will thank you.