Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getVpc
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.getVpc

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

This data source provides information about VPC configured on NSX. This data source is applicable to NSX Policy Manager.

Example Usage

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

const demoproj = nsxt.getPolicyProject({
    displayName: "demoproj",
});
const test = demoproj.then(demoproj => nsxt.getVpc({
    context: {
        projectId: demoproj.id,
    },
    displayName: "vpc1",
}));
Copy
import pulumi
import pulumi_nsxt as nsxt

demoproj = nsxt.get_policy_project(display_name="demoproj")
test = nsxt.get_vpc(context={
        "project_id": demoproj.id,
    },
    display_name="vpc1")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		demoproj, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{
			DisplayName: pulumi.StringRef("demoproj"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = nsxt.GetVpc(ctx, &nsxt.GetVpcArgs{
			Context: nsxt.GetVpcContext{
				ProjectId: demoproj.Id,
			},
			DisplayName: pulumi.StringRef("vpc1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var demoproj = Nsxt.GetPolicyProject.Invoke(new()
    {
        DisplayName = "demoproj",
    });

    var test = Nsxt.GetVpc.Invoke(new()
    {
        Context = new Nsxt.Inputs.GetVpcContextInputArgs
        {
            ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
        },
        DisplayName = "vpc1",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetPolicyProjectArgs;
import com.pulumi.nsxt.inputs.GetVpcArgs;
import com.pulumi.nsxt.inputs.GetVpcContextArgs;
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 demoproj = NsxtFunctions.getPolicyProject(GetPolicyProjectArgs.builder()
            .displayName("demoproj")
            .build());

        final var test = NsxtFunctions.getVpc(GetVpcArgs.builder()
            .context(GetVpcContextArgs.builder()
                .projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
                .build())
            .displayName("vpc1")
            .build());

    }
}
Copy
variables:
  demoproj:
    fn::invoke:
      function: nsxt:getPolicyProject
      arguments:
        displayName: demoproj
  test:
    fn::invoke:
      function: nsxt:getVpc
      arguments:
        context:
          projectId: ${demoproj.id}
        displayName: vpc1
Copy

Using getVpc

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 getVpc(args: GetVpcArgs, opts?: InvokeOptions): Promise<GetVpcResult>
function getVpcOutput(args: GetVpcOutputArgs, opts?: InvokeOptions): Output<GetVpcResult>
Copy
def get_vpc(context: Optional[GetVpcContext] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            id: Optional[str] = None,
            short_id: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVpcResult
def get_vpc_output(context: Optional[pulumi.Input[GetVpcContextArgs]] = None,
            description: Optional[pulumi.Input[str]] = None,
            display_name: Optional[pulumi.Input[str]] = None,
            id: Optional[pulumi.Input[str]] = None,
            short_id: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetVpcResult]
Copy
func GetVpc(ctx *Context, args *GetVpcArgs, opts ...InvokeOption) (*GetVpcResult, error)
func GetVpcOutput(ctx *Context, args *GetVpcOutputArgs, opts ...InvokeOption) GetVpcResultOutput
Copy

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

public static class GetVpc 
{
    public static Task<GetVpcResult> InvokeAsync(GetVpcArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcResult> Invoke(GetVpcInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
public static Output<GetVpcResult> getVpc(GetVpcArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getVpc:getVpc
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Context This property is required. GetVpcContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the VPC to retrieve.
Id string
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
ShortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
Context This property is required. GetVpcContext
The context which the object belongs to
Description string
The description of the resource.
DisplayName string
The Display Name prefix of the VPC to retrieve.
Id string
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
ShortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context This property is required. GetVpcContext
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name prefix of the VPC to retrieve.
id String
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
shortId String
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context This property is required. GetVpcContext
The context which the object belongs to
description string
The description of the resource.
displayName string
The Display Name prefix of the VPC to retrieve.
id string
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
shortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context This property is required. GetVpcContext
The context which the object belongs to
description str
The description of the resource.
display_name str
The Display Name prefix of the VPC to retrieve.
id str
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
short_id str
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context This property is required. Property Map
The context which the object belongs to
description String
The description of the resource.
displayName String
The Display Name prefix of the VPC to retrieve.
id String
The ID of VPC to retrieve. If ID is specified, no additional argument should be configured.
shortId String
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.

getVpc Result

The following output properties are available:

Context GetVpcContext
Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
ShortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
Context GetVpcContext
Description string
The description of the resource.
DisplayName string
Id string
Path string
The NSX path of the policy resource.
ShortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context GetVpcContext
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
shortId String
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context GetVpcContext
description string
The description of the resource.
displayName string
id string
path string
The NSX path of the policy resource.
shortId string
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context GetVpcContext
description str
The description of the resource.
display_name str
id str
path str
The NSX path of the policy resource.
short_id str
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
context Property Map
description String
The description of the resource.
displayName String
id String
path String
The NSX path of the policy resource.
shortId String
Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.

Supporting Types

GetVpcContext

ProjectId This property is required. string
The ID of the project which the object belongs to
ProjectId This property is required. string
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to
projectId This property is required. string
The ID of the project which the object belongs to
project_id This property is required. str
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt