1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getUserGroup
powerscale 1.7.0 published on Monday, Apr 14, 2025 by dell

powerscale.getUserGroup

Explore with Pulumi AI

powerscale 1.7.0 published on Monday, Apr 14, 2025 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.

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>
Copy
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]
Copy
func LookupUserGroup(ctx *Context, args *LookupUserGroupArgs, opts ...InvokeOption) (*LookupUserGroupResult, error)
func LookupUserGroupOutput(ctx *Context, args *LookupUserGroupOutputArgs, opts ...InvokeOption) LookupUserGroupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
public static Output<GetUserGroupResult> getUserGroup(GetUserGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: powerscale:index/getUserGroup:getUserGroup
  arguments:
    # arguments dictionary
Copy

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

GetUserGroupUserGroupMember

Id This property is required. string
Specifies a user or group id.
Name This property is required. string
Specifies a user or group name.
Type This property is required. string
Specifies the object type.
Id This property is required. string
Specifies a user or group id.
Name This property is required. string
Specifies a user or group name.
Type This property is required. string
Specifies the object type.
id This property is required. String
Specifies a user or group id.
name This property is required. String
Specifies a user or group name.
type This property is required. String
Specifies the object type.
id This property is required. string
Specifies a user or group id.
name This property is required. string
Specifies a user or group name.
type This property is required. string
Specifies the object type.
id This property is required. str
Specifies a user or group id.
name This property is required. str
Specifies a user or group name.
type This property is required. str
Specifies the object type.
id This property is required. String
Specifies a user or group id.
name This property is required. String
Specifies a user or group name.
type This property is required. 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.
powerscale 1.7.0 published on Monday, Apr 14, 2025 by dell