Docs Packages
  1. Packages
  2. Nutanix
  3. API Docs
  4. getUserGroups
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

nutanix.getUserGroups

Explore with Pulumi AI

nutanix logo
Nutanix v0.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
pierskarsenbarg/pulumi-nutanix

    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({});

    import pulumi
import pulumi_nutanix as nutanix

usergroups = nutanix.get_user_groups()

    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, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

});

    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();

    }
}

    variables:
  usergroups:
    fn::invoke:
      Function: nutanix:getUserGroups
      Arguments: {}

    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>
    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]
    func LookupUserGroups(ctx *Context, args *LookupUserGroupsArgs, opts ...InvokeOption) (*LookupUserGroupsResult, error)
func LookupUserGroupsOutput(ctx *Context, args *LookupUserGroupsOutputArgs, opts ...InvokeOption) LookupUserGroupsResultOutput

    > 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)
}
    public static CompletableFuture<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: nutanix:index/getUserGroups:getUserGroups
  arguments:
    # arguments dictionary

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

    GetUserGroupsEntityAccessControlPolicyReferenceList

    Kind string
    Name string
    Uuid string
    Kind string
    Name string
    Uuid string
    kind String
    name String
    uuid String
    kind string
    name string
    uuid string
    kind str
    name str
    uuid str
    kind String
    name String
    uuid String

    GetUserGroupsEntityCategory

    Name string
    • the key name.
    Value string
    • value of the key.
    Name string
    • the key name.
    Value string
    • value of the key.
    name String
    • the key name.
    value String
    • value of the key.
    name string
    • the key name.
    value string
    • value of the key.
    name str
    • the key name.
    value str
    • value of the key.
    name String
    • the key name.
    value String
    • value of the key.

    GetUserGroupsEntityDirectoryServiceUserGroup

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

    GetUserGroupsEntityDirectoryServiceUserGroupDirectoryServiceReference

    Kind string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • the name(Optional).
    Uuid 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 string
    • The kind name. (Default depends on the resource you are referencing)
    Name string
    • the name(Optional).
    Uuid 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 String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • the name(Optional).
    uuid 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 string
    • The kind name. (Default depends on the resource you are referencing)
    name string
    • the name(Optional).
    uuid 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 str
    • The kind name. (Default depends on the resource you are referencing)
    name str
    • the name(Optional).
    uuid 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 String
    • The kind name. (Default depends on the resource you are referencing)
    name String
    • the name(Optional).
    uuid 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 string
    Name string
    Uuid string
    Kind string
    Name string
    Uuid string
    kind String
    name String
    uuid String
    kind string
    name string
    uuid string
    kind str
    name str
    uuid str
    kind String
    name String
    uuid String

    GetUserGroupsMetadata

    Filter string
    Kind string
    Length int
    Offset int
    SortAttribute string
    SortOrder string
    Filter string
    Kind string
    Length int
    Offset int
    SortAttribute string
    SortOrder string
    filter String
    kind String
    length Integer
    offset Integer
    sortAttribute String
    sortOrder String
    filter string
    kind string
    length number
    offset number
    sortAttribute string
    sortOrder string
    filter String
    kind String
    length Number
    offset Number
    sortAttribute String
    sortOrder String

    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.0.52 published on Friday, Jun 7, 2024 by Piers Karsenbarg
    pierskarsenbarg/pulumi-nutanix