ActiveDirectoryProperties Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Settings properties for Active Directory (AD).
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ActiveDirectoryPropertiesTypeConverter))]
public class ActiveDirectoryProperties : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IActiveDirectoryProperties
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.ActiveDirectoryPropertiesTypeConverter))>]
type ActiveDirectoryProperties = class
interface IActiveDirectoryProperties
interface IJsonSerializable
Public Class ActiveDirectoryProperties
Implements IActiveDirectoryProperties
- Inheritance
-
ActiveDirectoryProperties
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| ActiveDirectoryProperties() |
Creates an new ActiveDirectoryProperties instance. |
Properties
| Name | Description |
|---|---|
| AccountType |
Specifies the Active Directory account type for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, samAccountName should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. |
| AzureStorageSid |
Specifies the security identifier (SID) for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| DomainGuid |
Specifies the domain GUID. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. If directoryServiceOptions is set to AADDS (Entra DS authentication), this property can be omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. |
| DomainName |
Specifies the primary domain that the AD DNS server is authoritative for. This property is required if directoryServiceOptions is set to AD (AD DS authentication). If directoryServiceOptions is set to AADDS (Entra DS authentication), providing this property is optional, as it will be inferred automatically if omitted. If directoryServiceOptions is set to AADKERB (Entra authentication), this property is optional; it is needed to support configuration of directory- and file-level permissions via Windows File Explorer, but is not required for authentication. |
| DomainSid |
Specifies the security identifier (SID) of the AD domain. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| ForestName |
Specifies the Active Directory forest to get. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| NetBiosDomainName |
Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted. |
| SamAccountName |
Specifies the Active Directory SAMAccountName for Azure Storage. If directoryServiceOptions is set to AD (AD DS authentication), this property is optional. If provided, accountType should also be provided. For directoryServiceOptions AADDS (Entra DS authentication) or AADKERB (Entra authentication), this property can be omitted. |
Methods
| Name | Description |
|---|---|
| DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of ActiveDirectoryProperties. |
| DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of ActiveDirectoryProperties. |
| FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IActiveDirectoryProperties. |
| FromJsonString(String) |
Creates a new instance of ActiveDirectoryProperties, deserializing the content from a json string. |
| ToJson(JsonObject, SerializationMode) |
Serializes this instance of ActiveDirectoryProperties into a JsonNode. |
| ToJsonString() |
Serializes this instance to a json string. |
| ToString() | |