nsxt 3.10.0 published on Wednesday, Sep 10, 2025 by vmware
nsxt.getPolicyProject
Start a Neo task
Explain and create a nsxt.getPolicyProject resource
This data source provides information about policy Project 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 test = nsxt.getPolicyProject({
displayName: "project1",
});
import pulumi
import pulumi_nsxt as nsxt
test = nsxt.get_policy_project(display_name="project1")
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 {
_, err := nsxt.LookupPolicyProject(ctx, &nsxt.LookupPolicyProjectArgs{
DisplayName: pulumi.StringRef("project1"),
}, 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 test = Nsxt.GetPolicyProject.Invoke(new()
{
DisplayName = "project1",
});
});
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 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.getPolicyProject(GetPolicyProjectArgs.builder()
.displayName("project1")
.build());
}
}
variables:
test:
fn::invoke:
function: nsxt:getPolicyProject
arguments:
displayName: project1
Using getPolicyProject
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 getPolicyProject(args: GetPolicyProjectArgs, opts?: InvokeOptions): Promise<GetPolicyProjectResult>
function getPolicyProjectOutput(args: GetPolicyProjectOutputArgs, opts?: InvokeOptions): Output<GetPolicyProjectResult>def get_policy_project(description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
short_id: Optional[str] = None,
site_infos: Optional[Sequence[GetPolicyProjectSiteInfo]] = None,
opts: Optional[InvokeOptions] = None) -> GetPolicyProjectResult
def get_policy_project_output(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,
site_infos: Optional[pulumi.Input[Sequence[pulumi.Input[GetPolicyProjectSiteInfoArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPolicyProjectResult]func LookupPolicyProject(ctx *Context, args *LookupPolicyProjectArgs, opts ...InvokeOption) (*LookupPolicyProjectResult, error)
func LookupPolicyProjectOutput(ctx *Context, args *LookupPolicyProjectOutputArgs, opts ...InvokeOption) LookupPolicyProjectResultOutput> Note: This function is named LookupPolicyProject in the Go SDK.
public static class GetPolicyProject
{
public static Task<GetPolicyProjectResult> InvokeAsync(GetPolicyProjectArgs args, InvokeOptions? opts = null)
public static Output<GetPolicyProjectResult> Invoke(GetPolicyProjectInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetPolicyProjectResult> getPolicyProject(GetPolicyProjectArgs args, InvokeOptions options)
public static Output<GetPolicyProjectResult> getPolicyProject(GetPolicyProjectArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getPolicyProject:getPolicyProject
arguments:
# arguments dictionaryThe following arguments are supported:
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Project to retrieve.
- Id string
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- Short
Id string - Unique ID used for logging.
- Site
Infos List<GetPolicy Project Site Info> - Information related to sites applicable for given Project.
- Description string
- The description of the resource.
- Display
Name string - The Display Name prefix of the Project to retrieve.
- Id string
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- Short
Id string - Unique ID used for logging.
- Site
Infos []GetPolicy Project Site Info - Information related to sites applicable for given Project.
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Project to retrieve.
- id String
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- short
Id String - Unique ID used for logging.
- site
Infos List<GetPolicy Project Site Info> - Information related to sites applicable for given Project.
- description string
- The description of the resource.
- display
Name string - The Display Name prefix of the Project to retrieve.
- id string
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- short
Id string - Unique ID used for logging.
- site
Infos GetPolicy Project Site Info[] - Information related to sites applicable for given Project.
- description str
- The description of the resource.
- display_
name str - The Display Name prefix of the Project to retrieve.
- id str
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- short_
id str - Unique ID used for logging.
- site_
infos Sequence[GetPolicy Project Site Info] - Information related to sites applicable for given Project.
- description String
- The description of the resource.
- display
Name String - The Display Name prefix of the Project to retrieve.
- id String
- The ID of Project to retrieve. If ID is specified, no additional argument should be configured.
- short
Id String - Unique ID used for logging.
- site
Infos List<Property Map> - Information related to sites applicable for given Project.
getPolicyProject Result
The following output properties are available:
- Description string
- The description of the resource.
- Display
Name string - External
Ipv4Blocks List<string> - Policy paths of IPv4 blocks associated with the project.
- Id string
- Path string
- The NSX path of the policy resource.
- Tier0Gateway
Paths List<string> - Policy paths of Tier0 gateways associated with the project.
- Short
Id string - Unique ID used for logging.
- Site
Infos List<GetPolicy Project Site Info> - Information related to sites applicable for given Project.
- Description string
- The description of the resource.
- Display
Name string - External
Ipv4Blocks []string - Policy paths of IPv4 blocks associated with the project.
- Id string
- Path string
- The NSX path of the policy resource.
- Tier0Gateway
Paths []string - Policy paths of Tier0 gateways associated with the project.
- Short
Id string - Unique ID used for logging.
- Site
Infos []GetPolicy Project Site Info - Information related to sites applicable for given Project.
- description String
- The description of the resource.
- display
Name String - external
Ipv4Blocks List<String> - Policy paths of IPv4 blocks associated with the project.
- id String
- path String
- The NSX path of the policy resource.
- tier0Gateway
Paths List<String> - Policy paths of Tier0 gateways associated with the project.
- short
Id String - Unique ID used for logging.
- site
Infos List<GetPolicy Project Site Info> - Information related to sites applicable for given Project.
- description string
- The description of the resource.
- display
Name string - external
Ipv4Blocks string[] - Policy paths of IPv4 blocks associated with the project.
- id string
- path string
- The NSX path of the policy resource.
- tier0Gateway
Paths string[] - Policy paths of Tier0 gateways associated with the project.
- short
Id string - Unique ID used for logging.
- site
Infos GetPolicy Project Site Info[] - Information related to sites applicable for given Project.
- description str
- The description of the resource.
- display_
name str - external_
ipv4_ Sequence[str]blocks - Policy paths of IPv4 blocks associated with the project.
- id str
- path str
- The NSX path of the policy resource.
- tier0_
gateway_ Sequence[str]paths - Policy paths of Tier0 gateways associated with the project.
- short_
id str - Unique ID used for logging.
- site_
infos Sequence[GetPolicy Project Site Info] - Information related to sites applicable for given Project.
- description String
- The description of the resource.
- display
Name String - external
Ipv4Blocks List<String> - Policy paths of IPv4 blocks associated with the project.
- id String
- path String
- The NSX path of the policy resource.
- tier0Gateway
Paths List<String> - Policy paths of Tier0 gateways associated with the project.
- short
Id String - Unique ID used for logging.
- site
Infos List<Property Map> - Information related to sites applicable for given Project.
Supporting Types
GetPolicyProjectSiteInfo
- Edge
Cluster List<string>Paths - The edge cluster on which the networking elements for the Org are be created.
- Site
Path string - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
- Edge
Cluster []stringPaths - The edge cluster on which the networking elements for the Org are be created.
- Site
Path string - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
- edge
Cluster List<String>Paths - The edge cluster on which the networking elements for the Org are be created.
- site
Path String - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
- edge
Cluster string[]Paths - The edge cluster on which the networking elements for the Org are be created.
- site
Path string - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
- edge_
cluster_ Sequence[str]paths - The edge cluster on which the networking elements for the Org are be created.
- site_
path str - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
- edge
Cluster List<String>Paths - The edge cluster on which the networking elements for the Org are be created.
- site
Path String - This represents the path of the site which is managed by Global Manager. For the local manager the value would be 'default'.
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxtTerraform Provider.
