Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Powerscale Provider
  3. API Docs
  4. UserGroup
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

powerscale.UserGroup

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
dell/terraform-provider-powerscale

    This resource is used to manage the User Group entity of PowerScale Array. We can Create, Update and Delete the User Group using this resource. We can also import an existing User Group from PowerScale array. 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";

// PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
const testUserGroup = new powerscale.UserGroup("testUserGroup", {});

    import pulumi
import pulumi_powerscale as powerscale

# PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
test_user_group = powerscale.UserGroup("testUserGroup")

    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 {
		// PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
		_, err := powerscale.NewUserGroup(ctx, "testUserGroup", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Powerscale = Pulumi.Powerscale;

return await Deployment.RunAsync(() => 
{
    // PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
    var testUserGroup = new Powerscale.UserGroup("testUserGroup");

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.powerscale.UserGroup;
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) {
        // PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
        var testUserGroup = new UserGroup("testUserGroup");

    }
}

    resources:
  # PowerScale User Group allows you to do operations on a set of users, groups and well-knowns.
  testUserGroup:
    type: powerscale:UserGroup

    Create UserGroup Resource

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

    Constructor syntax

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

@overload
def UserGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              domain: Optional[str] = None,
              gid: Optional[float] = None,
              groups: Optional[Sequence[str]] = None,
              name: Optional[str] = None,
              query_force: Optional[bool] = None,
              query_provider: Optional[str] = None,
              query_zone: Optional[str] = None,
              roles: Optional[Sequence[str]] = None,
              sid: Optional[str] = None,
              users: Optional[Sequence[str]] = None,
              well_knowns: Optional[Sequence[str]] = None)
    func NewUserGroup(ctx *Context, name string, args *UserGroupArgs, opts ...ResourceOption) (*UserGroup, error)
    public UserGroup(string name, UserGroupArgs? args = null, CustomResourceOptions? opts = null)
    public UserGroup(String name, UserGroupArgs args)
public UserGroup(String name, UserGroupArgs args, CustomResourceOptions options)

    type: powerscale:UserGroup
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 UserGroupArgs
    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 UserGroupArgs
    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 UserGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserGroupArgs
    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 userGroupResource = new Powerscale.UserGroup("userGroupResource", new()
{
    Domain = "string",
    Gid = 0,
    Groups = new[]
    {
        "string",
    },
    Name = "string",
    QueryForce = false,
    QueryProvider = "string",
    QueryZone = "string",
    Roles = new[]
    {
        "string",
    },
    Sid = "string",
    Users = new[]
    {
        "string",
    },
    WellKnowns = new[]
    {
        "string",
    },
});

    example, err := powerscale.NewUserGroup(ctx, "userGroupResource", &powerscale.UserGroupArgs{
	Domain: pulumi.String("string"),
	Gid:    pulumi.Float64(0),
	Groups: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:          pulumi.String("string"),
	QueryForce:    pulumi.Bool(false),
	QueryProvider: pulumi.String("string"),
	QueryZone:     pulumi.String("string"),
	Roles: pulumi.StringArray{
		pulumi.String("string"),
	},
	Sid: pulumi.String("string"),
	Users: pulumi.StringArray{
		pulumi.String("string"),
	},
	WellKnowns: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var userGroupResource = new UserGroup("userGroupResource", UserGroupArgs.builder()
    .domain("string")
    .gid(0)
    .groups("string")
    .name("string")
    .queryForce(false)
    .queryProvider("string")
    .queryZone("string")
    .roles("string")
    .sid("string")
    .users("string")
    .wellKnowns("string")
    .build());

    user_group_resource = powerscale.UserGroup("userGroupResource",
    domain="string",
    gid=0,
    groups=["string"],
    name="string",
    query_force=False,
    query_provider="string",
    query_zone="string",
    roles=["string"],
    sid="string",
    users=["string"],
    well_knowns=["string"])

    const userGroupResource = new powerscale.UserGroup("userGroupResource", {
    domain: "string",
    gid: 0,
    groups: ["string"],
    name: "string",
    queryForce: false,
    queryProvider: "string",
    queryZone: "string",
    roles: ["string"],
    sid: "string",
    users: ["string"],
    wellKnowns: ["string"],
});

    type: powerscale:UserGroup
properties:
    domain: string
    gid: 0
    groups:
        - string
    name: string
    queryForce: false
    queryProvider: string
    queryZone: string
    roles:
        - string
    sid: string
    users:
        - string
    wellKnowns:
        - string

    UserGroup 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 UserGroup resource accepts the following input properties:

    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Gid double
    Specifies a numeric user group identifier.
    Groups List<string>
    Specifies list members of group within the group.
    Name string
    Specifies a user group name. Cannot be updated.
    QueryForce bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles List<string>
    List of roles, the user is assigned.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Users List<string>
    Specifies list members of user within the group.
    WellKnowns List<string>
    Specifies list members of well_known within the group.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    Gid float64
    Specifies a numeric user group identifier.
    Groups []string
    Specifies list members of group within the group.
    Name string
    Specifies a user group name. Cannot be updated.
    QueryForce bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles []string
    List of roles, the user is assigned.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Users []string
    Specifies list members of user within the group.
    WellKnowns []string
    Specifies list members of well_known within the group.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    gid Double
    Specifies a numeric user group identifier.
    groups List<String>
    Specifies list members of group within the group.
    name String
    Specifies a user group name. Cannot be updated.
    queryForce Boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    sid String
    Specifies a security identifier. Cannot be updated.
    users List<String>
    Specifies list members of user within the group.
    wellKnowns List<String>
    Specifies list members of well_known within the group.
    domain string
    Specifies the domain that the object is part of. Cannot be updated.
    gid number
    Specifies a numeric user group identifier.
    groups string[]
    Specifies list members of group within the group.
    name string
    Specifies a user group name. Cannot be updated.
    queryForce boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider string
    Specifies the provider type. Cannot be updated.
    queryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    roles string[]
    List of roles, the user is assigned.
    sid string
    Specifies a security identifier. Cannot be updated.
    users string[]
    Specifies list members of user within the group.
    wellKnowns string[]
    Specifies list members of well_known within the group.
    domain str
    Specifies the domain that the object is part of. Cannot be updated.
    gid float
    Specifies a numeric user group identifier.
    groups Sequence[str]
    Specifies list members of group within the group.
    name str
    Specifies a user group name. Cannot be updated.
    query_force bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    query_provider str
    Specifies the provider type. Cannot be updated.
    query_zone str
    Specifies the zone that the object belongs to. Cannot be updated.
    roles Sequence[str]
    List of roles, the user is assigned.
    sid str
    Specifies a security identifier. Cannot be updated.
    users Sequence[str]
    Specifies list members of user within the group.
    well_knowns Sequence[str]
    Specifies list members of well_known within the group.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    gid Number
    Specifies a numeric user group identifier.
    groups List<String>
    Specifies list members of group within the group.
    name String
    Specifies a user group name. Cannot be updated.
    queryForce Boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    sid String
    Specifies a security identifier. Cannot be updated.
    users List<String>
    Specifies list members of user within the group.
    wellKnowns List<String>
    Specifies list members of well_known within the group.

    Outputs

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

    Dn string
    Specifies a principal name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    GeneratedGid bool
    If true, the GID was generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user group name.
    Type string
    Specifies the object type.
    Dn string
    Specifies a principal name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    GeneratedGid bool
    If true, the GID was generated.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    SamAccountName string
    Specifies a user group name.
    Type string
    Specifies the object type.
    dn String
    Specifies a principal name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    generatedGid Boolean
    If true, the GID was generated.
    id String
    The provider-assigned unique ID for this managed resource.
    providerName String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user group name.
    type String
    Specifies the object type.
    dn string
    Specifies a principal name for the user group.
    dnsDomain string
    Specifies the DNS domain.
    generatedGid boolean
    If true, the GID was generated.
    id string
    The provider-assigned unique ID for this managed resource.
    providerName string
    Specifies the authentication provider that the object belongs to.
    samAccountName string
    Specifies a user group name.
    type string
    Specifies the object type.
    dn str
    Specifies a principal name for the user group.
    dns_domain str
    Specifies the DNS domain.
    generated_gid bool
    If true, the GID was generated.
    id str
    The provider-assigned unique ID for this managed resource.
    provider_name str
    Specifies the authentication provider that the object belongs to.
    sam_account_name str
    Specifies a user group name.
    type str
    Specifies the object type.
    dn String
    Specifies a principal name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    generatedGid Boolean
    If true, the GID was generated.
    id String
    The provider-assigned unique ID for this managed resource.
    providerName String
    Specifies the authentication provider that the object belongs to.
    samAccountName String
    Specifies a user group name.
    type String
    Specifies the object type.

    Look up Existing UserGroup Resource

    Get an existing UserGroup 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?: UserGroupState, opts?: CustomResourceOptions): UserGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dn: Optional[str] = None,
        dns_domain: Optional[str] = None,
        domain: Optional[str] = None,
        generated_gid: Optional[bool] = None,
        gid: Optional[float] = None,
        groups: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        provider_name: Optional[str] = None,
        query_force: Optional[bool] = None,
        query_provider: Optional[str] = None,
        query_zone: Optional[str] = None,
        roles: Optional[Sequence[str]] = None,
        sam_account_name: Optional[str] = None,
        sid: Optional[str] = None,
        type: Optional[str] = None,
        users: Optional[Sequence[str]] = None,
        well_knowns: Optional[Sequence[str]] = None) -> UserGroup
    func GetUserGroup(ctx *Context, name string, id IDInput, state *UserGroupState, opts ...ResourceOption) (*UserGroup, error)
    public static UserGroup Get(string name, Input<string> id, UserGroupState? state, CustomResourceOptions? opts = null)
    public static UserGroup get(String name, Output<String> id, UserGroupState state, CustomResourceOptions options)
    resources:  _:    type: powerscale:UserGroup    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:
    Dn string
    Specifies a principal name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    GeneratedGid bool
    If true, the GID was generated.
    Gid double
    Specifies a numeric user group identifier.
    Groups List<string>
    Specifies list members of group within the group.
    Name string
    Specifies a user group name. Cannot be updated.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    QueryForce bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles List<string>
    List of roles, the user is assigned.
    SamAccountName string
    Specifies a user group name.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Type string
    Specifies the object type.
    Users List<string>
    Specifies list members of user within the group.
    WellKnowns List<string>
    Specifies list members of well_known within the group.
    Dn string
    Specifies a principal name for the user group.
    DnsDomain string
    Specifies the DNS domain.
    Domain string
    Specifies the domain that the object is part of. Cannot be updated.
    GeneratedGid bool
    If true, the GID was generated.
    Gid float64
    Specifies a numeric user group identifier.
    Groups []string
    Specifies list members of group within the group.
    Name string
    Specifies a user group name. Cannot be updated.
    ProviderName string
    Specifies the authentication provider that the object belongs to.
    QueryForce bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    QueryProvider string
    Specifies the provider type. Cannot be updated.
    QueryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    Roles []string
    List of roles, the user is assigned.
    SamAccountName string
    Specifies a user group name.
    Sid string
    Specifies a security identifier. Cannot be updated.
    Type string
    Specifies the object type.
    Users []string
    Specifies list members of user within the group.
    WellKnowns []string
    Specifies list members of well_known within the group.
    dn String
    Specifies a principal name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    generatedGid Boolean
    If true, the GID was generated.
    gid Double
    Specifies a numeric user group identifier.
    groups List<String>
    Specifies list members of group within the group.
    name String
    Specifies a user group name. Cannot be updated.
    providerName String
    Specifies the authentication provider that the object belongs to.
    queryForce Boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    samAccountName String
    Specifies a user group name.
    sid String
    Specifies a security identifier. Cannot be updated.
    type String
    Specifies the object type.
    users List<String>
    Specifies list members of user within the group.
    wellKnowns List<String>
    Specifies list members of well_known within the group.
    dn string
    Specifies a principal name for the user group.
    dnsDomain string
    Specifies the DNS domain.
    domain string
    Specifies the domain that the object is part of. Cannot be updated.
    generatedGid boolean
    If true, the GID was generated.
    gid number
    Specifies a numeric user group identifier.
    groups string[]
    Specifies list members of group within the group.
    name string
    Specifies a user group name. Cannot be updated.
    providerName string
    Specifies the authentication provider that the object belongs to.
    queryForce boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider string
    Specifies the provider type. Cannot be updated.
    queryZone string
    Specifies the zone that the object belongs to. Cannot be updated.
    roles string[]
    List of roles, the user is assigned.
    samAccountName string
    Specifies a user group name.
    sid string
    Specifies a security identifier. Cannot be updated.
    type string
    Specifies the object type.
    users string[]
    Specifies list members of user within the group.
    wellKnowns string[]
    Specifies list members of well_known within the group.
    dn str
    Specifies a principal name for the user group.
    dns_domain str
    Specifies the DNS domain.
    domain str
    Specifies the domain that the object is part of. Cannot be updated.
    generated_gid bool
    If true, the GID was generated.
    gid float
    Specifies a numeric user group identifier.
    groups Sequence[str]
    Specifies list members of group within the group.
    name str
    Specifies a user group name. Cannot be updated.
    provider_name str
    Specifies the authentication provider that the object belongs to.
    query_force bool
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    query_provider str
    Specifies the provider type. Cannot be updated.
    query_zone str
    Specifies the zone that the object belongs to. Cannot be updated.
    roles Sequence[str]
    List of roles, the user is assigned.
    sam_account_name str
    Specifies a user group name.
    sid str
    Specifies a security identifier. Cannot be updated.
    type str
    Specifies the object type.
    users Sequence[str]
    Specifies list members of user within the group.
    well_knowns Sequence[str]
    Specifies list members of well_known within the group.
    dn String
    Specifies a principal name for the user group.
    dnsDomain String
    Specifies the DNS domain.
    domain String
    Specifies the domain that the object is part of. Cannot be updated.
    generatedGid Boolean
    If true, the GID was generated.
    gid Number
    Specifies a numeric user group identifier.
    groups List<String>
    Specifies list members of group within the group.
    name String
    Specifies a user group name. Cannot be updated.
    providerName String
    Specifies the authentication provider that the object belongs to.
    queryForce Boolean
    If true, skip validation checks when creating user group. Need to be true, when changing group GID.
    queryProvider String
    Specifies the provider type. Cannot be updated.
    queryZone String
    Specifies the zone that the object belongs to. Cannot be updated.
    roles List<String>
    List of roles, the user is assigned.
    samAccountName String
    Specifies a user group name.
    sid String
    Specifies a security identifier. Cannot be updated.
    type String
    Specifies the object type.
    users List<String>
    Specifies list members of user within the group.
    wellKnowns List<String>
    Specifies list members of well_known within the group.

    Import

    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.

    The command is

    $ pulumi import powerscale:index/userGroup:UserGroup testUserGroup [<zoneID>:]<userGroupName>

    Example1, is Optional, defaults to System:

    $ pulumi import powerscale:index/userGroup:UserGroup testUserGroup userGroupName

    Example2:

    $ pulumi import powerscale:index/userGroup:UserGroup testUserGroup zoneID:userGroupName

    after running this command, populate the name field and other required parameters in the config file to start managing this resource.

    Note: running “terraform show” after importing shows the current config/state of the resource. You can copy/paste that config to make it easier to manage the resource.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell
    dell/terraform-provider-powerscale