nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
nsxt.getNsGroup
Explore with Pulumi AI
This data source provides information about a network and security (NS) group in NSX. A NS group is used to group other objects into collections for application of other settings.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const nsGroup1 = nsxt.getNsGroup({
displayName: "test group",
});
import pulumi
import pulumi_nsxt as nsxt
ns_group1 = nsxt.get_ns_group(display_name="test group")
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.LookupNsGroup(ctx, &nsxt.LookupNsGroupArgs{
DisplayName: pulumi.StringRef("test group"),
}, 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 nsGroup1 = Nsxt.GetNsGroup.Invoke(new()
{
DisplayName = "test group",
});
});
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.GetNsGroupArgs;
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 nsGroup1 = NsxtFunctions.getNsGroup(GetNsGroupArgs.builder()
.displayName("test group")
.build());
}
}
variables:
nsGroup1:
fn::invoke:
function: nsxt:getNsGroup
arguments:
displayName: test group
Using getNsGroup
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 getNsGroup(args: GetNsGroupArgs, opts?: InvokeOptions): Promise<GetNsGroupResult>
function getNsGroupOutput(args: GetNsGroupOutputArgs, opts?: InvokeOptions): Output<GetNsGroupResult>
def get_ns_group(description: Optional[str] = None,
display_name: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNsGroupResult
def get_ns_group_output(description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNsGroupResult]
func LookupNsGroup(ctx *Context, args *LookupNsGroupArgs, opts ...InvokeOption) (*LookupNsGroupResult, error)
func LookupNsGroupOutput(ctx *Context, args *LookupNsGroupOutputArgs, opts ...InvokeOption) LookupNsGroupResultOutput
> Note: This function is named LookupNsGroup
in the Go SDK.
public static class GetNsGroup
{
public static Task<GetNsGroupResult> InvokeAsync(GetNsGroupArgs args, InvokeOptions? opts = null)
public static Output<GetNsGroupResult> Invoke(GetNsGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNsGroupResult> getNsGroup(GetNsGroupArgs args, InvokeOptions options)
public static Output<GetNsGroupResult> getNsGroup(GetNsGroupArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getNsGroup:getNsGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Description string
- The description of the NS group.
- Display
Name string - The Display Name of the NS group to retrieve.
- Id string
- The ID of NS group to retrieve
- Description string
- The description of the NS group.
- Display
Name string - The Display Name of the NS group to retrieve.
- Id string
- The ID of NS group to retrieve
- description String
- The description of the NS group.
- display
Name String - The Display Name of the NS group to retrieve.
- id String
- The ID of NS group to retrieve
- description string
- The description of the NS group.
- display
Name string - The Display Name of the NS group to retrieve.
- id string
- The ID of NS group to retrieve
- description str
- The description of the NS group.
- display_
name str - The Display Name of the NS group to retrieve.
- id str
- The ID of NS group to retrieve
- description String
- The description of the NS group.
- display
Name String - The Display Name of the NS group to retrieve.
- id String
- The ID of NS group to retrieve
getNsGroup Result
The following output properties are available:
- Description string
- The description of the NS group.
- Display
Name string - Id string
- Description string
- The description of the NS group.
- Display
Name string - Id string
- description String
- The description of the NS group.
- display
Name String - id String
- description string
- The description of the NS group.
- display
Name string - id string
- description str
- The description of the NS group.
- display_
name str - id str
- description String
- The description of the NS group.
- display
Name String - id String
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.