1. Packages
  2. Vra Provider
  3. API Docs
  4. getNetworkProfile
vra 0.15.0 published on Tuesday, Aug 19, 2025 by vmware
vmware/terraform-provider-vra

vra.getNetworkProfile

Get Started
vra logo
vra 0.15.0 published on Tuesday, Aug 19, 2025 by vmware
vmware/terraform-provider-vra

    Example Usage

    S

    This is an example of how to create a network profile resource.

    Network profile data source by its id:

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

const _this = vra.getNetworkProfile({
    filter: `name eq '${vra_network_profile["this"].name}'`,
});

    import pulumi
import pulumi_vra as vra

this = vra.get_network_profile(filter=f"name eq '{vra_network_profile['this']['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.LookupNetworkProfile(ctx, &vra.LookupNetworkProfileArgs{
			Filter: pulumi.StringRef(fmt.Sprintf("name eq '%v'", vra_network_profile.This.Name)),
		}, 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 @this = Vra.GetNetworkProfile.Invoke(new()
    {
        Filter = $"name eq '{vra_network_profile.This.Name}'",
    });

});

    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.GetNetworkProfileArgs;
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 this = VraFunctions.getNetworkProfile(GetNetworkProfileArgs.builder()
            .filter(String.format("name eq '%s'", vra_network_profile.this().name()))
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getNetworkProfile
      arguments:
        filter: name eq '${vra_network_profile.this.name}'

    network profile data source filter by region id:

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

const _this = vra.getNetworkProfile({
    filter: `regionId eq '${data.vra_region["this"].id}'`,
});

    import pulumi
import pulumi_vra as vra

this = vra.get_network_profile(filter=f"regionId eq '{data['vra_region']['this']['id']}'")

    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.LookupNetworkProfile(ctx, &vra.LookupNetworkProfileArgs{
			Filter: pulumi.StringRef(fmt.Sprintf("regionId eq '%v'", data.Vra_region.This.Id)),
		}, 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 @this = Vra.GetNetworkProfile.Invoke(new()
    {
        Filter = $"regionId eq '{data.Vra_region.This.Id}'",
    });

});

    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.GetNetworkProfileArgs;
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 this = VraFunctions.getNetworkProfile(GetNetworkProfileArgs.builder()
            .filter(String.format("regionId eq '%s'", data.vra_region().this().id()))
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: vra:getNetworkProfile
      arguments:
        filter: regionId eq '${data.vra_region.this.id}'

    A network profile data source supports the following arguments:

    Using getNetworkProfile

    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 getNetworkProfile(args: GetNetworkProfileArgs, opts?: InvokeOptions): Promise<GetNetworkProfileResult>
function getNetworkProfileOutput(args: GetNetworkProfileOutputArgs, opts?: InvokeOptions): Output<GetNetworkProfileResult>
    def get_network_profile(filter: Optional[str] = None,
                        id: Optional[str] = None,
                        isolated_external_fabric_network_id: Optional[str] = None,
                        isolated_network_domain_id: Optional[str] = None,
                        tags: Optional[Sequence[GetNetworkProfileTag]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetNetworkProfileResult
def get_network_profile_output(filter: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        isolated_external_fabric_network_id: Optional[pulumi.Input[str]] = None,
                        isolated_network_domain_id: Optional[pulumi.Input[str]] = None,
                        tags: Optional[pulumi.Input[Sequence[pulumi.Input[GetNetworkProfileTagArgs]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetNetworkProfileResult]
    func LookupNetworkProfile(ctx *Context, args *LookupNetworkProfileArgs, opts ...InvokeOption) (*LookupNetworkProfileResult, error)
func LookupNetworkProfileOutput(ctx *Context, args *LookupNetworkProfileOutputArgs, opts ...InvokeOption) LookupNetworkProfileResultOutput

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

    public static class GetNetworkProfile 
{
    public static Task<GetNetworkProfileResult> InvokeAsync(GetNetworkProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkProfileResult> Invoke(GetNetworkProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkProfileResult> getNetworkProfile(GetNetworkProfileArgs args, InvokeOptions options)
public static Output<GetNetworkProfileResult> getNetworkProfile(GetNetworkProfileArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    IsolatedExternalFabricNetworkId string
    The Id of the fabric network used for outbound access.
    IsolatedNetworkDomainId string
    The Id of the network domain used for creating isolated networks.
    Tags List<GetNetworkProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    Filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    Id string
    The id of the image profile instance.
    IsolatedExternalFabricNetworkId string
    The Id of the fabric network used for outbound access.
    IsolatedNetworkDomainId string
    The Id of the network domain used for creating isolated networks.
    Tags []GetNetworkProfileTag
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter String
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    isolatedExternalFabricNetworkId String
    The Id of the fabric network used for outbound access.
    isolatedNetworkDomainId String
    The Id of the network domain used for creating isolated networks.
    tags List<GetNetworkProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter string
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id string
    The id of the image profile instance.
    isolatedExternalFabricNetworkId string
    The Id of the fabric network used for outbound access.
    isolatedNetworkDomainId string
    The Id of the network domain used for creating isolated networks.
    tags GetNetworkProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter str
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id str
    The id of the image profile instance.
    isolated_external_fabric_network_id str
    The Id of the fabric network used for outbound access.
    isolated_network_domain_id str
    The Id of the network domain used for creating isolated networks.
    tags Sequence[GetNetworkProfileTag]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    filter String
    Filter query string that is supported by VMware Aria Automation multi-cloud IaaS API. Example: regionId eq '<regionId>' and cloudAccountId eq '<cloudAccountId>'.
    id String
    The id of the image profile instance.
    isolatedExternalFabricNetworkId String
    The Id of the fabric network used for outbound access.
    isolatedNetworkDomainId String
    The Id of the network domain used for creating isolated networks.
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]

    getNetworkProfile Result

    The following output properties are available:

    CustomProperties Dictionary<string, string>
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    Description string
    A human-friendly description.
    ExternalRegionId string
    The external regionId of the resource.
    FabricNetworkIds List<string>
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    Id string
    IsolatedNetworkCidrPrefix double
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    IsolatedNetworkDomainCidr string
    CIDR of the isolation network domain.
    IsolationType string
    Specifies the isolation type e.g. none, subnet or security group
    Links List<GetNetworkProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    SecurityGroupIds List<string>
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Filter string
    IsolatedExternalFabricNetworkId string
    IsolatedNetworkDomainId string
    Tags List<GetNetworkProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    CustomProperties map[string]string
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    Description string
    A human-friendly description.
    ExternalRegionId string
    The external regionId of the resource.
    FabricNetworkIds []string
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    Id string
    IsolatedNetworkCidrPrefix float64
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    IsolatedNetworkDomainCidr string
    CIDR of the isolation network domain.
    IsolationType string
    Specifies the isolation type e.g. none, subnet or security group
    Links []GetNetworkProfileLink
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    Name string
    A human-friendly name used as an identifier in APIs that support this option.
    OrganizationId string
    The id of the organization this entity belongs to.
    Owner string
    Email of the user that owns the entity.
    RegionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    SecurityGroupIds []string
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    UpdatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    Filter string
    IsolatedExternalFabricNetworkId string
    IsolatedNetworkDomainId string
    Tags []GetNetworkProfileTag
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    customProperties Map<String,String>
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    description String
    A human-friendly description.
    externalRegionId String
    The external regionId of the resource.
    fabricNetworkIds List<String>
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    id String
    isolatedNetworkCidrPrefix Double
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    isolatedNetworkDomainCidr String
    CIDR of the isolation network domain.
    isolationType String
    Specifies the isolation type e.g. none, subnet or security group
    links List<GetNetworkProfileLink>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    securityGroupIds List<String>
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    filter String
    isolatedExternalFabricNetworkId String
    isolatedNetworkDomainId String
    tags List<GetNetworkProfileTag>
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    customProperties {[key: string]: string}
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    description string
    A human-friendly description.
    externalRegionId string
    The external regionId of the resource.
    fabricNetworkIds string[]
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    id string
    isolatedNetworkCidrPrefix number
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    isolatedNetworkDomainCidr string
    CIDR of the isolation network domain.
    isolationType string
    Specifies the isolation type e.g. none, subnet or security group
    links GetNetworkProfileLink[]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name string
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId string
    The id of the organization this entity belongs to.
    owner string
    Email of the user that owns the entity.
    regionId string
    The id of the region for which this profile is defined as in VMware Aria Automation.
    securityGroupIds string[]
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    updatedAt string
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    filter string
    isolatedExternalFabricNetworkId string
    isolatedNetworkDomainId string
    tags GetNetworkProfileTag[]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    custom_properties Mapping[str, str]
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    description str
    A human-friendly description.
    external_region_id str
    The external regionId of the resource.
    fabric_network_ids Sequence[str]
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    id str
    isolated_network_cidr_prefix float
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    isolated_network_domain_cidr str
    CIDR of the isolation network domain.
    isolation_type str
    Specifies the isolation type e.g. none, subnet or security group
    links Sequence[GetNetworkProfileLink]
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name str
    A human-friendly name used as an identifier in APIs that support this option.
    organization_id str
    The id of the organization this entity belongs to.
    owner str
    Email of the user that owns the entity.
    region_id str
    The id of the region for which this profile is defined as in VMware Aria Automation.
    security_group_ids Sequence[str]
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    updated_at str
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    filter str
    isolated_external_fabric_network_id str
    isolated_network_domain_id str
    tags Sequence[GetNetworkProfileTag]
    A set of tag keys and optional values that were set on this Network Profile. Example: [ { "key" : "ownedBy", "value": "Rainpole" } ]
    customProperties Map<String>
    Additional properties that may be used to extend the Network Profile object that is produced from this specification. For isolationType security group, datastoreId identifies the Compute Resource Edge datastore. computeCluster and resourcePoolId identify the Compute Resource Edge cluster. For isolationType subnet, distributedLogicalRouterStateLink identifies the on-demand network distributed local router. onDemandNetworkIPAssignmentType identifies the on-demand network IP range assignment type static, dynamic, or mixed.
    description String
    A human-friendly description.
    externalRegionId String
    The external regionId of the resource.
    fabricNetworkIds List<String>
    A list of fabric network Ids which are assigned to the network profile. Example: [ "6543" ]
    id String
    isolatedNetworkCidrPrefix Number
    The CIDR prefix length to be used for the isolated networks that are created with the network profile.
    isolatedNetworkDomainCidr String
    CIDR of the isolation network domain.
    isolationType String
    Specifies the isolation type e.g. none, subnet or security group
    links List<Property Map>
    Hypermedia as the Engine of Application State (HATEOAS) of the entity.
    name String
    A human-friendly name used as an identifier in APIs that support this option.
    organizationId String
    The id of the organization this entity belongs to.
    owner String
    Email of the user that owns the entity.
    regionId String
    The id of the region for which this profile is defined as in VMware Aria Automation.
    securityGroupIds List<String>
    A list of security group Ids which are assigned to the network profile. Example: [ "6545" ]
    updatedAt String
    Date when the entity was last updated. The date is ISO 8601 and UTC.
    filter String
    isolatedExternalFabricNetworkId String
    isolatedNetworkDomainId String
    tags List<Property Map>
    A set of tag keys and optional values that were set on this Network Profile. 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

    GetNetworkProfileTag

    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
    vra 0.15.0 published on Tuesday, Aug 19, 2025 by vmware
    vmware/terraform-provider-vra
      Meet Neo: Your AI Platform Teammate