nutanix.getUserGroups
Explore with Pulumi AI
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, &nutanix.LookupUserGroupsArgs{}, 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)
public static Output<GetUserGroupsResult> getUserGroups(GetUserGroupsArgs args, InvokeOptions options)
fn::invoke:
function: nutanix:index/getUserGroups:getUserGroups
arguments:
# arguments dictionary
The following arguments are supported:
- Metadatas
List<Piers
Karsenbarg. Nutanix. Inputs. Get User Groups Metadata> - The user group kind metadata.
- Metadatas
[]Get
User Groups Metadata - The user group kind metadata.
- metadatas
List<Get
User Groups Metadata> - The user group kind metadata.
- metadatas
Get
User Groups Metadata[] - The user group kind metadata.
- metadatas
Sequence[Get
User Groups Metadata] - The user group kind metadata.
- metadatas List<Property Map>
- The user group kind metadata.
getUserGroups Result
The following output properties are available:
- Api
Version string - Entities
List<Piers
Karsenbarg. Nutanix. Outputs. Get User Groups Entity> - Id string
- The provider-assigned unique ID for this managed resource.
- Metadatas
List<Piers
Karsenbarg. Nutanix. Outputs. Get User Groups Metadata>
- Api
Version string - Entities
[]Get
User Groups Entity - Id string
- The provider-assigned unique ID for this managed resource.
- Metadatas
[]Get
User Groups Metadata
- api
Version String - entities
List<Get
User Groups Entity> - id String
- The provider-assigned unique ID for this managed resource.
- metadatas
List<Get
User Groups Metadata>
- api
Version string - entities
Get
User Groups Entity[] - id string
- The provider-assigned unique ID for this managed resource.
- metadatas
Get
User Groups Metadata[]
- api_
version str - entities
Sequence[Get
User Groups Entity] - id str
- The provider-assigned unique ID for this managed resource.
- metadatas
Sequence[Get
User Groups Metadata]
- api
Version String - entities List<Property Map>
- id String
- The provider-assigned unique ID for this managed resource.
- metadatas List<Property Map>
Supporting Types
GetUserGroupsEntity
- Access
Control Policy Reference Lists This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get User Groups Entity Access Control Policy Reference List> - List of ACP references. See #reference for more details.
- Api
Version This property is required. string - The version of the API.
- Categories
This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get User Groups Entity Category> - The Categories for the user group.
- Directory
Service User Groups This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get User Groups Entity Directory Service User Group> - A Directory Service User Group.
- Display
Name 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.
- Owner
Reference This property is required. Dictionary<string, string> - The reference to a user.
- Project
Reference Lists This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get User Groups Entity Project Reference List> - 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.
- User
Group Type This property is required. string - The type of the user group.
- Project
Reference Dictionary<string, string> - The reference to a project.
- Access
Control Policy Reference Lists This property is required. []GetUser Groups Entity Access Control Policy Reference List - List of ACP references. See #reference for more details.
- Api
Version This property is required. string - The version of the API.
- Categories
This property is required. []GetUser Groups Entity Category - The Categories for the user group.
- Directory
Service User Groups This property is required. []GetUser Groups Entity Directory Service User Group - A Directory Service User Group.
- Display
Name 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.
- Owner
Reference This property is required. map[string]string - The reference to a user.
- Project
Reference Lists This property is required. []GetUser Groups Entity Project Reference List - 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.
- User
Group Type This property is required. string - The type of the user group.
- Project
Reference map[string]string - The reference to a project.
- access
Control Policy Reference Lists This property is required. List<GetUser Groups Entity Access Control Policy Reference List> - List of ACP references. See #reference for more details.
- api
Version This property is required. String - The version of the API.
- categories
This property is required. List<GetUser Groups Entity Category> - The Categories for the user group.
- directory
Service User Groups This property is required. List<GetUser Groups Entity Directory Service User Group> - A Directory Service User Group.
- display
Name 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.
- owner
Reference This property is required. Map<String,String> - The reference to a user.
- project
Reference Lists This property is required. List<GetUser Groups Entity Project Reference List> - 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.
- user
Group Type This property is required. String - The type of the user group.
- project
Reference Map<String,String> - The reference to a project.
- access
Control Policy Reference Lists This property is required. GetUser Groups Entity Access Control Policy Reference List[] - List of ACP references. See #reference for more details.
- api
Version This property is required. string - The version of the API.
- categories
This property is required. GetUser Groups Entity Category[] - The Categories for the user group.
- directory
Service User Groups This property is required. GetUser Groups Entity Directory Service User Group[] - A Directory Service User Group.
- display
Name 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.
- owner
Reference This property is required. {[key: string]: string} - The reference to a user.
- project
Reference Lists This property is required. GetUser Groups Entity Project Reference List[] - 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.
- user
Group Type This property is required. string - The type of the user group.
- project
Reference {[key: string]: string} - The reference to a project.
- access_
control_ policy_ reference_ lists This property is required. Sequence[GetUser Groups Entity Access Control Policy Reference List] - 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[GetUser Groups Entity Category] - The Categories for the user group.
- directory_
service_ user_ groups This property is required. Sequence[GetUser Groups Entity Directory Service User Group] - 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[GetUser Groups Entity Project Reference List] - 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.
- access
Control Policy Reference Lists This property is required. List<Property Map> - List of ACP references. See #reference for more details.
- api
Version This property is required. String - The version of the API.
- categories
This property is required. List<Property Map> - The Categories for the user group.
- directory
Service User Groups This property is required. List<Property Map> - A Directory Service User Group.
- display
Name This property is required. String - The display name of the user group.
- metadata
This property is required. Map<String> - The user group kind metadata.
- owner
Reference This property is required. Map<String> - The reference to a user.
- project
Reference Lists 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.
- user
Group Type This property is required. String - The type of the user group.
- project
Reference Map<String> - The reference to a project.
GetUserGroupsEntityAccessControlPolicyReferenceList
GetUserGroupsEntityCategory
GetUserGroupsEntityDirectoryServiceUserGroup
- Default
User Principal Name This property is required. string - Directory
Service References This property is required. List<PiersKarsenbarg. Nutanix. Inputs. Get User Groups Entity Directory Service User Group Directory Service Reference> - The reference to a directory service. See #reference for to look the supported attributes.
- Distinguished
Name This property is required. string - The Distinguished name for the user group
- Default
User Principal Name This property is required. string - Directory
Service References This property is required. []GetUser Groups Entity Directory Service User Group Directory Service Reference - The reference to a directory service. See #reference for to look the supported attributes.
- Distinguished
Name This property is required. string - The Distinguished name for the user group
- default
User Principal Name This property is required. String - directory
Service References This property is required. List<GetUser Groups Entity Directory Service User Group Directory Service Reference> - The reference to a directory service. See #reference for to look the supported attributes.
- distinguished
Name This property is required. String - The Distinguished name for the user group
- default
User Principal Name This property is required. string - directory
Service References This property is required. GetUser Groups Entity Directory Service User Group Directory Service Reference[] - The reference to a directory service. See #reference for to look the supported attributes.
- distinguished
Name 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[GetUser Groups Entity Directory Service User Group Directory Service Reference] - 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
- default
User Principal Name This property is required. String - directory
Service References This property is required. List<Property Map> - The reference to a directory service. See #reference for to look the supported attributes.
- distinguished
Name 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
andproject_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
andproject_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
andproject_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
andproject_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
andproject_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
andproject_reference_list
are the same as reference but used as list.See detailed information in Nutanix Users.
GetUserGroupsEntityProjectReferenceList
GetUserGroupsMetadata
- 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
Package Details
- Repository
- nutanix pierskarsenbarg/pulumi-nutanix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
nutanix
Terraform Provider.