nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware
nsxt.getVpcGroup
Start a Neo task
Explain and create a nsxt.getVpcGroup resource
This data source provides information about an inventory Group configured under VPC 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 demovpc = demoproj.then(demoproj => nsxt.getVpc({
context: {
projectId: demoproj.id,
},
displayName: "vpc1",
}));
const test = Promise.all([demoproj, demovpc]).then(([demoproj, demovpc]) => nsxt.getVpcGroup({
context: {
projectId: demoproj.id,
vpcId: demovpc.id,
},
displayName: "group1",
}));
import pulumi
import pulumi_nsxt as nsxt
demoproj = nsxt.get_policy_project(display_name="demoproj")
demovpc = nsxt.get_vpc(context={
"project_id": demoproj.id,
},
display_name="vpc1")
test = nsxt.get_vpc_group(context={
"project_id": demoproj.id,
"vpc_id": demovpc.id,
},
display_name="group1")
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
}
demovpc, err := nsxt.LookupVpc(ctx, &nsxt.LookupVpcArgs{
Context: nsxt.GetVpcContext{
ProjectId: demoproj.Id,
},
DisplayName: pulumi.StringRef("vpc1"),
}, nil)
if err != nil {
return err
}
_, err = nsxt.LookupVpcGroup(ctx, &nsxt.LookupVpcGroupArgs{
Context: nsxt.GetVpcGroupContext{
ProjectId: demoproj.Id,
VpcId: demovpc.Id,
},
DisplayName: pulumi.StringRef("group1"),
}, nil)
if err != nil {
return err
}
return nil
})
}
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 demovpc = Nsxt.GetVpc.Invoke(new()
{
Context = new Nsxt.Inputs.GetVpcContextInputArgs
{
ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
},
DisplayName = "vpc1",
});
var test = Nsxt.GetVpcGroup.Invoke(new()
{
Context = new Nsxt.Inputs.GetVpcGroupContextInputArgs
{
ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
VpcId = demovpc.Apply(getVpcResult => getVpcResult.Id),
},
DisplayName = "group1",
});
});
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 com.pulumi.nsxt.inputs.GetVpcGroupArgs;
import com.pulumi.nsxt.inputs.GetVpcGroupContextArgs;
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 demovpc = NsxtFunctions.getVpc(GetVpcArgs.builder()
.context(GetVpcContextArgs.builder()
.projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
.build())
.displayName("vpc1")
.build());
final var test = NsxtFunctions.getVpcGroup(GetVpcGroupArgs.builder()
.context(GetVpcGroupContextArgs.builder()
.projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
.vpcId(demovpc.applyValue(getVpcResult -> getVpcResult.id()))
.build())
.displayName("group1")
.build());
}
}
variables:
demoproj:
fn::invoke:
function: nsxt:getPolicyProject
arguments:
displayName: demoproj
demovpc:
fn::invoke:
function: nsxt:getVpc
arguments:
context:
projectId: ${demoproj.id}
displayName: vpc1
test:
fn::invoke:
function: nsxt:getVpcGroup
arguments:
context:
projectId: ${demoproj.id}
vpcId: ${demovpc.id}
displayName: group1
Using getVpcGroup
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 getVpcGroup(args: GetVpcGroupArgs, opts?: InvokeOptions): Promise<GetVpcGroupResult>
function getVpcGroupOutput(args: GetVpcGroupOutputArgs, opts?: InvokeOptions): Output<GetVpcGroupResult>def get_vpc_group(context: Optional[GetVpcGroupContext] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVpcGroupResult
def get_vpc_group_output(context: Optional[pulumi.Input[GetVpcGroupContextArgs]] = None,
description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVpcGroupResult]func LookupVpcGroup(ctx *Context, args *LookupVpcGroupArgs, opts ...InvokeOption) (*LookupVpcGroupResult, error)
func LookupVpcGroupOutput(ctx *Context, args *LookupVpcGroupOutputArgs, opts ...InvokeOption) LookupVpcGroupResultOutput> Note: This function is named LookupVpcGroup in the Go SDK.
public static class GetVpcGroup
{
public static Task<GetVpcGroupResult> InvokeAsync(GetVpcGroupArgs args, InvokeOptions? opts = null)
public static Output<GetVpcGroupResult> Invoke(GetVpcGroupInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVpcGroupResult> getVpcGroup(GetVpcGroupArgs args, InvokeOptions options)
public static Output<GetVpcGroupResult> getVpcGroup(GetVpcGroupArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getVpcGroup:getVpcGroup
arguments:
# arguments dictionaryThe following arguments are supported:
- Context
Get
Vpc Group Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Group to retrieve.
- Id string
- The ID of Group to retrieve.
- Context
Get
Vpc Group Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Group to retrieve.
- Id string
- The ID of Group to retrieve.
- context
Get
Vpc Group Context - The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Group to retrieve.
- id String
- The ID of Group to retrieve.
- context
Get
Vpc Group Context - The context which the object belongs to
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of the Group to retrieve.
- id string
- The ID of Group to retrieve.
- context
Get
Vpc Group Context - The context which the object belongs to
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of the Group to retrieve.
- id str
- The ID of Group to retrieve.
- context Property Map
- The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Group to retrieve.
- id String
- The ID of Group to retrieve.
getVpcGroup Result
The following output properties are available:
- Context
Get
Vpc Group Context - Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Context
Get
Vpc Group Context - Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- context
Get
Vpc Group Context - description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- context
Get
Vpc Group Context - description string
- The description of the resource.
- display
Name string - id string
- path string
- The NSX path of the policy resource.
- context
Get
Vpc Group Context - description str
- The description of the resource.
- display_
name str - id str
- path str
- The NSX path of the policy resource.
- context Property Map
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
Supporting Types
GetVpcGroupContext
- project_
id str - The ID of the project which the object belongs to
- vpc_
id str - The ID of the VPC which the object belongs to
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
