Class ActiveDirectory

Provides a Rancher v2 Auth Config ActiveDirectory resource. This can be used to configure and enable Auth Config ActiveDirectory for Rancher v2 RKE clusters and retrieve their information.

In addition to the built-in local auth, only one external auth config provider can be enabled at a time.

Inheritance

System.Object

Resource

CustomResource

ActiveDirectory

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Rancher2

Assembly: Pulumi.Rancher2.dll

Syntax

public class ActiveDirectory : CustomResource

Constructors

View Source

ActiveDirectory(String, ActiveDirectoryArgs, CustomResourceOptions)

Create a ActiveDirectory resource with the given unique name, arguments, and options.

Declaration

public ActiveDirectory(string name, ActiveDirectoryArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ActiveDirectoryArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AccessMode

Access mode for auth. required, restricted, unrestricted are supported. Default unrestricted (string)

Declaration

public Output<string> AccessMode { get; }

Property Value

Type	Description
Output<System.String>

View Source

AllowedPrincipalIds

Allowed principal ids for auth. Required if access_mode is required or restricted. Ex: activedirectory_user://<DN> activedirectory_group://<DN> (list)

Declaration

public Output<ImmutableArray<string>> AllowedPrincipalIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Annotations

Annotations of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

Certificate

CA certificate for TLS if selfsigned (string)

Declaration

public Output<string> Certificate { get; }

Property Value

Type	Description
Output<System.String>

View Source

ConnectionTimeout

ActiveDirectory connection timeout. Default 5000 (int)

Declaration

public Output<int?> ConnectionTimeout { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

DefaultLoginDomain

ActiveDirectory defult lgoin domain (string)

Declaration

public Output<string> DefaultLoginDomain { get; }

Property Value

Type	Description
Output<System.String>

View Source

Enabled

Enable auth config provider. Default true (bool)

Declaration

public Output<bool?> Enabled { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

View Source

GroupDnAttribute

Group DN attribute. Default distinguishedName (string)

Declaration

public Output<string> GroupDnAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupMemberMappingAttribute

Group member mapping attribute. Default member (string)

Declaration

public Output<string> GroupMemberMappingAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupMemberUserAttribute

Group member user attribute. Default distinguishedName (string)

Declaration

public Output<string> GroupMemberUserAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupNameAttribute

Group name attribute. Default name (string)

Declaration

public Output<string> GroupNameAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupObjectClass

Group object class. Default group (string)

Declaration

public Output<string> GroupObjectClass { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupSearchAttribute

Group search attribute. Default sAMAccountName (string)

Declaration

public Output<string> GroupSearchAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupSearchBase

Group search base (string)

Declaration

public Output<string> GroupSearchBase { get; }

Property Value

Type	Description
Output<System.String>

View Source

GroupSearchFilter

Group search filter (string)

Declaration

public Output<string> GroupSearchFilter { get; }

Property Value

Type	Description
Output<System.String>

View Source

Labels

Labels of the resource (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

View Source

Name

(Computed) The name of the resource (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NestedGroupMembershipEnabled

Nested group membership enable. Default false (bool)

Declaration

public Output<bool> NestedGroupMembershipEnabled { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

Port

ActiveDirectory port. Default 389 (int)

Declaration

public Output<int?> Port { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

Servers

ActiveDirectory servers list (list)

Declaration

public Output<ImmutableArray<string>> Servers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

ServiceAccountPassword

Service account password for access ActiveDirectory service (string)

Declaration

public Output<string> ServiceAccountPassword { get; }

Property Value

Type	Description
Output<System.String>

View Source

ServiceAccountUsername

Service account DN for access ActiveDirectory service (string)

Declaration

public Output<string> ServiceAccountUsername { get; }

Property Value

Type	Description
Output<System.String>

View Source

Tls

Enable TLS connection (bool)

Declaration

public Output<bool> Tls { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

Type

(Computed) The type of the resource (string)

Declaration

public Output<string> Type { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserDisabledBitMask

User disabled bit mask. Default 2 (int)

Declaration

public Output<int?> UserDisabledBitMask { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

View Source

UserEnabledAttribute

User enable attribute (string)

Declaration

public Output<string> UserEnabledAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserLoginAttribute

User login attribute. Default sAMAccountName (string)

Declaration

public Output<string> UserLoginAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserNameAttribute

User name attribute. Default name (string)

Declaration

public Output<string> UserNameAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserObjectClass

User object class. Default person (string)

Declaration

public Output<string> UserObjectClass { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserSearchAttribute

User search attribute. Default sAMAccountName|sn|givenName (string)

Declaration

public Output<string> UserSearchAttribute { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserSearchBase

User search base DN (string)

Declaration

public Output<string> UserSearchBase { get; }

Property Value

Type	Description
Output<System.String>

View Source

UserSearchFilter

User search filter (string)

Declaration

public Output<string> UserSearchFilter { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, ActiveDirectoryState, CustomResourceOptions)

Get an existing ActiveDirectory resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static ActiveDirectory Get(string name, Input<string> id, ActiveDirectoryState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ActiveDirectoryState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
ActiveDirectory