Package version:

Interface ActiveDirectory

Active Directory

interface ActiveDirectory {
    activeDirectoryId?: string;
    administrators?: string[];
    adName?: string;
    aesEncryption?: boolean;
    allowLocalNfsUsersWithLdap?: boolean;
    backupOperators?: string[];
    dns?: string;
    domain?: string;
    encryptDCConnections?: boolean;
    kdcIP?: string;
    ldapOverTLS?: boolean;
    ldapSearchScope?: LdapSearchScopeOpt;
    ldapSigning?: boolean;
    organizationalUnit?: string;
    password?: string;
    preferredServersForLdapClient?: string;
    securityOperators?: string[];
    serverRootCACertificate?: string;
    site?: string;
    smbServerName?: string;
    status?: string;
    statusDetails?: string;
    username?: string;
}

Properties

activeDirectoryId? administrators? adName? aesEncryption? allowLocalNfsUsersWithLdap? backupOperators? dns? domain? encryptDCConnections? kdcIP? ldapOverTLS? ldapSearchScope? ldapSigning? organizationalUnit? password? preferredServersForLdapClient? securityOperators? serverRootCACertificate? site? smbServerName? status? statusDetails? username?

Properties

OptionalactiveDirectoryId

activeDirectoryId?: string

Id of the Active Directory

Optionaladministrators

administrators?: string[]

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

OptionaladName

adName?: string

Name of the active directory machine. This optional parameter is used only while creating kerberos volume

OptionalaesEncryption

aesEncryption?: boolean

If enabled, AES encryption will be enabled for SMB communication.

OptionalallowLocalNfsUsersWithLdap

allowLocalNfsUsersWithLdap?: boolean

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

OptionalbackupOperators

backupOperators?: string[]

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

Optionaldns

dns?: string

Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain

Optionaldomain

domain?: string

Name of the Active Directory domain

OptionalencryptDCConnections

encryptDCConnections?: boolean

If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted.

OptionalkdcIP

kdcIP?: string

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

OptionalldapOverTLS

ldapOverTLS?: boolean

Specifies whether or not the LDAP traffic needs to be secured via TLS.

OptionalldapSearchScope

ldapSearchScope?: LdapSearchScopeOpt

LDAP Search scope options

OptionalldapSigning

ldapSigning?: boolean

Specifies whether or not the LDAP traffic needs to be signed.

OptionalorganizationalUnit

organizationalUnit?: string

The Organizational Unit (OU) within the Windows Active Directory

Optionalpassword

password?: string

Plain text password of Active Directory domain administrator, value is masked in the response

OptionalpreferredServersForLdapClient

preferredServersForLdapClient?: string

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

OptionalsecurityOperators

securityOperators?: string[]

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

OptionalserverRootCACertificate

serverRootCACertificate?: string

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.

Optionalsite

site?: string

The Active Directory site the service will limit Domain Controller discovery to

OptionalsmbServerName

smbServerName?: string

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

Optional Readonlystatus

status?: string

Status of the Active Directory NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlystatusDetails

statusDetails?: string

Any details in regards to the Status of the Active Directory NOTE: This property will not be serialized. It can only be populated by the server.

Optionalusername

username?: string

A domain user account with permission to create machine accounts

Settings

Member Visibility