1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getUserGroup
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell
Viewing docs for powerscale 1.8.1
published on Wednesday, Apr 1, 2026 by dell

    This datasource is used to query the existing User Groups from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as powerscale from "@pulumi/powerscale";
    
    //Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    //
    //Licensed under the Mozilla Public License Version 2.0 (the "License");
    //you may not use this file except in compliance with the License.
    //You may obtain a copy of the License at
    //
    //    http://mozilla.org/MPL/2.0/
    //
    //
    //Unless required by applicable law or agreed to in writing, software
    //distributed under the License is distributed on an "AS IS" BASIS,
    //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    //See the License for the specific language governing permissions and
    //limitations under the License.
    // PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
    // Returns a list of PowerScale User Groups based on gid or name in names filter block. 
    const testUserGroup = powerscale.getUserGroup({
        filter: {
            names: [{
                name: "tfaccUserGroupDatasource",
                gid: 10000,
            }],
            cached: false,
            namePrefix: "tfacc",
        },
    });
    export const powerscaleUserGroupFilter = testUserGroup;
    
    import pulumi
    import pulumi_powerscale as powerscale
    
    #Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    #
    #Licensed under the Mozilla Public License Version 2.0 (the "License");
    #you may not use this file except in compliance with the License.
    #You may obtain a copy of the License at
    #
    #    http://mozilla.org/MPL/2.0/
    #
    #
    #Unless required by applicable law or agreed to in writing, software
    #distributed under the License is distributed on an "AS IS" BASIS,
    #WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    #See the License for the specific language governing permissions and
    #limitations under the License.
    # PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
    # Returns a list of PowerScale User Groups based on gid or name in names filter block. 
    test_user_group = powerscale.get_user_group(filter={
        "names": [{
            "name": "tfaccUserGroupDatasource",
            "gid": 10000,
        }],
        "cached": False,
        "name_prefix": "tfacc",
    })
    pulumi.export("powerscaleUserGroupFilter", test_user_group)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    		//
    		// Licensed under the Mozilla Public License Version 2.0 (the "License");
    		// you may not use this file except in compliance with the License.
    		// You may obtain a copy of the License at
    		//
    		//	http://mozilla.org/MPL/2.0/
    		//
    		// Unless required by applicable law or agreed to in writing, software
    		// distributed under the License is distributed on an "AS IS" BASIS,
    		// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    		// See the License for the specific language governing permissions and
    		// limitations under the License.
    		// PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
    		// Returns a list of PowerScale User Groups based on gid or name in names filter block.
    		testUserGroup, err := powerscale.LookupUserGroup(ctx, &powerscale.LookupUserGroupArgs{
    			Filter: powerscale.GetUserGroupFilter{
    				Names: []powerscale.GetUserGroupFilterName{
    					{
    						Name: pulumi.StringRef("tfaccUserGroupDatasource"),
    						Gid:  pulumi.Float64Ref(10000),
    					},
    				},
    				Cached:     pulumi.BoolRef(false),
    				NamePrefix: pulumi.StringRef("tfacc"),
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("powerscaleUserGroupFilter", testUserGroup)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerscale = Pulumi.Powerscale;
    
    return await Deployment.RunAsync(() => 
    {
        //Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
        //
        //Licensed under the Mozilla Public License Version 2.0 (the "License");
        //you may not use this file except in compliance with the License.
        //You may obtain a copy of the License at
        //
        //    http://mozilla.org/MPL/2.0/
        //
        //
        //Unless required by applicable law or agreed to in writing, software
        //distributed under the License is distributed on an "AS IS" BASIS,
        //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        //See the License for the specific language governing permissions and
        //limitations under the License.
        // PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
        // Returns a list of PowerScale User Groups based on gid or name in names filter block. 
        var testUserGroup = Powerscale.GetUserGroup.Invoke(new()
        {
            Filter = new Powerscale.Inputs.GetUserGroupFilterInputArgs
            {
                Names = new[]
                {
                    new Powerscale.Inputs.GetUserGroupFilterNameInputArgs
                    {
                        Name = "tfaccUserGroupDatasource",
                        Gid = 10000,
                    },
                },
                Cached = false,
                NamePrefix = "tfacc",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["powerscaleUserGroupFilter"] = testUserGroup,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.PowerscaleFunctions;
    import com.pulumi.powerscale.inputs.GetUserGroupArgs;
    import com.pulumi.powerscale.inputs.GetUserGroupFilterArgs;
    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) {
            //Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
            //
            //Licensed under the Mozilla Public License Version 2.0 (the "License");
            //you may not use this file except in compliance with the License.
            //You may obtain a copy of the License at
            //
            //    http://mozilla.org/MPL/2.0/
            //
            //
            //Unless required by applicable law or agreed to in writing, software
            //distributed under the License is distributed on an "AS IS" BASIS,
            //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
            //See the License for the specific language governing permissions and
            //limitations under the License.
            // PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
            // Returns a list of PowerScale User Groups based on gid or name in names filter block. 
            final var testUserGroup = PowerscaleFunctions.getUserGroup(GetUserGroupArgs.builder()
                .filter(GetUserGroupFilterArgs.builder()
                    .names(GetUserGroupFilterNameArgs.builder()
                        .name("tfaccUserGroupDatasource")
                        .gid(10000)
                        .build())
                    .cached(false)
                    .namePrefix("tfacc")
                    .build())
                .build());
    
            ctx.export("powerscaleUserGroupFilter", testUserGroup);
        }
    }
    
    variables:
      # /*
      # Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.
    
      # Licensed under the Mozilla Public License Version 2.0 (the "License");
      # you may not use this file except in compliance with the License.
      # You may obtain a copy of the License at
    
      #     http://mozilla.org/MPL/2.0/
    
    
      # Unless required by applicable law or agreed to in writing, software
      # distributed under the License is distributed on an "AS IS" BASIS,
      # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      # See the License for the specific language governing permissions and
      # limitations under the License.
      # */
    
    
      # PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
    
      # Returns a list of PowerScale User Groups based on gid or name in names filter block.
      testUserGroup:
        fn::invoke:
          function: powerscale:getUserGroup
          arguments:
            filter:
              names:
                - name: tfaccUserGroupDatasource
                  gid: 10000
              cached: false
              namePrefix: tfacc
    outputs:
      # Output value of above block by executing 'terraform output' command.
      # The user can use the fetched information by the variable data.powerscale_user_group.test_user_group
      powerscaleUserGroupFilter: ${testUserGroup}
    

    Using getUserGroup

    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 getUserGroup(args: GetUserGroupArgs, opts?: InvokeOptions): Promise<GetUserGroupResult>
    function getUserGroupOutput(args: GetUserGroupOutputArgs, opts?: InvokeOptions): Output<GetUserGroupResult>
    def get_user_group(filter: Optional[GetUserGroupFilter] = None,
                       opts: Optional[InvokeOptions] = None) -> GetUserGroupResult
    def get_user_group_output(filter: Optional[pulumi.Input[GetUserGroupFilterArgs]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupResult]
    func LookupUserGroup(ctx *Context, args *LookupUserGroupArgs, opts ...InvokeOption) (*LookupUserGroupResult, error)
    func LookupUserGroupOutput(ctx *Context, args *LookupUserGroupOutputArgs, opts ...InvokeOption) LookupUserGroupResultOutput

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

    public static class GetUserGroup 
    {
        public static Task<GetUserGroupResult> InvokeAsync(GetUserGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetUserGroupResult> Invoke(GetUserGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
    public static Output<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getUserGroup:getUserGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getUserGroup Result

    The following output properties are available:

    Id string
    Unique identifier of the user group instance.
    UserGroups List<GetUserGroupUserGroup>
    List of user groups.
    Filter GetUserGroupFilter
    Id string
    Unique identifier of the user group instance.
    UserGroups []GetUserGroupUserGroup
    List of user groups.
    Filter GetUserGroupFilter
    id String
    Unique identifier of the user group instance.
    userGroups List<GetUserGroupUserGroup>
    List of user groups.
    filter GetUserGroupFilter
    id string
    Unique identifier of the user group instance.
    userGroups GetUserGroupUserGroup[]
    List of user groups.
    filter GetUserGroupFilter
    id str
    Unique identifier of the user group instance.
    user_groups Sequence[GetUserGroupUserGroup]
    List of user groups.
    filter GetUserGroupFilter
    id String
    Unique identifier of the user group instance.
    userGroups List<Property Map>
    List of user groups.
    filter Property Map

    Supporting Types

    GetUserGroupFilter

    Cached bool
    If true, only return cached objects.
    Domain string
    Filter user groups by domain.
    NamePrefix string
    Filter user groups by name prefix.
    Names List<GetUserGroupFilterName>
    List of user group identity.
    Provider string
    Filter user groups by provider.
    Zone string
    Filter user groups by zone.
    Cached bool
    If true, only return cached objects.
    Domain string
    Filter user groups by domain.
    NamePrefix string
    Filter user groups by name prefix.
    Names []GetUserGroupFilterName
    List of user group identity.
    Provider string
    Filter user groups by provider.
    Zone string
    Filter user groups by zone.
    cached Boolean
    If true, only return cached objects.
    domain String
    Filter user groups by domain.
    namePrefix String
    Filter user groups by name prefix.
    names List<GetUserGroupFilterName>
    List of user group identity.
    provider String
    Filter user groups by provider.
    zone String
    Filter user groups by zone.
    cached boolean
    If true, only return cached objects.
    domain string
    Filter user groups by domain.
    namePrefix string
    Filter user groups by name prefix.
    names GetUserGroupFilterName[]
    List of user group identity.
    provider string
    Filter user groups by provider.
    zone string
    Filter user groups by zone.
    cached bool
    If true, only return cached objects.
    domain str
    Filter user groups by domain.
    name_prefix str
    Filter user groups by name prefix.
    names Sequence[GetUserGroupFilterName]
    List of user group identity.
    provider str
    Filter user groups by provider.
    zone str
    Filter user groups by zone.
    cached Boolean
    If true, only return cached objects.
    domain String
    Filter user groups by domain.
    namePrefix String
    Filter user groups by name prefix.
    names List<Property Map>
    List of user group identity.
    provider String
    Filter user groups by provider.
    zone String
    Filter user groups by zone.

    GetUserGroupFilterName

    Gid double
    Specifies a numeric user group identifier.
    Name string
    Specifies a user group name.
    Gid float64
    Specifies a numeric user group identifier.
    Name string
    Specifies a user group name.
    gid Double
    Specifies a numeric user group identifier.
    name String
    Specifies a user group name.
    gid number
    Specifies a numeric user group identifier.
    name string
    Specifies a user group name.
    gid float
    Specifies a numeric user group identifier.
    name str
    Specifies a user group name.
    gid Number
    Specifies a numeric user group identifier.
    name String
    Specifies a user group name.

    GetUserGroupUserGroup

    Dn string
    Specifies the distinguished name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of.
    GeneratedGid bool
    If true, the GID was generated.
    Gid string
    Specifies a user group identifier.
    Id string
    Specifies the user group ID.
    Members List<GetUserGroupUserGroupMember>
    List of members of group. Group Member can be user or group.
    Name string
    Specifies a user group name.
    Provider string
    Specifies the authentication provider that the object belongs to.
    Roles List<string>
    List of roles.
    SamAccountName string
    Specifies a user group name.
    Sid string
    Specifies a security identifier.
    Type string
    Specifies the object type.
    Dn string
    Specifies the distinguished name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of.
    GeneratedGid bool
    If true, the GID was generated.
    Gid string
    Specifies a user group identifier.
    Id string
    Specifies the user group ID.
    Members []GetUserGroupUserGroupMember
    List of members of group. Group Member can be user or group.
    Name string
    Specifies a user group name.
    Provider string
    Specifies the authentication provider that the object belongs to.
    Roles []string
    List of roles.
    SamAccountName string
    Specifies a user group name.
    Sid string
    Specifies a security identifier.
    Type string
    Specifies the object type.
    dn String
    Specifies the distinguished name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of.
    generatedGid Boolean
    If true, the GID was generated.
    gid String
    Specifies a user group identifier.
    id String
    Specifies the user group ID.
    members List<GetUserGroupUserGroupMember>
    List of members of group. Group Member can be user or group.
    name String
    Specifies a user group name.
    provider String
    Specifies the authentication provider that the object belongs to.
    roles List<String>
    List of roles.
    samAccountName String
    Specifies a user group name.
    sid String
    Specifies a security identifier.
    type String
    Specifies the object type.
    dn string
    Specifies the distinguished name for the user group.
    dnsDomain string
    Specifies the DNS domain.
    domain string
    Specifies the domain that the object is part of.
    generatedGid boolean
    If true, the GID was generated.
    gid string
    Specifies a user group identifier.
    id string
    Specifies the user group ID.
    members GetUserGroupUserGroupMember[]
    List of members of group. Group Member can be user or group.
    name string
    Specifies a user group name.
    provider string
    Specifies the authentication provider that the object belongs to.
    roles string[]
    List of roles.
    samAccountName string
    Specifies a user group name.
    sid string
    Specifies a security identifier.
    type string
    Specifies the object type.
    dn str
    Specifies the distinguished name for the user group.
    dns_domain str
    Specifies the DNS domain.
    domain str
    Specifies the domain that the object is part of.
    generated_gid bool
    If true, the GID was generated.
    gid str
    Specifies a user group identifier.
    id str
    Specifies the user group ID.
    members Sequence[GetUserGroupUserGroupMember]
    List of members of group. Group Member can be user or group.
    name str
    Specifies a user group name.
    provider str
    Specifies the authentication provider that the object belongs to.
    roles Sequence[str]
    List of roles.
    sam_account_name str
    Specifies a user group name.
    sid str
    Specifies a security identifier.
    type str
    Specifies the object type.
    dn String
    Specifies the distinguished name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of.
    generatedGid Boolean
    If true, the GID was generated.
    gid String
    Specifies a user group identifier.
    id String
    Specifies the user group ID.
    members List<Property Map>
    List of members of group. Group Member can be user or group.
    name String
    Specifies a user group name.
    provider String
    Specifies the authentication provider that the object belongs to.
    roles List<String>
    List of roles.
    samAccountName String
    Specifies a user group name.
    sid String
    Specifies a security identifier.
    type String
    Specifies the object type.

    GetUserGroupUserGroupMember

    Id string
    Specifies a user or group id.
    Name string
    Specifies a user or group name.
    Type string
    Specifies the object type.
    Id string
    Specifies a user or group id.
    Name string
    Specifies a user or group name.
    Type string
    Specifies the object type.
    id String
    Specifies a user or group id.
    name String
    Specifies a user or group name.
    type String
    Specifies the object type.
    id string
    Specifies a user or group id.
    name string
    Specifies a user or group name.
    type string
    Specifies the object type.
    id str
    Specifies a user or group id.
    name str
    Specifies a user or group name.
    type str
    Specifies the object type.
    id String
    Specifies a user or group id.
    name String
    Specifies a user or group name.
    type String
    Specifies the object type.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    Viewing docs for powerscale 1.8.1
    published on Wednesday, Apr 1, 2026 by dell
      Try Pulumi Cloud free. Your team will thank you.