Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nutanix
  3. API Docs
  4. UserGroupsV2
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.UserGroupsV2

Explore with Pulumi AI

nutanix logo
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    Provides a resource to add a User group to the system..

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as nutanix from "@pierskarsenbarg/nutanix";

const usrGroup = new nutanix.UserGroupsV2("usrGroup", {
    distinguishedName: "<distinguished name of the user group>",
    groupType: "<group Type>",
    idpId: "<idp uuid of user group>",
});

    import pulumi
import pulumi_nutanix as nutanix

usr_group = nutanix.UserGroupsV2("usrGroup",
    distinguished_name="<distinguished name of the user group>",
    group_type="<group Type>",
    idp_id="<idp uuid of user group>")

    package main

import (
	"github.com/pierskarsenbarg/pulumi-nutanix/sdk/go/nutanix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nutanix.NewUserGroupsV2(ctx, "usrGroup", &nutanix.UserGroupsV2Args{
			DistinguishedName: pulumi.String("<distinguished name of the user group>"),
			GroupType:         pulumi.String("<group Type>"),
			IdpId:             pulumi.String("<idp uuid of user group>"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = PiersKarsenbarg.Nutanix;

return await Deployment.RunAsync(() => 
{
    var usrGroup = new Nutanix.UserGroupsV2("usrGroup", new()
    {
        DistinguishedName = "<distinguished name of the user group>",
        GroupType = "<group Type>",
        IdpId = "<idp uuid of user group>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.UserGroupsV2;
import com.pulumi.nutanix.UserGroupsV2Args;
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) {
        var usrGroup = new UserGroupsV2("usrGroup", UserGroupsV2Args.builder()
            .distinguishedName("<distinguished name of the user group>")
            .groupType("<group Type>")
            .idpId("<idp uuid of user group>")
            .build());

    }
}

    resources:
  usrGroup:
    type: nutanix:UserGroupsV2
    properties:
      distinguishedName: <distinguished name of the user group>
      groupType: <group Type>
      idpId: <idp uuid of user group>

    Create UserGroupsV2 Resource

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

    Constructor syntax

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

@overload
def UserGroupsV2(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 group_type: Optional[str] = None,
                 idp_id: Optional[str] = None,
                 distinguished_name: Optional[str] = None,
                 ext_id: Optional[str] = None,
                 name: Optional[str] = None)
    func NewUserGroupsV2(ctx *Context, name string, args UserGroupsV2Args, opts ...ResourceOption) (*UserGroupsV2, error)
    public UserGroupsV2(string name, UserGroupsV2Args args, CustomResourceOptions? opts = null)
    public UserGroupsV2(String name, UserGroupsV2Args args)
public UserGroupsV2(String name, UserGroupsV2Args args, CustomResourceOptions options)

    type: nutanix:UserGroupsV2
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 UserGroupsV2Args
    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 UserGroupsV2Args
    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 UserGroupsV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserGroupsV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserGroupsV2Args
    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 userGroupsV2Resource = new Nutanix.UserGroupsV2("userGroupsV2Resource", new()
{
    GroupType = "string",
    IdpId = "string",
    DistinguishedName = "string",
    ExtId = "string",
    Name = "string",
});

    example, err := nutanix.NewUserGroupsV2(ctx, "userGroupsV2Resource", &nutanix.UserGroupsV2Args{
	GroupType:         pulumi.String("string"),
	IdpId:             pulumi.String("string"),
	DistinguishedName: pulumi.String("string"),
	ExtId:             pulumi.String("string"),
	Name:              pulumi.String("string"),
})

    var userGroupsV2Resource = new UserGroupsV2("userGroupsV2Resource", UserGroupsV2Args.builder()
    .groupType("string")
    .idpId("string")
    .distinguishedName("string")
    .extId("string")
    .name("string")
    .build());

    user_groups_v2_resource = nutanix.UserGroupsV2("userGroupsV2Resource",
    group_type="string",
    idp_id="string",
    distinguished_name="string",
    ext_id="string",
    name="string")

    const userGroupsV2Resource = new nutanix.UserGroupsV2("userGroupsV2Resource", {
    groupType: "string",
    idpId: "string",
    distinguishedName: "string",
    extId: "string",
    name: "string",
});

    type: nutanix:UserGroupsV2
properties:
    distinguishedName: string
    extId: string
    groupType: string
    idpId: string
    name: string

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

    GroupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    IdpId string
    -(Required) Identifier of the IDP for the User Group.
    DistinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    Name string
    -(Optional) Common Name of the User Group.
    GroupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    IdpId string
    -(Required) Identifier of the IDP for the User Group.
    DistinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    Name string
    -(Optional) Common Name of the User Group.
    groupType String
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId String
    -(Required) Identifier of the IDP for the User Group.
    distinguishedName String
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    name String
    -(Optional) Common Name of the User Group.
    groupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId string
    -(Required) Identifier of the IDP for the User Group.
    distinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId string
    The External Identifier of the User Group.
    name string
    -(Optional) Common Name of the User Group.
    group_type str
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idp_id str
    -(Required) Identifier of the IDP for the User Group.
    distinguished_name str
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ext_id str
    The External Identifier of the User Group.
    name str
    -(Optional) Common Name of the User Group.
    groupType String
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId String
    -(Required) Identifier of the IDP for the User Group.
    distinguishedName String
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    name String
    -(Optional) Common Name of the User Group.

    Outputs

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

    CreatedBy string
    • User or Service who created the User Group.
    CreatedTime string
    • Creation time of the User Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    • Last updated time of the User Group.
    CreatedBy string
    • User or Service who created the User Group.
    CreatedTime string
    • Creation time of the User Group.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    • Last updated time of the User Group.
    createdBy String
    • User or Service who created the User Group.
    createdTime String
    • Creation time of the User Group.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    • Last updated time of the User Group.
    createdBy string
    • User or Service who created the User Group.
    createdTime string
    • Creation time of the User Group.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    • Last updated time of the User Group.
    created_by str
    • User or Service who created the User Group.
    created_time str
    • Creation time of the User Group.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    • Last updated time of the User Group.
    createdBy String
    • User or Service who created the User Group.
    createdTime String
    • Creation time of the User Group.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    • Last updated time of the User Group.

    Look up Existing UserGroupsV2 Resource

    Get an existing UserGroupsV2 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?: UserGroupsV2State, opts?: CustomResourceOptions): UserGroupsV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_by: Optional[str] = None,
        created_time: Optional[str] = None,
        distinguished_name: Optional[str] = None,
        ext_id: Optional[str] = None,
        group_type: Optional[str] = None,
        idp_id: Optional[str] = None,
        last_updated_time: Optional[str] = None,
        name: Optional[str] = None) -> UserGroupsV2
    func GetUserGroupsV2(ctx *Context, name string, id IDInput, state *UserGroupsV2State, opts ...ResourceOption) (*UserGroupsV2, error)
    public static UserGroupsV2 Get(string name, Input<string> id, UserGroupsV2State? state, CustomResourceOptions? opts = null)
    public static UserGroupsV2 get(String name, Output<String> id, UserGroupsV2State state, CustomResourceOptions options)
    resources:  _:    type: nutanix:UserGroupsV2    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:
    CreatedBy string
    • User or Service who created the User Group.
    CreatedTime string
    • Creation time of the User Group.
    DistinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    GroupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    IdpId string
    -(Required) Identifier of the IDP for the User Group.
    LastUpdatedTime string
    • Last updated time of the User Group.
    Name string
    -(Optional) Common Name of the User Group.
    CreatedBy string
    • User or Service who created the User Group.
    CreatedTime string
    • Creation time of the User Group.
    DistinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    GroupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    IdpId string
    -(Required) Identifier of the IDP for the User Group.
    LastUpdatedTime string
    • Last updated time of the User Group.
    Name string
    -(Optional) Common Name of the User Group.
    createdBy String
    • User or Service who created the User Group.
    createdTime String
    • Creation time of the User Group.
    distinguishedName String
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    groupType String
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId String
    -(Required) Identifier of the IDP for the User Group.
    lastUpdatedTime String
    • Last updated time of the User Group.
    name String
    -(Optional) Common Name of the User Group.
    createdBy string
    • User or Service who created the User Group.
    createdTime string
    • Creation time of the User Group.
    distinguishedName string
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId string
    The External Identifier of the User Group.
    groupType string
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId string
    -(Required) Identifier of the IDP for the User Group.
    lastUpdatedTime string
    • Last updated time of the User Group.
    name string
    -(Optional) Common Name of the User Group.
    created_by str
    • User or Service who created the User Group.
    created_time str
    • Creation time of the User Group.
    distinguished_name str
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    ext_id str
    The External Identifier of the User Group.
    group_type str
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idp_id str
    -(Required) Identifier of the IDP for the User Group.
    last_updated_time str
    • Last updated time of the User Group.
    name str
    -(Optional) Common Name of the User Group.
    createdBy String
    • User or Service who created the User Group.
    createdTime String
    • Creation time of the User Group.
    distinguishedName String
    -(Optional) Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    groupType String
    -(Required) Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    idpId String
    -(Required) Identifier of the IDP for the User Group.
    lastUpdatedTime String
    • Last updated time of the User Group.
    name String
    -(Optional) Common Name of the User Group.

    Package Details

    Repository
    nutanix pierskarsenbarg/pulumi-nutanix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nutanix Terraform Provider.
    nutanix logo
    Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix