Package com.azure.compute.batch.models

Class AzureFileShareConfiguration

java.lang.Object
com.azure.compute.batch.models.AzureFileShareConfiguration
All Implemented Interfaces:
com.azure.json.JsonSerializable<AzureFileShareConfiguration>
public final class AzureFileShareConfiguration extends Object implements com.azure.json.JsonSerializable<AzureFileShareConfiguration>
Information used to connect to an Azure Fileshare.

  • Constructor Details

    • AzureFileShareConfiguration

      public AzureFileShareConfiguration(String accountName, String azureFileUrl, String accountKey, String relativeMountPath)
      Creates an instance of AzureFileShareConfiguration class.
      Parameters:
      accountName - the accountName value to set.
      azureFileUrl - the azureFileUrl value to set.
      accountKey - the accountKey value to set.
      relativeMountPath - the relativeMountPath value to set.

  • Method Details

    • getAccountName

      public String getAccountName()
      Get the accountName property: The Azure Storage account name.
      Returns:
      the accountName value.

    • getAzureFileUrl

      public String getAzureFileUrl()
      Get the azureFileUrl property: The Azure Files URL. This is of the form 'https://{account}.file.core.windows.net/'.
      Returns:
      the azureFileUrl value.

    • getAccountKey

      public String getAccountKey()
      Get the accountKey property: The Azure Storage account key.
      Returns:
      the accountKey value.

    • getRelativeMountPath

      public String getRelativeMountPath()
      Get the relativeMountPath property: The relative path on the compute node where the file system will be mounted. All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable.
      Returns:
      the relativeMountPath value.

    • getMountOptions

      public String getMountOptions()
      Get the mountOptions property: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
      Returns:
      the mountOptions value.

    • setMountOptions

      public AzureFileShareConfiguration setMountOptions(String mountOptions)
      Set the mountOptions property: Additional command line options to pass to the mount command. These are 'net use' options in Windows and 'mount' options in Linux.
      Parameters:
      mountOptions - the mountOptions value to set.
      Returns:
      the AzureFileShareConfiguration object itself.

    • toJson

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

    • fromJson

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