1. Packages
  2. Nutanix
  3. API Docs
  4. getUserGroups
Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

nutanix.getUserGroups

Explore with Pulumi AI

Nutanix v0.7.4 published on Friday, Mar 21, 2025 by Piers Karsenbarg

Provides a datasource to retrieve all the user groups.

Example Usage

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

const usergroups = nutanix.getUserGroups({});
Copy
import pulumi
import pulumi_nutanix as nutanix

usergroups = nutanix.get_user_groups()
Copy
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.LookupUserGroups(ctx, &nutanix.LookupUserGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nutanix = Pulumi.Nutanix;

return await Deployment.RunAsync(() => 
{
    var usergroups = Nutanix.GetUserGroups.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nutanix.NutanixFunctions;
import com.pulumi.nutanix.inputs.GetUserGroupsArgs;
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 usergroups = NutanixFunctions.getUserGroups();

    }
}
Copy
variables:
  usergroups:
    fn::invoke:
      function: nutanix:getUserGroups
      arguments: {}
Copy

Using getUserGroups

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 getUserGroups(args: GetUserGroupsArgs, opts?: InvokeOptions): Promise<GetUserGroupsResult>
function getUserGroupsOutput(args: GetUserGroupsOutputArgs, opts?: InvokeOptions): Output<GetUserGroupsResult>
Copy
def get_user_groups(metadatas: Optional[Sequence[GetUserGroupsMetadata]] = None,
                    opts: Optional[InvokeOptions] = None) -> GetUserGroupsResult
def get_user_groups_output(metadatas: Optional[pulumi.Input[Sequence[pulumi.Input[GetUserGroupsMetadataArgs]]]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupsResult]
Copy
func LookupUserGroups(ctx *Context, args *LookupUserGroupsArgs, opts ...InvokeOption) (*LookupUserGroupsResult, error)
func LookupUserGroupsOutput(ctx *Context, args *LookupUserGroupsOutputArgs, opts ...InvokeOption) LookupUserGroupsResultOutput
Copy

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

public static class GetUserGroups 
{
    public static Task<GetUserGroupsResult> InvokeAsync(GetUserGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetUserGroupsResult> Invoke(GetUserGroupsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
public static Output<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nutanix:index/getUserGroups:getUserGroups
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Metadatas []GetUserGroupsMetadata
  • The user group kind metadata.
metadatas List<GetUserGroupsMetadata>
  • The user group kind metadata.
metadatas GetUserGroupsMetadata[]
  • The user group kind metadata.
metadatas Sequence[GetUserGroupsMetadata]
  • The user group kind metadata.
metadatas List<Property Map>
  • The user group kind metadata.

getUserGroups Result

The following output properties are available:

ApiVersion string
Entities []GetUserGroupsEntity
Id string
The provider-assigned unique ID for this managed resource.
Metadatas []GetUserGroupsMetadata
apiVersion String
entities List<GetUserGroupsEntity>
id String
The provider-assigned unique ID for this managed resource.
metadatas List<GetUserGroupsMetadata>
apiVersion string
entities GetUserGroupsEntity[]
id string
The provider-assigned unique ID for this managed resource.
metadatas GetUserGroupsMetadata[]
api_version str
entities Sequence[GetUserGroupsEntity]
id str
The provider-assigned unique ID for this managed resource.
metadatas Sequence[GetUserGroupsMetadata]
apiVersion String
entities List<Property Map>
id String
The provider-assigned unique ID for this managed resource.
metadatas List<Property Map>

Supporting Types

GetUserGroupsEntity

AccessControlPolicyReferenceLists This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetUserGroupsEntityAccessControlPolicyReferenceList>
  • List of ACP references. See #reference for more details.
ApiVersion This property is required. string
The version of the API.
Categories This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetUserGroupsEntityCategory>
  • The Categories for the user group.
DirectoryServiceUserGroups This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetUserGroupsEntityDirectoryServiceUserGroup>
  • A Directory Service User Group.
DisplayName This property is required. string
  • The display name of the user group.
Metadata This property is required. Dictionary<string, string>
  • The user group kind metadata.
OwnerReference This property is required. Dictionary<string, string>
  • The reference to a user.
ProjectReferenceLists This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetUserGroupsEntityProjectReferenceList>
  • A list of projects the user is part of. See #reference for more details.
State This property is required. string
  • The state of the entity.
UserGroupType This property is required. string
  • The type of the user group.
ProjectReference Dictionary<string, string>
  • The reference to a project.
AccessControlPolicyReferenceLists This property is required. []GetUserGroupsEntityAccessControlPolicyReferenceList
  • List of ACP references. See #reference for more details.
ApiVersion This property is required. string
The version of the API.
Categories This property is required. []GetUserGroupsEntityCategory
  • The Categories for the user group.
DirectoryServiceUserGroups This property is required. []GetUserGroupsEntityDirectoryServiceUserGroup
  • A Directory Service User Group.
DisplayName This property is required. string
  • The display name of the user group.
Metadata This property is required. map[string]string
  • The user group kind metadata.
OwnerReference This property is required. map[string]string
  • The reference to a user.
ProjectReferenceLists This property is required. []GetUserGroupsEntityProjectReferenceList
  • A list of projects the user is part of. See #reference for more details.
State This property is required. string
  • The state of the entity.
UserGroupType This property is required. string
  • The type of the user group.
ProjectReference map[string]string
  • The reference to a project.
accessControlPolicyReferenceLists This property is required. List<GetUserGroupsEntityAccessControlPolicyReferenceList>
  • List of ACP references. See #reference for more details.
apiVersion This property is required. String
The version of the API.
categories This property is required. List<GetUserGroupsEntityCategory>
  • The Categories for the user group.
directoryServiceUserGroups This property is required. List<GetUserGroupsEntityDirectoryServiceUserGroup>
  • A Directory Service User Group.
displayName This property is required. String
  • The display name of the user group.
metadata This property is required. Map<String,String>
  • The user group kind metadata.
ownerReference This property is required. Map<String,String>
  • The reference to a user.
projectReferenceLists This property is required. List<GetUserGroupsEntityProjectReferenceList>
  • A list of projects the user is part of. See #reference for more details.
state This property is required. String
  • The state of the entity.
userGroupType This property is required. String
  • The type of the user group.
projectReference Map<String,String>
  • The reference to a project.
accessControlPolicyReferenceLists This property is required. GetUserGroupsEntityAccessControlPolicyReferenceList[]
  • List of ACP references. See #reference for more details.
apiVersion This property is required. string
The version of the API.
categories This property is required. GetUserGroupsEntityCategory[]
  • The Categories for the user group.
directoryServiceUserGroups This property is required. GetUserGroupsEntityDirectoryServiceUserGroup[]
  • A Directory Service User Group.
displayName This property is required. string
  • The display name of the user group.
metadata This property is required. {[key: string]: string}
  • The user group kind metadata.
ownerReference This property is required. {[key: string]: string}
  • The reference to a user.
projectReferenceLists This property is required. GetUserGroupsEntityProjectReferenceList[]
  • A list of projects the user is part of. See #reference for more details.
state This property is required. string
  • The state of the entity.
userGroupType This property is required. string
  • The type of the user group.
projectReference {[key: string]: string}
  • The reference to a project.
access_control_policy_reference_lists This property is required. Sequence[GetUserGroupsEntityAccessControlPolicyReferenceList]
  • List of ACP references. See #reference for more details.
api_version This property is required. str
The version of the API.
categories This property is required. Sequence[GetUserGroupsEntityCategory]
  • The Categories for the user group.
directory_service_user_groups This property is required. Sequence[GetUserGroupsEntityDirectoryServiceUserGroup]
  • A Directory Service User Group.
display_name This property is required. str
  • The display name of the user group.
metadata This property is required. Mapping[str, str]
  • The user group kind metadata.
owner_reference This property is required. Mapping[str, str]
  • The reference to a user.
project_reference_lists This property is required. Sequence[GetUserGroupsEntityProjectReferenceList]
  • A list of projects the user is part of. See #reference for more details.
state This property is required. str
  • The state of the entity.
user_group_type This property is required. str
  • The type of the user group.
project_reference Mapping[str, str]
  • The reference to a project.
accessControlPolicyReferenceLists This property is required. List<Property Map>
  • List of ACP references. See #reference for more details.
apiVersion This property is required. String
The version of the API.
categories This property is required. List<Property Map>
  • The Categories for the user group.
directoryServiceUserGroups This property is required. List<Property Map>
  • A Directory Service User Group.
displayName This property is required. String
  • The display name of the user group.
metadata This property is required. Map<String>
  • The user group kind metadata.
ownerReference This property is required. Map<String>
  • The reference to a user.
projectReferenceLists This property is required. List<Property Map>
  • A list of projects the user is part of. See #reference for more details.
state This property is required. String
  • The state of the entity.
userGroupType This property is required. String
  • The type of the user group.
projectReference Map<String>
  • The reference to a project.

GetUserGroupsEntityAccessControlPolicyReferenceList

Kind This property is required. string
Name This property is required. string
Uuid This property is required. string
Kind This property is required. string
Name This property is required. string
Uuid This property is required. string
kind This property is required. String
name This property is required. String
uuid This property is required. String
kind This property is required. string
name This property is required. string
uuid This property is required. string
kind This property is required. str
name This property is required. str
uuid This property is required. str
kind This property is required. String
name This property is required. String
uuid This property is required. String

GetUserGroupsEntityCategory

Name This property is required. string
  • the key name.
Value This property is required. string
  • value of the key.
Name This property is required. string
  • the key name.
Value This property is required. string
  • value of the key.
name This property is required. String
  • the key name.
value This property is required. String
  • value of the key.
name This property is required. string
  • the key name.
value This property is required. string
  • value of the key.
name This property is required. str
  • the key name.
value This property is required. str
  • value of the key.
name This property is required. String
  • the key name.
value This property is required. String
  • value of the key.

GetUserGroupsEntityDirectoryServiceUserGroup

DefaultUserPrincipalName This property is required. string
DirectoryServiceReferences This property is required. List<PiersKarsenbarg.Nutanix.Inputs.GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference>
  • The reference to a directory service. See #reference for to look the supported attributes.
DistinguishedName This property is required. string
  • The Distinguished name for the user group
DefaultUserPrincipalName This property is required. string
DirectoryServiceReferences This property is required. []GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference
  • The reference to a directory service. See #reference for to look the supported attributes.
DistinguishedName This property is required. string
  • The Distinguished name for the user group
defaultUserPrincipalName This property is required. String
directoryServiceReferences This property is required. List<GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference>
  • The reference to a directory service. See #reference for to look the supported attributes.
distinguishedName This property is required. String
  • The Distinguished name for the user group
defaultUserPrincipalName This property is required. string
directoryServiceReferences This property is required. GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference[]
  • The reference to a directory service. See #reference for to look the supported attributes.
distinguishedName This property is required. string
  • The Distinguished name for the user group
default_user_principal_name This property is required. str
directory_service_references This property is required. Sequence[GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference]
  • The reference to a directory service. See #reference for to look the supported attributes.
distinguished_name This property is required. str
  • The Distinguished name for the user group
defaultUserPrincipalName This property is required. String
directoryServiceReferences This property is required. List<Property Map>
  • The reference to a directory service. See #reference for to look the supported attributes.
distinguishedName This property is required. String
  • The Distinguished name for the user group

GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference

Kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • the name(Optional).
Uuid This property is required. string
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

Kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
Name This property is required. string
  • the name(Optional).
Uuid This property is required. string
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • the name(Optional).
uuid This property is required. String
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

kind This property is required. string
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. string
  • the name(Optional).
uuid This property is required. string
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

kind This property is required. str
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. str
  • the name(Optional).
uuid This property is required. str
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

kind This property is required. String
  • The kind name. (Default depends on the resource you are referencing)
name This property is required. String
  • the name(Optional).
uuid This property is required. String
  • the UUID(Required).

For access_control_policy_reference_list and project_reference_list are the same as reference but used as list.

See detailed information in Nutanix Users.

GetUserGroupsEntityProjectReferenceList

Kind This property is required. string
Name This property is required. string
Uuid This property is required. string
Kind This property is required. string
Name This property is required. string
Uuid This property is required. string
kind This property is required. String
name This property is required. String
uuid This property is required. String
kind This property is required. string
name This property is required. string
uuid This property is required. string
kind This property is required. str
name This property is required. str
uuid This property is required. str
kind This property is required. String
name This property is required. String
uuid This property is required. String

GetUserGroupsMetadata

Filter This property is required. string
Kind This property is required. string
Length This property is required. int
Offset This property is required. int
SortAttribute This property is required. string
SortOrder This property is required. string
Filter This property is required. string
Kind This property is required. string
Length This property is required. int
Offset This property is required. int
SortAttribute This property is required. string
SortOrder This property is required. string
filter This property is required. String
kind This property is required. String
length This property is required. Integer
offset This property is required. Integer
sortAttribute This property is required. String
sortOrder This property is required. String
filter This property is required. string
kind This property is required. string
length This property is required. number
offset This property is required. number
sortAttribute This property is required. string
sortOrder This property is required. string
filter This property is required. str
kind This property is required. str
length This property is required. int
offset This property is required. int
sort_attribute This property is required. str
sort_order This property is required. str
filter This property is required. String
kind This property is required. String
length This property is required. Number
offset This property is required. Number
sortAttribute This property is required. String
sortOrder This property is required. String

Package Details

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