import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Provides a datasource to retrieve a user group based on the input parameters. * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * //Retrieve by UUID * const usergroup = nutanix.getUserGroup({ * userGroupId: "dd30a856-8e72-4158-b716-98455ceda220", * }); * //Retrieve by Name * const usergroupbyname = nutanix.getUserGroup({ * userGroupName: "example-group-1", * }); * //Retrieve by Distinguished Name * const test = nutanix.getUserGroup({ * userGroupDistinguishedName: "cn=example-group-1,cn=users,dc=ntnxlab,dc=local", * }); * ``` * */ export declare function getUserGroup(args?: GetUserGroupArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getUserGroup. */ export interface GetUserGroupArgs { /** * - The Distinguished Categories for the user group. */ categories?: inputs.GetUserGroupCategory[]; /** * - The reference to a user. */ ownerReference?: { [key: string]: string; }; /** * - The Distinguished The reference to a project. */ projectReference?: { [key: string]: string; }; /** * The distinguished name for the user group */ userGroupDistinguishedName?: string; /** * - (Optional) The UUID for the user group */ userGroupId?: string; /** * - (Optional) The name for the user group */ userGroupName?: string; } /** * A collection of values returned by getUserGroup. */ export interface GetUserGroupResult { /** * - List of ACP references. See #reference for more details. */ readonly accessControlPolicyReferenceLists: outputs.GetUserGroupAccessControlPolicyReferenceList[]; /** * The version of the API. */ readonly apiVersion: string; /** * - The Distinguished Categories for the user group. */ readonly categories: outputs.GetUserGroupCategory[]; /** * - A Directory Service User Group. */ readonly directoryServiceUserGroups: outputs.GetUserGroupDirectoryServiceUserGroup[]; /** * - The display name of the user group. */ readonly displayName: string; /** * The provider-assigned unique ID for this managed resource. */ readonly id: string; /** * - The user group kind metadata. */ readonly metadata: { [key: string]: string; }; /** * - The reference to a user. */ readonly ownerReference: { [key: string]: string; }; /** * - The Distinguished The reference to a project. */ readonly projectReference?: { [key: string]: string; }; /** * - A list of projects the user is part of. See #reference for more details. */ readonly projectReferenceLists: outputs.GetUserGroupProjectReferenceList[]; /** * - The state of the entity. */ readonly state: string; readonly userGroupDistinguishedName?: string; readonly userGroupId?: string; readonly userGroupName?: string; /** * - The type of the user group. */ readonly userGroupType: string; } /** * Provides a datasource to retrieve a user group based on the input parameters. * * ## Example Usage * * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as nutanix from "@pierskarsenbarg/nutanix"; * * //Retrieve by UUID * const usergroup = nutanix.getUserGroup({ * userGroupId: "dd30a856-8e72-4158-b716-98455ceda220", * }); * //Retrieve by Name * const usergroupbyname = nutanix.getUserGroup({ * userGroupName: "example-group-1", * }); * //Retrieve by Distinguished Name * const test = nutanix.getUserGroup({ * userGroupDistinguishedName: "cn=example-group-1,cn=users,dc=ntnxlab,dc=local", * }); * ``` * */ export declare function getUserGroupOutput(args?: GetUserGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getUserGroup. */ export interface GetUserGroupOutputArgs { /** * - The Distinguished Categories for the user group. */ categories?: pulumi.Input[] | undefined>; /** * - The reference to a user. */ ownerReference?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * - The Distinguished The reference to a project. */ projectReference?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The distinguished name for the user group */ userGroupDistinguishedName?: pulumi.Input; /** * - (Optional) The UUID for the user group */ userGroupId?: pulumi.Input; /** * - (Optional) The name for the user group */ userGroupName?: pulumi.Input; } //# sourceMappingURL=getUserGroup.d.ts.map