Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getPolicyGroup
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.getPolicyGroup

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    This data source provides information about an inventory Group configured on NSX.

    This data source is applicable to NSX Policy Manager, NSX Global Manager and VMC.

    Example Usage

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

const test = nsxt.getPolicyGroup({
    displayName: "group1",
});

    import pulumi
import pulumi_nsxt as nsxt

test = nsxt.get_policy_group(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 {
		_, err := nsxt.LookupPolicyGroup(ctx, &nsxt.LookupPolicyGroupArgs{
			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 test = Nsxt.GetPolicyGroup.Invoke(new()
    {
        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.GetPolicyGroupArgs;
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.getPolicyGroup(GetPolicyGroupArgs.builder()
            .displayName("group1")
            .build());

    }
}

    variables:
  test:
    fn::invoke:
      function: nsxt:getPolicyGroup
      arguments:
        displayName: group1

    Multi-Tenancy

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

const demoproj = nsxt.getPolicyProject({
    displayName: "demoproj",
});
const demogroup = demoproj.then(demoproj => nsxt.getPolicyGroup({
    context: {
        projectId: demoproj.id,
    },
    displayName: "demogroup",
}));

    import pulumi
import pulumi_nsxt as nsxt

demoproj = nsxt.get_policy_project(display_name="demoproj")
demogroup = nsxt.get_policy_group(context={
        "project_id": demoproj.id,
    },
    display_name="demogroup")

    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.LookupPolicyGroup(ctx, &nsxt.LookupPolicyGroupArgs{
			Context: nsxt.GetPolicyGroupContext{
				ProjectId: demoproj.Id,
			},
			DisplayName: pulumi.StringRef("demogroup"),
		}, 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 demogroup = Nsxt.GetPolicyGroup.Invoke(new()
    {
        Context = new Nsxt.Inputs.GetPolicyGroupContextInputArgs
        {
            ProjectId = demoproj.Apply(getPolicyProjectResult => getPolicyProjectResult.Id),
        },
        DisplayName = "demogroup",
    });

});

    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.GetPolicyGroupArgs;
import com.pulumi.nsxt.inputs.GetPolicyGroupContextArgs;
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 demogroup = NsxtFunctions.getPolicyGroup(GetPolicyGroupArgs.builder()
            .context(GetPolicyGroupContextArgs.builder()
                .projectId(demoproj.applyValue(getPolicyProjectResult -> getPolicyProjectResult.id()))
                .build())
            .displayName("demogroup")
            .build());

    }
}

    variables:
  demoproj:
    fn::invoke:
      function: nsxt:getPolicyProject
      arguments:
        displayName: demoproj
  demogroup:
    fn::invoke:
      function: nsxt:getPolicyGroup
      arguments:
        context:
          projectId: ${demoproj.id}
        displayName: demogroup

    Using getPolicyGroup

    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 getPolicyGroup(args: GetPolicyGroupArgs, opts?: InvokeOptions): Promise<GetPolicyGroupResult>
function getPolicyGroupOutput(args: GetPolicyGroupOutputArgs, opts?: InvokeOptions): Output<GetPolicyGroupResult>
    def get_policy_group(context: Optional[GetPolicyGroupContext] = None,
                     description: Optional[str] = None,
                     display_name: Optional[str] = None,
                     domain: Optional[str] = None,
                     id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPolicyGroupResult
def get_policy_group_output(context: Optional[pulumi.Input[GetPolicyGroupContextArgs]] = None,
                     description: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     domain: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPolicyGroupResult]
    func LookupPolicyGroup(ctx *Context, args *LookupPolicyGroupArgs, opts ...InvokeOption) (*LookupPolicyGroupResult, error)
func LookupPolicyGroupOutput(ctx *Context, args *LookupPolicyGroupOutputArgs, opts ...InvokeOption) LookupPolicyGroupResultOutput

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

    public static class GetPolicyGroup 
{
    public static Task<GetPolicyGroupResult> InvokeAsync(GetPolicyGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetPolicyGroupResult> Invoke(GetPolicyGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPolicyGroupResult> getPolicyGroup(GetPolicyGroupArgs args, InvokeOptions options)
public static Output<GetPolicyGroupResult> getPolicyGroup(GetPolicyGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: nsxt:index/getPolicyGroup:getPolicyGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Context GetPolicyGroupContext
    The context which the object belongs to
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Group to retrieve.
    Domain string
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    Id string
    The ID of Group to retrieve.
    Context GetPolicyGroupContext
    The context which the object belongs to
    Description string
    The description of the resource.
    DisplayName string
    The Display Name prefix of the Group to retrieve.
    Domain string
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    Id string
    The ID of Group to retrieve.
    context GetPolicyGroupContext
    The context which the object belongs to
    description String
    The description of the resource.
    displayName String
    The Display Name prefix of the Group to retrieve.
    domain String
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    id String
    The ID of Group to retrieve.
    context GetPolicyGroupContext
    The context which the object belongs to
    description string
    The description of the resource.
    displayName string
    The Display Name prefix of the Group to retrieve.
    domain string
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    id string
    The ID of Group to retrieve.
    context GetPolicyGroupContext
    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.
    domain str
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    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.
    displayName String
    The Display Name prefix of the Group to retrieve.
    domain String
    The domain this Group belongs to. For VMware Cloud on AWS use cgw. For Global Manager, please use site id for this field. If not specified, this field is default to default.
    id String
    The ID of Group to retrieve.

    getPolicyGroup Result

    The following output properties are available:

    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Context GetPolicyGroupContext
    Domain string
    Description string
    The description of the resource.
    DisplayName string
    Id string
    Path string
    The NSX path of the policy resource.
    Context GetPolicyGroupContext
    Domain string
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    context GetPolicyGroupContext
    domain String
    description string
    The description of the resource.
    displayName string
    id string
    path string
    The NSX path of the policy resource.
    context GetPolicyGroupContext
    domain string
    description str
    The description of the resource.
    display_name str
    id str
    path str
    The NSX path of the policy resource.
    context GetPolicyGroupContext
    domain str
    description String
    The description of the resource.
    displayName String
    id String
    path String
    The NSX path of the policy resource.
    context Property Map
    domain String

    Supporting Types

    GetPolicyGroupContext

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId 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 logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt