Share via

CloudFileShare Class

  • Reference
Package:
com.microsoft.azure.storage.file
  • java.lang.Object
    • com.microsoft.azure.storage.file.CloudFileShare

public class CloudFileShare

Represents a share in the Microsoft Azure File service.

Shares hold directories, which are encapsulated as CloudFileDirectory objects, and directories hold files. Directories can also contain sub-directories.

Constructor Summary

Constructor Description
CloudFileShare(final StorageUri storageUri)

Creates an instance of the class using the specified URI.
CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

Creates an instance of the class using the specified StorageUri and credentials.
CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

Creates an instance of the class using the specified name and client.
CloudFileShare(final URI uri)

Creates an instance of the class using the specified URI.
CloudFileShare(final URI uri, final StorageCredentials credentials)

Creates an instance of the class using the specified URI and credentials.

Method Summary

Modifier and Type Method and Description
void assertNoSnapshot()

Asserts that the share is not a snapshot.

void create()

Creates the share.
void create(FileRequestOptions options, OperationContext opContext)

Creates the share using the specified options and operation context.
String createFilePermission(String permission)

Creates a file permission.
String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

Creates a file permission.
boolean createIfNotExists()

Creates the share if it does not exist.
boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

Creates the share if it does not exist, using the specified request options and operation context.
final CloudFileShare createSnapshot()

