Nutanix v0.7.4, Mar 21 25

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

nutanix.getDirectoryServicesV2

Explore with Pulumi AI

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

Example Usage

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

const example = nutanix.getDirectoryServicesV2({});

import pulumi
import pulumi_nutanix as nutanix

example = nutanix.get_directory_services_v2()

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.LookupDirectoryServicesV2(ctx, &nutanix.LookupDirectoryServicesV2Args{}, 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 example = Nutanix.GetDirectoryServicesV2.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.GetDirectoryServicesV2Args;
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 example = NutanixFunctions.getDirectoryServicesV2();

    }
}

variables:
  example:
    fn::invoke:
      function: nutanix:getDirectoryServicesV2
      arguments: {}

Using getDirectoryServicesV2

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 getDirectoryServicesV2(args: GetDirectoryServicesV2Args, opts?: InvokeOptions): Promise<GetDirectoryServicesV2Result>
function getDirectoryServicesV2Output(args: GetDirectoryServicesV2OutputArgs, opts?: InvokeOptions): Output<GetDirectoryServicesV2Result>

def get_directory_services_v2(filter: Optional[str] = None,
                              limit: Optional[int] = None,
                              order_by: Optional[str] = None,
                              page: Optional[int] = None,
                              select: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDirectoryServicesV2Result
def get_directory_services_v2_output(filter: Optional[pulumi.Input[str]] = None,
                              limit: Optional[pulumi.Input[int]] = None,
                              order_by: Optional[pulumi.Input[str]] = None,
                              page: Optional[pulumi.Input[int]] = None,
                              select: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDirectoryServicesV2Result]

func LookupDirectoryServicesV2(ctx *Context, args *LookupDirectoryServicesV2Args, opts ...InvokeOption) (*LookupDirectoryServicesV2Result, error)
func LookupDirectoryServicesV2Output(ctx *Context, args *LookupDirectoryServicesV2OutputArgs, opts ...InvokeOption) LookupDirectoryServicesV2ResultOutput

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

public static class GetDirectoryServicesV2 
{
    public static Task<GetDirectoryServicesV2Result> InvokeAsync(GetDirectoryServicesV2Args args, InvokeOptions? opts = null)
    public static Output<GetDirectoryServicesV2Result> Invoke(GetDirectoryServicesV2InvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDirectoryServicesV2Result> getDirectoryServicesV2(GetDirectoryServicesV2Args args, InvokeOptions options)
public static Output<GetDirectoryServicesV2Result> getDirectoryServicesV2(GetDirectoryServicesV2Args args, InvokeOptions options)

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

The following arguments are supported:

Filter string: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
Limit int: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
OrderBy string: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
Page int: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
Select string: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

Filter string: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
Limit int: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
OrderBy string: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
Page int: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
Select string: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

filter String: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
limit Integer: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
orderBy String: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
page Integer: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
select String: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

filter string: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
limit number: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
orderBy string: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
page number: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
select string: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

filter str: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
limit int: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
order_by str: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
page int: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
select str: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

filter String: -(Optional) A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions. For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'. The filter can be applied to the following fields: createdBy, domainName, extId, name
limit Number: -(Optional) A URL query parameter that specifies the total number of records returned in the result set. Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
orderBy String: -(Optional) A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order. The orderby can be applied to the following fields: createdTime, domainName, lastUpdatedTime, name
page Number: -(Optional) A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
select String: -(Optional) A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned. it can be applied to the following fields: createdBy, createdTime, directoryType, domainName, extId, groupSearchType, lastUpdatedTime, links, name, openLdapConfiguration/userConfiguration, openLdapConfiguration/userGroupConfiguration, secondaryUrls, serviceAccount/password, serviceAccount/username, tenantId, url, whiteListedGroups

getDirectoryServicesV2 Result

The following output properties are available:

DirectoryServices List<PiersKarsenbarg.Nutanix.Outputs.GetDirectoryServicesV2DirectoryService>

list of all Directory Service(s).

Id string

The provider-assigned unique ID for this managed resource.

Filter string

Limit int

OrderBy string

Page int

Select string

DirectoryServices []GetDirectoryServicesV2DirectoryService

list of all Directory Service(s).

Id string

The provider-assigned unique ID for this managed resource.

Filter string

Limit int

OrderBy string

Page int

Select string

directoryServices List<GetDirectoryServicesV2DirectoryService>

list of all Directory Service(s).

id String

The provider-assigned unique ID for this managed resource.

filter String

limit Integer

orderBy String

page Integer

select String

directoryServices GetDirectoryServicesV2DirectoryService[]

list of all Directory Service(s).

id string

The provider-assigned unique ID for this managed resource.

filter string

limit number

orderBy string

page number

select string

directory_services Sequence[GetDirectoryServicesV2DirectoryService]

list of all Directory Service(s).

id str

The provider-assigned unique ID for this managed resource.

filter str

limit int

order_by str

page int

select str

directoryServices List<Property Map>

list of all Directory Service(s).

id String

The provider-assigned unique ID for this managed resource.

filter String

limit Number

orderBy String

page Number

select String

Supporting Types

GetDirectoryServicesV2DirectoryService

CreatedBy string

User or Service who created the Directory Service.

CreatedTime string

Creation time of the Directory Service.

DirectoryType string

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

DomainName string

Domain name for the Directory Service.

ExtId string

A globally unique identifier of an instance that is suitable for external consumption.

GroupSearchType string

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

LastUpdatedTime string

Last updated time of the Directory Service.

Name string

Name for the Directory Service.

OpenLdapConfigurations List<PiersKarsenbarg.Nutanix.Inputs.GetDirectoryServicesV2DirectoryServiceOpenLdapConfiguration>

Configuration for OpenLDAP Directory Service.

SecondaryUrls List<string>

Secondary URL for the Directory Service.

ServiceAccounts List<PiersKarsenbarg.Nutanix.Inputs.GetDirectoryServicesV2DirectoryServiceServiceAccount>

Information of Service account to connect to the Directory Service.

Url string

URL for the Directory Service.

WhiteListedGroups List<string>

List of allowed User Groups for the Directory Service.

CreatedBy string

User or Service who created the Directory Service.

CreatedTime string

Creation time of the Directory Service.

DirectoryType string

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

DomainName string

Domain name for the Directory Service.

ExtId string

A globally unique identifier of an instance that is suitable for external consumption.

GroupSearchType string

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

LastUpdatedTime string

Last updated time of the Directory Service.

Name string

Name for the Directory Service.

OpenLdapConfigurations []GetDirectoryServicesV2DirectoryServiceOpenLdapConfiguration

Configuration for OpenLDAP Directory Service.

SecondaryUrls []string

Secondary URL for the Directory Service.

ServiceAccounts []GetDirectoryServicesV2DirectoryServiceServiceAccount

Information of Service account to connect to the Directory Service.

Url string

URL for the Directory Service.

WhiteListedGroups []string

List of allowed User Groups for the Directory Service.

createdBy String

User or Service who created the Directory Service.

createdTime String

Creation time of the Directory Service.

directoryType String

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

domainName String

Domain name for the Directory Service.

extId String

A globally unique identifier of an instance that is suitable for external consumption.

groupSearchType String

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

lastUpdatedTime String

Last updated time of the Directory Service.

name String

Name for the Directory Service.

openLdapConfigurations List<GetDirectoryServicesV2DirectoryServiceOpenLdapConfiguration>

Configuration for OpenLDAP Directory Service.

secondaryUrls List<String>

Secondary URL for the Directory Service.

serviceAccounts List<GetDirectoryServicesV2DirectoryServiceServiceAccount>

Information of Service account to connect to the Directory Service.

url String

URL for the Directory Service.

whiteListedGroups List<String>

List of allowed User Groups for the Directory Service.

createdBy string

User or Service who created the Directory Service.

createdTime string

Creation time of the Directory Service.

directoryType string

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

domainName string

Domain name for the Directory Service.

extId string

A globally unique identifier of an instance that is suitable for external consumption.

groupSearchType string

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

lastUpdatedTime string

Last updated time of the Directory Service.

name string

Name for the Directory Service.

openLdapConfigurations GetDirectoryServicesV2DirectoryServiceOpenLdapConfiguration[]

Configuration for OpenLDAP Directory Service.

secondaryUrls string[]

Secondary URL for the Directory Service.

serviceAccounts GetDirectoryServicesV2DirectoryServiceServiceAccount[]

Information of Service account to connect to the Directory Service.

url string

URL for the Directory Service.

whiteListedGroups string[]

List of allowed User Groups for the Directory Service.

created_by str

User or Service who created the Directory Service.

created_time str

Creation time of the Directory Service.

directory_type str

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

domain_name str

Domain name for the Directory Service.

ext_id str

A globally unique identifier of an instance that is suitable for external consumption.

group_search_type str

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

last_updated_time str

Last updated time of the Directory Service.

name str

Name for the Directory Service.

open_ldap_configurations Sequence[GetDirectoryServicesV2DirectoryServiceOpenLdapConfiguration]

Configuration for OpenLDAP Directory Service.

secondary_urls Sequence[str]

Secondary URL for the Directory Service.

service_accounts Sequence[GetDirectoryServicesV2DirectoryServiceServiceAccount]

Information of Service account to connect to the Directory Service.

url str

URL for the Directory Service.

white_listed_groups Sequence[str]

List of allowed User Groups for the Directory Service.

createdBy String

User or Service who created the Directory Service.

createdTime String

Creation time of the Directory Service.

directoryType String

Type of Directory Service, Supported values are: "ACTIVE_DIRECTORY" (Directory Service type is Active Directory.) and "OPEN_LDAP" (Directory Service type is Open LDAP.)

domainName String

Domain name for the Directory Service.

extId String

A globally unique identifier of an instance that is suitable for external consumption.

groupSearchType String

Group membership search type for the Directory Service. Supported values are: "NON_RECURSIVE" (Doesn't search recursively within groups.) and "RECURSIVE" (Searches recursively within groups.)

lastUpdatedTime String