AzureFileShareReference Class

  • java.lang.Object
    • com.microsoft.azure.management.batchai.AzureFileShareReference

public class AzureFileShareReference

Azure File Share mounting configuration.

Method Summary

Modifier and Type Method and Description
String accountName()

Get name of the Azure storage account.

String azureFileUrl()

Get uRL to access the Azure File.

AzureStorageCredentialsInfo credentials()

Get information about the Azure storage credentials.

String directoryMode()

Get file mode for directories on the mounted file share. Default value: 0777.

String fileMode()

Get file mode for files on the mounted file share. Default value: 0777.

String relativeMountPath()

Get the relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

AzureFileShareReference withAccountName(String accountName)

Set name of the Azure storage account.

AzureFileShareReference withAzureFileUrl(String azureFileUrl)

Set uRL to access the Azure File.

AzureFileShareReference withCredentials(AzureStorageCredentialsInfo credentials)

Set information about the Azure storage credentials.

AzureFileShareReference withDirectoryMode(String directoryMode)

Set file mode for directories on the mounted file share. Default value: 0777.

AzureFileShareReference withFileMode(String fileMode)

Set file mode for files on the mounted file share. Default value: 0777.

AzureFileShareReference withRelativeMountPath(String relativeMountPath)

Set the relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

Method Details

accountName

public String accountName()

Get name of the Azure storage account.

Returns:

the accountName value

azureFileUrl

public String azureFileUrl()

Get uRL to access the Azure File.

Returns:

the azureFileUrl value

credentials

public AzureStorageCredentialsInfo credentials()

Get information about the Azure storage credentials.

Returns:

the credentials value

directoryMode

public String directoryMode()

Get file mode for directories on the mounted file share. Default value: 0777.

Returns:

the directoryMode value

fileMode

public String fileMode()

Get file mode for files on the mounted file share. Default value: 0777.

Returns:

the fileMode value

relativeMountPath

public String relativeMountPath()

Get the relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

Returns:

the relativeMountPath value

withAccountName

public AzureFileShareReference withAccountName(String accountName)

Set name of the Azure storage account.

Parameters:

accountName - the accountName value to set

Returns:

the AzureFileShareReference object itself.

withAzureFileUrl

public AzureFileShareReference withAzureFileUrl(String azureFileUrl)

Set uRL to access the Azure File.

Parameters:

azureFileUrl - the azureFileUrl value to set

Returns:

the AzureFileShareReference object itself.

withCredentials

public AzureFileShareReference withCredentials(AzureStorageCredentialsInfo credentials)

Set information about the Azure storage credentials.

Parameters:

credentials - the credentials value to set

Returns:

the AzureFileShareReference object itself.

withDirectoryMode

public AzureFileShareReference withDirectoryMode(String directoryMode)

Set file mode for directories on the mounted file share. Default value: 0777.

Parameters:

directoryMode - the directoryMode value to set

Returns:

the AzureFileShareReference object itself.

withFileMode

public AzureFileShareReference withFileMode(String fileMode)

Set file mode for files on the mounted file share. Default value: 0777.

Parameters:

fileMode - the fileMode value to set

Returns:

the AzureFileShareReference object itself.

withRelativeMountPath

public AzureFileShareReference withRelativeMountPath(String relativeMountPath)

Set the relative path on the compute node where the Azure File share will be mounted. Note that all cluster level file shares will be mounted under $AZ_BATCHAI_MOUNT_ROOT location and all job level file shares will be mounted under $AZ_BATCHAI_JOB_MOUNT_ROOT.

Parameters:

relativeMountPath - the relativeMountPath value to set

Returns:

the AzureFileShareReference object itself.

Applies to