Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
published on Monday, May 18, 2026 by vmware
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
published on Monday, May 18, 2026 by vmware
This data source provides information about an inventory Connectivity Profile configured under VPC on NSX.
This data source is applicable to NSX Policy Manager and is supported with NSX 9.0.0 onwards.
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.getVpcConnectivityProfile({
context: {
projectId: demoproj.id,
},
displayName: "profile1",
}));
import pulumi
import pulumi_nsxt as nsxt
demoproj = nsxt.get_policy_project(display_name="demoproj")
test = nsxt.get_vpc_connectivity_profile(context={
"project_id": demoproj.id,
},
display_name="profile1")
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.LookupVpcConnectivityProfile(ctx, &nsxt.LookupVpcConnectivityProfileArgs{
Context: nsxt.GetVpcConnectivityProfileContext{
ProjectId: demoproj.Id,
},
DisplayName: pulumi.StringRef("profile1"),
}, 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 test = Nsxt.GetVpcConnectivityProfile.Invoke(new()
{
Context = new Nsxt.Inputs.GetVpcConnectivityProfileContextInputArgs
{
ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
},
DisplayName = "profile1",
});
});
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.GetVpcConnectivityProfileArgs;
import com.pulumi.nsxt.inputs.GetVpcConnectivityProfileContextArgs;
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.getVpcConnectivityProfile(GetVpcConnectivityProfileArgs.builder()
.context(GetVpcConnectivityProfileContextArgs.builder()
.projectId(demoproj.id())
.build())
.displayName("profile1")
.build());
}
}
variables:
demoproj:
fn::invoke:
function: nsxt:getPolicyProject
arguments:
displayName: demoproj
test:
fn::invoke:
function: nsxt:getVpcConnectivityProfile
arguments:
context:
projectId: ${demoproj.id}
displayName: profile1
Example coming soon!
Fetching Default VPC Connectivity Profile Attribute
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const test = nsxt.getVpcConnectivityProfile({
context: {
projectId: "default",
},
isDefault: true,
});
export const nsxtVpcConnectivityProfileTest = test.then(test => test.displayName);
import pulumi
import pulumi_nsxt as nsxt
test = nsxt.get_vpc_connectivity_profile(context={
"project_id": "default",
},
is_default=True)
pulumi.export("nsxtVpcConnectivityProfileTest", test.display_name)
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 {
test, err := nsxt.LookupVpcConnectivityProfile(ctx, &nsxt.LookupVpcConnectivityProfileArgs{
Context: nsxt.GetVpcConnectivityProfileContext{
ProjectId: "default",
},
IsDefault: pulumi.BoolRef(true),
}, nil)
if err != nil {
return err
}
ctx.Export("nsxtVpcConnectivityProfileTest", test.DisplayName)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;
return await Deployment.RunAsync(() =>
{
var test = Nsxt.GetVpcConnectivityProfile.Invoke(new()
{
Context = new Nsxt.Inputs.GetVpcConnectivityProfileContextInputArgs
{
ProjectId = "default",
},
IsDefault = true,
});
return new Dictionary<string, object?>
{
["nsxtVpcConnectivityProfileTest"] = test.Apply(getVpcConnectivityProfileResult => getVpcConnectivityProfileResult.DisplayName),
};
});
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.GetVpcConnectivityProfileArgs;
import com.pulumi.nsxt.inputs.GetVpcConnectivityProfileContextArgs;
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 = NsxtFunctions.getVpcConnectivityProfile(GetVpcConnectivityProfileArgs.builder()
.context(GetVpcConnectivityProfileContextArgs.builder()
.projectId("default")
.build())
.isDefault(true)
.build());
ctx.export("nsxtVpcConnectivityProfileTest", test.displayName());
}
}
variables:
test:
fn::invoke:
function: nsxt:getVpcConnectivityProfile
arguments:
context:
projectId: default
isDefault: true
outputs:
nsxtVpcConnectivityProfileTest: ${test.displayName}
Example coming soon!
Using getVpcConnectivityProfile
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 getVpcConnectivityProfile(args: GetVpcConnectivityProfileArgs, opts?: InvokeOptions): Promise<GetVpcConnectivityProfileResult>
function getVpcConnectivityProfileOutput(args: GetVpcConnectivityProfileOutputArgs, opts?: InvokeOptions): Output<GetVpcConnectivityProfileResult>def get_vpc_connectivity_profile(context: Optional[GetVpcConnectivityProfileContext] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
is_default: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetVpcConnectivityProfileResult
def get_vpc_connectivity_profile_output(context: pulumi.Input[Optional[GetVpcConnectivityProfileContextArgs]] = None,
description: pulumi.Input[Optional[str]] = None,
display_name: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
is_default: pulumi.Input[Optional[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetVpcConnectivityProfileResult]func LookupVpcConnectivityProfile(ctx *Context, args *LookupVpcConnectivityProfileArgs, opts ...InvokeOption) (*LookupVpcConnectivityProfileResult, error)
func LookupVpcConnectivityProfileOutput(ctx *Context, args *LookupVpcConnectivityProfileOutputArgs, opts ...InvokeOption) LookupVpcConnectivityProfileResultOutput> Note: This function is named LookupVpcConnectivityProfile in the Go SDK.
public static class GetVpcConnectivityProfile
{
public static Task<GetVpcConnectivityProfileResult> InvokeAsync(GetVpcConnectivityProfileArgs args, InvokeOptions? opts = null)
public static Output<GetVpcConnectivityProfileResult> Invoke(GetVpcConnectivityProfileInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetVpcConnectivityProfileResult> getVpcConnectivityProfile(GetVpcConnectivityProfileArgs args, InvokeOptions options)
public static Output<GetVpcConnectivityProfileResult> getVpcConnectivityProfile(GetVpcConnectivityProfileArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getVpcConnectivityProfile:getVpcConnectivityProfile
arguments:
# arguments dictionarydata "nsxt_getvpcconnectivityprofile" "name" {
# arguments
}The following arguments are supported:
- Context
Get
Vpc Connectivity Profile Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Connectivity Profile to retrieve.
- Id string
- The ID of Connectivity Profile to retrieve.
- Is
Default bool - Specifies if the VPC Connectivity Profile is set as the default.
- Context
Get
Vpc Connectivity Profile Context - The context which the object belongs to
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Connectivity Profile to retrieve.
- Id string
- The ID of Connectivity Profile to retrieve.
- Is
Default bool - Specifies if the VPC Connectivity Profile is set as the default.
- context object
- The context which the object belongs to
- description string
- The description of the resource.
- display_
name string - The Display Name prefix of the Connectivity Profile to retrieve.
- id string
- The ID of Connectivity Profile to retrieve.
- is_
default bool - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - The context which the object belongs to
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Connectivity Profile to retrieve.
- id String
- The ID of Connectivity Profile to retrieve.
- is
Default Boolean - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - The context which the object belongs to
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of the Connectivity Profile to retrieve.
- id string
- The ID of Connectivity Profile to retrieve.
- is
Default boolean - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - The context which the object belongs to
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of the Connectivity Profile to retrieve.
- id str
- The ID of Connectivity Profile to retrieve.
- is_
default bool - Specifies if the VPC Connectivity Profile is set as the default.
- 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 Connectivity Profile to retrieve.
- id String
- The ID of Connectivity Profile to retrieve.
- is
Default Boolean - Specifies if the VPC Connectivity Profile is set as the default.
getVpcConnectivityProfile Result
The following output properties are available:
- Context
Get
Vpc Connectivity Profile Context - Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Is
Default bool - Specifies if the VPC Connectivity Profile is set as the default.
- Context
Get
Vpc Connectivity Profile Context - Description string
- The description of the resource.
- Display
Name string - Id string
- Path string
- The NSX path of the policy resource.
- Is
Default bool - Specifies if the VPC Connectivity Profile is set as the default.
- context object
- description string
- The description of the resource.
- display_
name string - id string
- path string
- The NSX path of the policy resource.
- is_
default bool - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- is
Default Boolean - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - description string
- The description of the resource.
- display
Name string - id string
- path string
- The NSX path of the policy resource.
- is
Default boolean - Specifies if the VPC Connectivity Profile is set as the default.
- context
Get
Vpc Connectivity Profile Context - description str
- The description of the resource.
- display_
name str - id str
- path str
- The NSX path of the policy resource.
- is_
default bool - Specifies if the VPC Connectivity Profile is set as the default.
- context Property Map
- description String
- The description of the resource.
- display
Name String - id String
- path String
- The NSX path of the policy resource.
- is
Default Boolean - Specifies if the VPC Connectivity Profile is set as the default.
Supporting Types
GetVpcConnectivityProfileContext
- Project
Id string - The ID of the project which the object belongs to
- Project
Id string - The ID of the project which the object belongs to
- project_
id string - The ID of the project which the object belongs to
- project
Id String - The ID of the project which the object belongs to
- project
Id string - The ID of the project which the object belongs to
- project_
id str - The ID of the project which the object belongs to
- project
Id 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
nsxtTerraform Provider.
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
published on Monday, May 18, 2026 by vmware