Creates a snapshot of the share.
final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Creates a snapshot of the file share using the specified request options and operation context.
final CloudFileShare createSnapshot(final HashMap<String, String> metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Creates a snapshot of the file share using the specified request options and operation context.
void delete()

Deletes the share.
void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share using the specified request options and operation context.
void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share using the specified snapshot and request options, and operation context.

A share that has snapshots cannot be deleted unless the snapshots are also deleted. If a share has snapshots, use the INCLUDE_SNAPSHOTS value in the parameter to include the snapshots when deleting the base share.
boolean deleteIfExists()

Deletes the share if it exists.
boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share if it exists using the specified request options and operation context.
boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share if it exists, using the specified snapshot and request options, and operation context.

A share that has snapshots cannot be deleted unless the snapshots are also deleted. If a share has snapshots, use the INCLUDE_SNAPSHOTS value in the parameter to include the snapshots when deleting the base share.
void downloadAttributes()

Downloads the share's attributes, which consist of metadata and properties.
void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Downloads the share's attributes, which consist of metadata and properties, using the specified request options and operation context.
FileSharePermissions downloadPermissions()

Downloads the permission settings for the share.
FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Downloads the permissions settings for the share using the specified request options and operation context.
boolean exists()

Returns a value that indicates whether the share exists.
boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Returns a value that indicates whether the share exists, using the specified request options and operation context.
String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

Returns a shared access signature for the share. Note this does not contain the leading "?".
String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Returns a shared access signature for the share. Note this does not contain the leading "?".
String getFilePermission(String filePermissionKey)

Gets the file permission associated with a file permission key.
String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

Gets the file permission associated with a file permission key.
HashMap<String, String> getMetadata()

Returns the metadata for the share. This value is initialized with the metadata from the share by a call to downloadAttributes(), and is set on the share with a call to uploadMetadata().
String getName()

Returns the name of the share.
FileShareProperties getProperties()

Returns the properties for the share.
final URI getQualifiedUri()

Returns the snapshot or shared access signature qualified URI for this share.
CloudFileDirectory getRootDirectoryReference()

Returns a reference to a CloudFileDirectory object that represents the root file directory within this share.
CloudFileClient getServiceClient()

Returns the File service client associated with this share.
final String getSnapshot()

Returns the snapshotID for this share.
ShareStats getStats()

Queries the service for this share's ShareStats.
ShareStats getStats(FileRequestOptions options, OperationContext opContext)

Queries the service for this share's ShareStats.
StorageUri getStorageUri()

Returns the list of URIs for all locations.
URI getUri()

Returns the URI for this share.
final boolean isSnapshot()

Indicates whether this share is a snapshot.
void setMetadata(final HashMap<String, String> metadata)

Sets the metadata collection of name-value pairs to be set on the share with an uploadMetadata() call. This collection will overwrite any existing share metadata. If this is set to an empty collection, the share metadata will be cleared on an uploadMetadata() call.
void setProperties(final FileShareProperties properties)

Sets the properties for the share.
void uploadMetadata()

Uploads the share's metadata.
void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Uploads the share's metadata using the specified request options and operation context.
void uploadPermissions(final FileSharePermissions permissions)

Uploads the share's permissions.
void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Uploads the share's permissions using the specified request options and operation context.
final void uploadProperties()

Updates the share's properties on the storage service.

Use downloadAttributes() to retrieve the latest values for the share's properties and metadata from the Microsoft Azure storage service.
final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Updates the share's properties using the request options, and operation context.

Use downloadAttributes() to retrieve the latest values for the share's properties and metadata from the Microsoft Azure storage service.

Constructor Details

CloudFileShare

public CloudFileShare(final StorageUri storageUri)

Creates an instance of the class using the specified URI.

Parameters:

storageUri - A StorageUri object which represents the absolute URI of the share.

Throws:

StorageException - If a storage service error occurred.

CloudFileShare

public CloudFileShare(final StorageUri storageUri, final StorageCredentials credentials)

Creates an instance of the class using the specified StorageUri and credentials.

Parameters:

storageUri - A StorageUri object which represents the absolute StorageUri of the share.
credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

CloudFileShare

public CloudFileShare(final String shareName, String snapshotID, final CloudFileClient client)

Creates an instance of the class using the specified name and client.

Parameters:

shareName - A String which represents the name of the share, which must adhere to share naming rules. The share name should not include any path separator characters (/). Share names must be lowercase, between 3-63 characters long and must start with a letter or number. Share names may contain only letters, numbers, and the dash (-) character.
snapshotID - A String that represents the snapshot version, if applicable.
client - A CloudFileClient object that represents the associated service client, and that specifies the endpoint for the File service.

Throws:

StorageException - If a storage service error occurred.
URISyntaxException - If the resource URI constructed based on the shareName is invalid.

CloudFileShare

public CloudFileShare(final URI uri)

Creates an instance of the class using the specified URI.

Parameters:

uri - A java.net.URI object that represents the absolute URI of the share.

Throws:

StorageException - If a storage service error occurred.

CloudFileShare

public CloudFileShare(final URI uri, final StorageCredentials credentials)

Creates an instance of the class using the specified URI and credentials.

Parameters:

uri - A java.net.URI object that represents the absolute URI of the share.
credentials - A StorageCredentials object used to authenticate access.

Throws:

StorageException - If a storage service error occurred.

Method Details

assertNoSnapshot

protected void assertNoSnapshot()

Asserts that the share is not a snapshot.

create

public void create()

Creates the share.

Throws:

StorageException - If a storage service error occurred.

create

public void create(FileRequestOptions options, OperationContext opContext)

Creates the share using the specified options and operation context.

Parameters:

options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

createFilePermission

public String createFilePermission(String permission)

Creates a file permission.

Parameters:

permission - A String object that represents the file permission to create.

Returns:

The String representing the file permission key associated with the file permission created.

Throws:

StorageException
IOException

createFilePermission

public String createFilePermission(String permission, FileRequestOptions options, OperationContext opContext)

Creates a file permission.

Parameters:

permission - A String object that represents the file permission to create.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

The String representing the file permission key associated with the file permission created.

Throws:

StorageException
IOException

createIfNotExists

public boolean createIfNotExists()

Creates the share if it does not exist.

Returns:

true if the share did not already exist and was created; otherwise, false.

Throws:

StorageException - If a storage service error occurred.

createIfNotExists

public boolean createIfNotExists(FileRequestOptions options, OperationContext opContext)

Creates the share if it does not exist, using the specified request options and operation context.

Parameters:

options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the share did not already exist and was created; otherwise, false.

Throws:

StorageException - If a storage service error occurred.

createSnapshot

public final CloudFileShare createSnapshot()

Creates a snapshot of the share.

Returns:

A CloudFileShare object that represents the snapshot of the share.

Throws:

StorageException - If a storage service error occurred.

createSnapshot

public final CloudFileShare createSnapshot(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Creates a snapshot of the file share using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A CloudFileShare object that represents the snapshot of the file share.

Throws:

StorageException - If a storage service error occurred.

createSnapshot

public final CloudFileShare createSnapshot(final HashMap metadata, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Creates a snapshot of the file share using the specified request options and operation context.

Parameters:

metadata - A collection of name-value pairs defining the metadata of the snapshot, or null.
accessCondition - An AccessCondition object that represents the access conditions for the file share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A CloudFileShare object that represents the snapshot of the file share.

Throws:

StorageException - If a storage service error occurred.

delete

public void delete()

Deletes the share.

Throws:

StorageException - If a storage service error occurred.

delete

public void delete(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

delete

public void delete(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share using the specified snapshot and request options, and operation context.

A share that has snapshots cannot be deleted unless the snapshots are also deleted. If a share has snapshots, use the INCLUDE_SNAPSHOTS value in the parameter to include the snapshots when deleting the base share.

Parameters:

deleteSnapshotsOption - A DeleteShareSnapshotsOption object that indicates whether to delete only snapshots, or the share and its snapshots.
accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

deleteIfExists

public boolean deleteIfExists()

Deletes the share if it exists.

Returns:

true if the share existed and was deleted; otherwise, false.

Throws:

StorageException - If a storage service error occurred.

deleteIfExists

public boolean deleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share if it exists using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the share existed and was deleted; otherwise, false.

Throws:

StorageException - If a storage service error occurred.

deleteIfExists

public boolean deleteIfExists(DeleteShareSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Deletes the share if it exists, using the specified snapshot and request options, and operation context.

A share that has snapshots cannot be deleted unless the snapshots are also deleted. If a share has snapshots, use the INCLUDE_SNAPSHOTS value in the parameter to include the snapshots when deleting the base share.

Parameters:

deleteSnapshotsOption - A DeleteShareSnapshotsOption object that indicates whether to delete only snapshots, or the share and its snapshots.
accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the share existed and was deleted; otherwise, false.

Throws:

StorageException - If a storage service error occurred.

downloadAttributes

public void downloadAttributes()

Downloads the share's attributes, which consist of metadata and properties.

Throws:

StorageException - If a storage service error occurred.

downloadAttributes

public void downloadAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Downloads the share's attributes, which consist of metadata and properties, using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

downloadPermissions

public FileSharePermissions downloadPermissions()

Downloads the permission settings for the share.

Returns:

A FileSharePermissions object that represents the share's permissions.

Throws:

StorageException - If a storage service error occurred.

downloadPermissions

public FileSharePermissions downloadPermissions(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Downloads the permissions settings for the share using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A FileSharePermissions object that represents the share's permissions.

Throws:

StorageException - If a storage service error occurred.

exists

public boolean exists()

Returns a value that indicates whether the share exists.

Returns:

true if the share exists, otherwise false.

Throws:

StorageException - If a storage service error occurred.

exists

public boolean exists(final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Returns a value that indicates whether the share exists, using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

true if the share exists, otherwise false.

Throws:

StorageException - If a storage service error occurred.

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier)

Returns a shared access signature for the share. Note this does not contain the leading "?".

Parameters:

policy - An SharedAccessFilePolicy object that represents the access policy for the shared access signature.
groupPolicyIdentifier - A String which represents the share-level access policy.

Returns:

A String which represents a shared access signature for the share.

Throws:

StorageException - If a storage service error occurred.
InvalidKeyException - If the key is invalid.

generateSharedAccessSignature

public String generateSharedAccessSignature(final SharedAccessFilePolicy policy, final String groupPolicyIdentifier, final IPRange ipRange, final SharedAccessProtocols protocols)

Returns a shared access signature for the share. Note this does not contain the leading "?".

Parameters:

policy - An SharedAccessFilePolicy object that represents the access policy for the shared access signature.
groupPolicyIdentifier - A String which represents the share-level access policy.
ipRange - A IPRange object containing the range of allowed IP addresses.
protocols - A SharedAccessProtocols representing the allowed Internet protocols.

Returns:

A String which represents a shared access signature for the share.

Throws:

StorageException - If a storage service error occurred.
InvalidKeyException - If the key is invalid.

getFilePermission

public String getFilePermission(String filePermissionKey)

Gets the file permission associated with a file permission key.

Parameters:

filePermissionKey - A String object that represents the file permission key.

Returns:

The String representing the file permission associated with the file permission key.

Throws:

StorageException

getFilePermission

public String getFilePermission(String filePermissionKey, FileRequestOptions options, OperationContext opContext)

Gets the file permission associated with a file permission key.

Parameters:

filePermissionKey - A String object that represents the file permission key.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

The String representing the file permission associated with the file permission key.

Throws:

StorageException

getMetadata

public HashMap getMetadata()

Returns the metadata for the share. This value is initialized with the metadata from the share by a call to downloadAttributes(), and is set on the share with a call to uploadMetadata().

Returns:

A java.util.HashMap object that represents the metadata for the share.

getName

public String getName()

Returns the name of the share.

Returns:

A String that represents the name of the share.

getProperties

public FileShareProperties getProperties()

Returns the properties for the share.

Returns:

A FileShareProperties object that represents the properties for the share.

getQualifiedUri

public final URI getQualifiedUri()

Returns the snapshot or shared access signature qualified URI for this share.

Returns:

A java.net.URI object that represents the snapshot or shared access signature.

Throws:

StorageException - If a storage service error occurred.
URISyntaxException - If the resource URI is invalid.

getRootDirectoryReference

public CloudFileDirectory getRootDirectoryReference()

Returns a reference to a CloudFileDirectory object that represents the root file directory within this share.

Returns:

A CloudFileDirectory reference to the root directory for this share.

Throws:

StorageException
URISyntaxException

getServiceClient

public CloudFileClient getServiceClient()

Returns the File service client associated with this share.

Returns:

A CloudFileClient object that represents the service client associated with this share.

getSnapshot

public final String getSnapshot()

Returns the snapshotID for this share.

Returns:

The snapshotID as a string for this share.

getStats

public ShareStats getStats()

Queries the service for this share's ShareStats.

Returns:

A ShareStats object for the given storage service.

Throws:

StorageException - If a storage service error occurred.

getStats

public ShareStats getStats(FileRequestOptions options, OperationContext opContext)

Queries the service for this share's ShareStats.

Parameters:

options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client (CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Returns:

A ShareStats object for the given storage service.

Throws:

StorageException - If a storage service error occurred.

getStorageUri

public StorageUri getStorageUri()

Returns the list of URIs for all locations.

Returns:

A StorageUri object which represents the list of URIs for all locations.

getUri

public URI getUri()

Returns the URI for this share.

Returns:

The absolute URI to the share.

isSnapshot

public final boolean isSnapshot()

Indicates whether this share is a snapshot.

Returns:

true if the share is a snapshot, otherwise false.

setMetadata

public void setMetadata(final HashMap metadata)

Sets the metadata collection of name-value pairs to be set on the share with an uploadMetadata() call. This collection will overwrite any existing share metadata. If this is set to an empty collection, the share metadata will be cleared on an uploadMetadata() call.

Parameters:

metadata - A java.util.HashMap object that represents the metadata being assigned to the share.

setProperties

public void setProperties(final FileShareProperties properties)

Sets the properties for the share.

Parameters:

properties - A FileShareProperties object that represents the properties being assigned to the share.

uploadMetadata

public void uploadMetadata()

Uploads the share's metadata.

Throws:

StorageException - If a storage service error occurred.

uploadMetadata

public void uploadMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Uploads the share's metadata using the specified request options and operation context.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions)

Uploads the share's permissions.

Parameters:

permissions - A FileSharePermissions object that represents the permissions to upload.

Throws:

StorageException - If a storage service error occurred.

uploadPermissions

public void uploadPermissions(final FileSharePermissions permissions, final AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Uploads the share's permissions using the specified request options and operation context.

Parameters:

permissions - A FileSharePermissions object that represents the permissions to upload.
accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

uploadProperties

public final void uploadProperties()

Updates the share's properties on the storage service.

Use downloadAttributes() to retrieve the latest values for the share's properties and metadata from the Microsoft Azure storage service.

Throws:

StorageException - If a storage service error occurred.

uploadProperties

public final void uploadProperties(AccessCondition accessCondition, FileRequestOptions options, OperationContext opContext)

Updates the share's properties using the request options, and operation context.

Use downloadAttributes() to retrieve the latest values for the share's properties and metadata from the Microsoft Azure storage service.

Parameters:

accessCondition - An AccessCondition object that represents the access conditions for the share.
options - A FileRequestOptions object that specifies any additional options for the request. Specifying null will use the default request options from the associated service client ( CloudFileClient).
opContext - An OperationContext object that represents the context for the current operation. This object is used to track requests to the storage service, and to provide additional runtime information about the operation.

Throws:

StorageException - If a storage service error occurred.

Applies to