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

nsxt.PolicyProject

Explore with Pulumi AI

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

    Create PolicyProject Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyProject(name: string, args: PolicyProjectArgs, opts?: CustomResourceOptions);
    @overload
def PolicyProject(resource_name: str,
                  args: PolicyProjectArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def PolicyProject(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  description: Optional[str] = None,
                  external_ipv4_blocks: Optional[Sequence[str]] = None,
                  nsx_id: Optional[str] = None,
                  policy_project_id: Optional[str] = None,
                  short_id: Optional[str] = None,
                  site_infos: Optional[Sequence[PolicyProjectSiteInfoArgs]] = None,
                  tags: Optional[Sequence[PolicyProjectTagArgs]] = None,
                  tier0_gateway_paths: Optional[Sequence[str]] = None)
    func NewPolicyProject(ctx *Context, name string, args PolicyProjectArgs, opts ...ResourceOption) (*PolicyProject, error)
    public PolicyProject(string name, PolicyProjectArgs args, CustomResourceOptions? opts = null)
    public PolicyProject(String name, PolicyProjectArgs args)
public PolicyProject(String name, PolicyProjectArgs args, CustomResourceOptions options)

    type: nsxt:PolicyProject
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PolicyProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PolicyProjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PolicyProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyProjectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var policyProjectResource = new Nsxt.PolicyProject("policyProjectResource", new()
{
    DisplayName = "string",
    Description = "string",
    ExternalIpv4Blocks = new[]
    {
        "string",
    },
    NsxId = "string",
    PolicyProjectId = "string",
    ShortId = "string",
    SiteInfos = new[]
    {
        new Nsxt.Inputs.PolicyProjectSiteInfoArgs
        {
            EdgeClusterPaths = new[]
            {
                "string",
            },
            SitePath = "string",
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyProjectTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Tier0GatewayPaths = new[]
    {
        "string",
    },
});

    example, err := nsxt.NewPolicyProject(ctx, "policyProjectResource", &nsxt.PolicyProjectArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
ExternalIpv4Blocks: pulumi.StringArray{
pulumi.String("string"),
},
NsxId: pulumi.String("string"),
PolicyProjectId: pulumi.String("string"),
ShortId: pulumi.String("string"),
SiteInfos: .PolicyProjectSiteInfoArray{
&.PolicyProjectSiteInfoArgs{
EdgeClusterPaths: pulumi.StringArray{
pulumi.String("string"),
},
SitePath: pulumi.String("string"),
},
},
Tags: .PolicyProjectTagArray{
&.PolicyProjectTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
Tier0GatewayPaths: pulumi.StringArray{
pulumi.String("string"),
},
})

    var policyProjectResource = new PolicyProject("policyProjectResource", PolicyProjectArgs.builder()
    .displayName("string")
    .description("string")
    .externalIpv4Blocks("string")
    .nsxId("string")
    .policyProjectId("string")
    .shortId("string")
    .siteInfos(PolicyProjectSiteInfoArgs.builder()
        .edgeClusterPaths("string")
        .sitePath("string")
        .build())
    .tags(PolicyProjectTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .tier0GatewayPaths("string")
    .build());

    policy_project_resource = nsxt.PolicyProject("policyProjectResource",
    display_name="string",
    description="string",
    external_ipv4_blocks=["string"],
    nsx_id="string",
    policy_project_id="string",
    short_id="string",
    site_infos=[{
        "edge_cluster_paths": ["string"],
        "site_path": "string",
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    tier0_gateway_paths=["string"])

    const policyProjectResource = new nsxt.PolicyProject("policyProjectResource", {
    displayName: "string",
    description: "string",
    externalIpv4Blocks: ["string"],
    nsxId: "string",
    policyProjectId: "string",
    shortId: "string",
    siteInfos: [{
        edgeClusterPaths: ["string"],
        sitePath: "string",
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
    tier0GatewayPaths: ["string"],
});

    type: nsxt:PolicyProject
properties:
    description: string
    displayName: string
    externalIpv4Blocks:
        - string
    nsxId: string
    policyProjectId: string
    shortId: string
    siteInfos:
        - edgeClusterPaths:
            - string
          sitePath: string
    tags:
        - scope: string
          tag: string
    tier0GatewayPaths:
        - string

    PolicyProject Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PolicyProject resource accepts the following input properties:

    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    ExternalIpv4Blocks List<string>
    PolicyPath of public ip block
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyProjectId string
    ID of the resource.
    ShortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    SiteInfos List<PolicyProjectSiteInfo>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    Tags List<PolicyProjectTag>
    A list of scope + tag pairs to associate with this resource.
    Tier0GatewayPaths List<string>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    DisplayName string
    Display name of the resource.
    Description string
    Description of the resource.
    ExternalIpv4Blocks []string
    PolicyPath of public ip block
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyProjectId string
    ID of the resource.
    ShortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    SiteInfos []PolicyProjectSiteInfoArgs
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    Tags []PolicyProjectTagArgs
    A list of scope + tag pairs to associate with this resource.
    Tier0GatewayPaths []string
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    externalIpv4Blocks List<String>
    PolicyPath of public ip block
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyProjectId String
    ID of the resource.
    shortId String
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos List<PolicyProjectSiteInfo>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags List<PolicyProjectTag>
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths List<String>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    displayName string
    Display name of the resource.
    description string
    Description of the resource.
    externalIpv4Blocks string[]
    PolicyPath of public ip block
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyProjectId string
    ID of the resource.
    shortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos PolicyProjectSiteInfo[]
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags PolicyProjectTag[]
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths string[]
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    display_name str
    Display name of the resource.
    description str
    Description of the resource.
    external_ipv4_blocks Sequence[str]
    PolicyPath of public ip block
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_project_id str
    ID of the 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.
    site_infos Sequence[PolicyProjectSiteInfoArgs]
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags Sequence[PolicyProjectTagArgs]
    A list of scope + tag pairs to associate with this resource.
    tier0_gateway_paths Sequence[str]
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    displayName String
    Display name of the resource.
    description String
    Description of the resource.
    externalIpv4Blocks List<String>
    PolicyPath of public ip block
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyProjectId String
    ID of the resource.
    shortId String
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos List<Property Map>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths List<String>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyProject resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyProject Resource

    Get an existing PolicyProject resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PolicyProjectState, opts?: CustomResourceOptions): PolicyProject
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        external_ipv4_blocks: Optional[Sequence[str]] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_project_id: Optional[str] = None,
        revision: Optional[float] = None,
        short_id: Optional[str] = None,
        site_infos: Optional[Sequence[PolicyProjectSiteInfoArgs]] = None,
        tags: Optional[Sequence[PolicyProjectTagArgs]] = None,
        tier0_gateway_paths: Optional[Sequence[str]] = None) -> PolicyProject
    func GetPolicyProject(ctx *Context, name string, id IDInput, state *PolicyProjectState, opts ...ResourceOption) (*PolicyProject, error)
    public static PolicyProject Get(string name, Input<string> id, PolicyProjectState? state, CustomResourceOptions? opts = null)
    public static PolicyProject get(String name, Output<String> id, PolicyProjectState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyProject    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    ExternalIpv4Blocks List<string>
    PolicyPath of public ip block
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyProjectId string
    ID of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    ShortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    SiteInfos List<PolicyProjectSiteInfo>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    Tags List<PolicyProjectTag>
    A list of scope + tag pairs to associate with this resource.
    Tier0GatewayPaths List<string>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    ExternalIpv4Blocks []string
    PolicyPath of public ip block
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    Path string
    The NSX path of the policy resource.
    PolicyProjectId string
    ID of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    ShortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    SiteInfos []PolicyProjectSiteInfoArgs
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    Tags []PolicyProjectTagArgs
    A list of scope + tag pairs to associate with this resource.
    Tier0GatewayPaths []string
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    externalIpv4Blocks List<String>
    PolicyPath of public ip block
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyProjectId String
    ID of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    shortId String
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos List<PolicyProjectSiteInfo>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags List<PolicyProjectTag>
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths List<String>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    externalIpv4Blocks string[]
    PolicyPath of public ip block
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path string
    The NSX path of the policy resource.
    policyProjectId string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    shortId string
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos PolicyProjectSiteInfo[]
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags PolicyProjectTag[]
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths string[]
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    external_ipv4_blocks Sequence[str]
    PolicyPath of public ip block
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path str
    The NSX path of the policy resource.
    policy_project_id str
    ID of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    short_id str
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    site_infos Sequence[PolicyProjectSiteInfoArgs]
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags Sequence[PolicyProjectTagArgs]
    A list of scope + tag pairs to associate with this resource.
    tier0_gateway_paths Sequence[str]
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    externalIpv4Blocks List<String>
    PolicyPath of public ip block
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    path String
    The NSX path of the policy resource.
    policyProjectId String
    ID of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    shortId String
    Defaults to id if id is less than equal to 8 characters or defaults to random generated id if not set.
    siteInfos List<Property Map>
    Information related to sites applicable for given Project. For on-prem deployment, only 1 is allowed.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.
    tier0GatewayPaths List<String>
    The tier 0 has to be pre-created before Project is created. The tier 0 typically provides connectivity to external world. List of sites for Project has to be subset of sites where the tier 0 spans.

    Supporting Types

    PolicyProjectSiteInfo, PolicyProjectSiteInfoArgs

    EdgeClusterPaths List<string>
    The edge cluster on which the networking elements for the Org will be created.
    SitePath string
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.
    EdgeClusterPaths []string
    The edge cluster on which the networking elements for the Org will be created.
    SitePath string
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.
    edgeClusterPaths List<String>
    The edge cluster on which the networking elements for the Org will be created.
    sitePath String
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.
    edgeClusterPaths string[]
    The edge cluster on which the networking elements for the Org will be created.
    sitePath string
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.
    edge_cluster_paths Sequence[str]
    The edge cluster on which the networking elements for the Org will be created.
    site_path str
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.
    edgeClusterPaths List<String>
    The edge cluster on which the networking elements for the Org will be created.
    sitePath String
    This represents the path of the site which is managed by Global Manager. For the local manager, if set, this needs to point to 'default'.

    PolicyProjectTag, PolicyProjectTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    Package Details

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