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

nutanix.getUserGroupV2

Explore with Pulumi AI

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

    Provides a datasource to retrieve a user group based on the External Identifier of the User Group.

    Example Usage

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

const usergroup = nutanix.getUserGroupV2({
    extId: "<External Identifier of the User Group.>",
});

    import pulumi
import pulumi_nutanix as nutanix

usergroup = nutanix.get_user_group_v2(ext_id="<External Identifier of the 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.GetUserGroupV2(ctx, &nutanix.GetUserGroupV2Args{
			ExtId: "<External Identifier of the User Group.>",
		}, 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 usergroup = Nutanix.GetUserGroupV2.Invoke(new()
    {
        ExtId = "<External Identifier of the User Group.>",
    });

});

    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.GetUserGroupV2Args;
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 usergroup = NutanixFunctions.getUserGroupV2(GetUserGroupV2Args.builder()
            .extId("<External Identifier of the User Group.>")
            .build());

    }
}

    variables:
  usergroup:
    fn::invoke:
      function: nutanix:getUserGroupV2
      arguments:
        extId: <External Identifier of the User Group.>

    Using getUserGroupV2

    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 getUserGroupV2(args: GetUserGroupV2Args, opts?: InvokeOptions): Promise<GetUserGroupV2Result>
function getUserGroupV2Output(args: GetUserGroupV2OutputArgs, opts?: InvokeOptions): Output<GetUserGroupV2Result>
    def get_user_group_v2(ext_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetUserGroupV2Result
def get_user_group_v2_output(ext_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetUserGroupV2Result]
    func GetUserGroupV2(ctx *Context, args *GetUserGroupV2Args, opts ...InvokeOption) (*GetUserGroupV2Result, error)
func GetUserGroupV2Output(ctx *Context, args *GetUserGroupV2OutputArgs, opts ...InvokeOption) GetUserGroupV2ResultOutput

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

    public static class GetUserGroupV2 
{
    public static Task<GetUserGroupV2Result> InvokeAsync(GetUserGroupV2Args args, InvokeOptions? opts = null)
    public static Output<GetUserGroupV2Result> Invoke(GetUserGroupV2InvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetUserGroupV2Result> getUserGroupV2(GetUserGroupV2Args args, InvokeOptions options)
public static Output<GetUserGroupV2Result> getUserGroupV2(GetUserGroupV2Args args, InvokeOptions options)

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

    The following arguments are supported:

    ExtId string
    • (Required) The External Identifier of the User Group.
    ExtId string
    • (Required) The External Identifier of the User Group.
    extId String
    • (Required) The External Identifier of the User Group.
    extId string
    • (Required) The External Identifier of the User Group.
    ext_id str
    • (Required) The External Identifier of the User Group.
    extId String
    • (Required) The External Identifier of the User Group.

    getUserGroupV2 Result

    The following output properties are available:

    CreatedBy string
    • User or Service who created the User Group.
    CreatedTime string
    • Creation time of the User Group.
    DistinguishedName string
    • Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    GroupType string
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpId string
    • Identifier of the IDP for the User Group.
    LastUpdatedTime string
    • Last updated time of the User Group.
    Name string
    • 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
    • Identifier for the User Group in the form of a distinguished name.
    ExtId string
    The External Identifier of the User Group.
    GroupType string
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpId string
    • Identifier of the IDP for the User Group.
    LastUpdatedTime string
    • Last updated time of the User Group.
    Name string
    • 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
    • Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    groupType String
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    id String
    The provider-assigned unique ID for this managed resource.
    idpId String
    • Identifier of the IDP for the User Group.
    lastUpdatedTime String
    • Last updated time of the User Group.
    name String
    • 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
    • Identifier for the User Group in the form of a distinguished name.
    extId string
    The External Identifier of the User Group.
    groupType string
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    id string
    The provider-assigned unique ID for this managed resource.
    idpId string
    • Identifier of the IDP for the User Group.
    lastUpdatedTime string
    • Last updated time of the User Group.
    name string
    • 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
    • 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
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    id str
    The provider-assigned unique ID for this managed resource.
    idp_id str
    • Identifier of the IDP for the User Group.
    last_updated_time str
    • Last updated time of the User Group.
    name str
    • 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
    • Identifier for the User Group in the form of a distinguished name.
    extId String
    The External Identifier of the User Group.
    groupType String
    • Type of the User Group. LDAP (User Group belonging to a Directory Service (Open LDAP/AD)), SAML (User Group belonging to a SAML IDP.)
    id String
    The provider-assigned unique ID for this managed resource.
    idpId String
    • Identifier of the IDP for the User Group.
    lastUpdatedTime String
    • Last updated time of the User Group.
    name String
    • 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