Share via


ActiveDirectory Class

Definition

Active Directory

public class ActiveDirectory
type ActiveDirectory = class
Public Class ActiveDirectory
Inheritance
ActiveDirectory

Constructors

ActiveDirectory()

Initializes a new instance of the ActiveDirectory class.

ActiveDirectory(String, String, String, String, String, String, String, String, String, String, IList<String>, IList<String>, String, String, String, Nullable<Boolean>, Nullable<Boolean>, IList<String>, Nullable<Boolean>, Nullable<Boolean>, Nullable<Boolean>, LdapSearchScopeOpt, String)

Initializes a new instance of the ActiveDirectory class.

Properties

ActiveDirectoryId

Gets or sets id of the Active Directory

Administrators

Gets or sets users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier

AdName

Gets or sets name of the active directory machine. This optional parameter is used only while creating kerberos volume

AesEncryption

Gets or sets if enabled, AES encryption will be enabled for SMB communication.

AllowLocalNfsUsersWithLdap

Gets or sets If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes.

BackupOperators

Gets or sets users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier

Dns

Gets or sets comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain

Domain

Gets or sets name of the Active Directory domain

EncryptDcConnections

Gets or sets if enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.

KdcIP

Gets or sets kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume.

LdapOverTls

Gets or sets specifies whether or not the LDAP traffic needs to be secured via TLS.

LdapSearchScope

Gets or sets lDAP Search scope options

LdapSigning

Gets or sets specifies whether or not the LDAP traffic needs to be signed.

OrganizationalUnit

Gets or sets the Organizational Unit (OU) within the Windows Active Directory

Password

Gets or sets plain text password of Active Directory domain administrator, value is masked in the response

PreferredServersForLdapClient

Gets or sets comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed.

SecurityOperators

Gets or sets domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier

ServerRootCaCertificate

Gets or sets when LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.

Site

Gets or sets the Active Directory site the service will limit Domain Controller discovery to

SmbServerName

Gets or sets netBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes

Status

Gets status of the Active Directory Possible values include: 'Created', 'InUse', 'Deleted', 'Error', 'Updating'

StatusDetails

Gets any details in regards to the Status of the Active Directory

Username

Gets or sets a domain user account with permission to create machine accounts

Methods

Validate()

Validate the object.

Extension Methods

ConvertToPs(ActiveDirectory, String, String)

Applies to