Class ActiveDirectoryProperties

java.lang.Object
com.azure.resourcemanager.storage.models.ActiveDirectoryProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<ActiveDirectoryProperties>
public final class ActiveDirectoryProperties extends Object implements com.azure.json.JsonSerializable<ActiveDirectoryProperties>
Settings properties for Active Directory (AD).

  • Constructor Details

    • ActiveDirectoryProperties

      public ActiveDirectoryProperties()
      Creates an instance of ActiveDirectoryProperties class.

  • Method Details

    • domainName

      public String domainName()
      Get the domainName property: 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.
      Returns:
      the domainName value.

    • withDomainName

      public ActiveDirectoryProperties withDomainName(String domainName)
      Set the domainName property: 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.
      Parameters:
      domainName - the domainName value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • netBiosDomainName

      public String netBiosDomainName()
      Get the netBiosDomainName property: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted.
      Returns:
      the netBiosDomainName value.

    • withNetBiosDomainName

      public ActiveDirectoryProperties withNetBiosDomainName(String netBiosDomainName)
      Set the netBiosDomainName property: Specifies the NetBIOS domain name. If directoryServiceOptions is set to AD (AD DS authentication), this property is required. Otherwise, it can be omitted.
      Parameters:
      netBiosDomainName - the netBiosDomainName value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • forestName

      public String forestName()
      Get the forestName property: 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.
      Returns:
      the forestName value.

    • withForestName

      public ActiveDirectoryProperties withForestName(String forestName)
      Set the forestName property: 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.
      Parameters:
      forestName - the forestName value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • domainGuid

      public String domainGuid()
      Get the domainGuid property: 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.
      Returns:
      the domainGuid value.

    • withDomainGuid

      public ActiveDirectoryProperties withDomainGuid(String domainGuid)
      Set the domainGuid property: 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.
      Parameters:
      domainGuid - the domainGuid value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • domainSid

      public String domainSid()
      Get the domainSid property: 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.
      Returns:
      the domainSid value.

    • withDomainSid

      public ActiveDirectoryProperties withDomainSid(String domainSid)
      Set the domainSid property: 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.
      Parameters:
      domainSid - the domainSid value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • azureStorageSid

      public String azureStorageSid()
      Get the azureStorageSid property: 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.
      Returns:
      the azureStorageSid value.

    • withAzureStorageSid

      public ActiveDirectoryProperties withAzureStorageSid(String azureStorageSid)
      Set the azureStorageSid property: 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.
      Parameters:
      azureStorageSid - the azureStorageSid value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • samAccountName

      public String samAccountName()
      Get the samAccountName property: 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.
      Returns:
      the samAccountName value.

    • withSamAccountName

      public ActiveDirectoryProperties withSamAccountName(String samAccountName)
      Set the samAccountName property: 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.
      Parameters:
      samAccountName - the samAccountName value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • accountType

      public ActiveDirectoryPropertiesAccountType accountType()
      Get the accountType property: 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.
      Returns:
      the accountType value.

    • withAccountType

      public ActiveDirectoryProperties withAccountType(ActiveDirectoryPropertiesAccountType accountType)
      Set the accountType property: 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.
      Parameters:
      accountType - the accountType value to set.
      Returns:
      the ActiveDirectoryProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ActiveDirectoryProperties>
      Throws:
      IOException

    • fromJson

      public static ActiveDirectoryProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ActiveDirectoryProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ActiveDirectoryProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ActiveDirectoryProperties.