CloudFileShare Class

Definition

Namespace:

Microsoft.Azure.Storage.File

Assembly:

Microsoft.Azure.Storage.File.dll

Package:

Microsoft.Azure.Storage.File v11.2.3

Represents a share in the Microsoft Azure File service.

public class CloudFileShare

type CloudFileShare = class

Public Class CloudFileShare

Inheritance

Object

CloudFileShare

Remarks

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

Constructors

CloudFileShare(StorageUri, Nullable<DateTimeOffset>, StorageCredentials)	Initializes a new instance of the CloudFileShare class.
CloudFileShare(StorageUri, StorageCredentials)	Initializes a new instance of the CloudFileShare class.
CloudFileShare(Uri)	Initializes a new instance of the CloudFileShare class.
CloudFileShare(Uri, Nullable<DateTimeOffset>, StorageCredentials)	Initializes a new instance of the CloudFileShare class.
CloudFileShare(Uri, StorageCredentials)	Initializes a new instance of the CloudFileShare class.

Properties

IsSnapshot	Gets a value indicating whether this share is a snapshot.
Metadata	Gets the share's metadata.
Name	Gets the name of the share.
Properties	Gets the share's system properties.
ServiceClient	Gets the service client for the share.
SnapshotQualifiedStorageUri	Gets the share's URI for both the primary and secondary locations, including query string information if the share is a snapshot.
SnapshotQualifiedUri	Gets the absolute URI to the share, including query string information if the share is a snapshot.
SnapshotTime	Gets the date and time that the share snapshot was taken, if this share is a snapshot.
StorageUri	Gets the list of URIs for all locations.
Uri	Gets the share's URI.

Methods

BeginCreate(AsyncCallback, Object)	Begins an asynchronous operation to create a share.
BeginCreate(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a share.
BeginCreateIfNotExists(AsyncCallback, Object)	Begins an asynchronous request to create the share if it does not already exist.
BeginCreateIfNotExists(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the share if it does not already exist.
BeginDelete(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a share.
BeginDelete(AsyncCallback, Object)	Begins an asynchronous operation to delete a share.
BeginDelete(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a share.
BeginDeleteIfExists(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to delete the share if it already exists.
BeginDeleteIfExists(AsyncCallback, Object)	Begins an asynchronous request to delete the share if it already exists.
BeginDeleteIfExists(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to delete the share if it already exists.
BeginExists(AsyncCallback, Object)	Begins an asynchronous request to check whether the share exists.
BeginExists(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to check whether the share exists.
BeginFetchAttributes(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to retrieve the share's attributes.
BeginFetchAttributes(AsyncCallback, Object)	Begins an asynchronous operation to retrieve the share's attributes.
BeginGetPermissions(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the share.
BeginGetPermissions(AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the share.
BeginGetStats(AsyncCallback, Object)	Begins an asynchronous operation to get stats for the share.
BeginGetStats(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get stats for the share.
BeginSetMetadata(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the share.
BeginSetMetadata(AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the share.
BeginSetPermissions(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the share.
BeginSetPermissions(FileSharePermissions, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the share.
BeginSetProperties(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to update the share's properties.
BeginSetProperties(AsyncCallback, Object)	Begins an asynchronous operation to update the share's properties.
BeginSnapshot(AsyncCallback, Object)	Begins an asynchronous operation to create a snapshot of the share.
BeginSnapshot(IDictionary<String,String>, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a snapshot of the share.
Create(FileRequestOptions, OperationContext)	Creates the share.
CreateAsync()	Returns a task that performs an asynchronous operation to create a share.
CreateAsync(CancellationToken)	Returns a task that performs an asynchronous operation to create a share.
CreateAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to create a share.
CreateAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to create a share.
CreateFilePermission(String, FileRequestOptions, OperationContext)	Creates a File Permission.
CreateFilePermissionAsync(String, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Creates a File Permission.
CreateIfNotExists(FileRequestOptions, OperationContext)	Creates the share if it does not already exist.
CreateIfNotExistsAsync()	Returns a task that performs an asynchronous request to create the share if it does not already exist.
CreateIfNotExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
CreateIfNotExistsAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
CreateIfNotExistsAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
Delete(AccessCondition, FileRequestOptions, OperationContext)	Deletes the share.
Delete(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext)	Deletes the share.
DeleteAsync()	Returns a task that performs an asynchronous operation to delete a share.
DeleteAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to delete a share.
DeleteAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to delete a share.
DeleteAsync(CancellationToken)	Returns a task that performs an asynchronous operation to delete a share.
DeleteAsync(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to delete a share.
DeleteIfExists(AccessCondition, FileRequestOptions, OperationContext)	Deletes the share if it already exists.
DeleteIfExists(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext)	Deletes the share if it already exists.
DeleteIfExistsAsync()	Returns a task that performs an asynchronous request to delete the share if it already exists.
DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to delete the share if it already exists.
DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to delete the share if it already exists.
DeleteIfExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to delete the share if it already exists.
DeleteIfExistsAsync(DeleteShareSnapshotsOption, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to delete the share if it already exists.
EndCreate(IAsyncResult)	Ends an asynchronous operation to create a share.
EndCreateIfNotExists(IAsyncResult)	Returns the result of an asynchronous request to create the share if it does not already exist.
EndDelete(IAsyncResult)	Ends an asynchronous operation to delete a share.
EndDeleteIfExists(IAsyncResult)	Returns the result of an asynchronous request to delete the share if it already exists.
EndExists(IAsyncResult)	Returns the asynchronous result of the request to check whether the share exists.
EndFetchAttributes(IAsyncResult)	Ends an asynchronous operation to retrieve the share's attributes.
EndGetPermissions(IAsyncResult)	Returns the asynchronous result of the request to get the permissions settings for the share.
EndGetStats(IAsyncResult)	Ends an asynchronous operation to get stats for the share.
EndSetMetadata(IAsyncResult)	Ends an asynchronous request operation to set user-defined metadata on the share.
EndSetPermissions(IAsyncResult)	Returns the result of an asynchronous request to set permissions for the share.
EndSetProperties(IAsyncResult)	Ends an asynchronous operation to update the share's properties.
EndSnapshot(IAsyncResult)	Ends an asynchronous operation to create a snapshot of the share.
Exists(FileRequestOptions, OperationContext)	Checks whether the share exists.
ExistsAsync()	Returns a task that performs an asynchronous request to check whether the share exists.
ExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to check whether the share exists.
ExistsAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to check whether the share exists.
ExistsAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to check whether the share exists.
FetchAttributes(AccessCondition, FileRequestOptions, OperationContext)	Retrieves the share's attributes.
FetchAttributesAsync()	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
FetchAttributesAsync(CancellationToken)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
GetFilePermission(String, FileRequestOptions, OperationContext)	Gets a File Permission.
GetFilePermissionAsync(String, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Gets a File Permission.
GetPermissions(AccessCondition, FileRequestOptions, OperationContext)	Gets the permissions settings for the share.
GetPermissionsAsync()	Initiates an asynchronous operation that gets the permissions settings for the share.
GetPermissionsAsync(AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation that gets the permissions settings for the share.
GetPermissionsAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets the permissions settings for the share.
GetPermissionsAsync(CancellationToken)	Initiates an asynchronous operation that gets the permissions settings for the share.
GetRootDirectoryReference()	Returns a reference to the root directory for this share.
GetSharedAccessSignature(SharedAccessFilePolicy)	Returns a shared access signature for the share.
GetSharedAccessSignature(SharedAccessFilePolicy, String)	Returns a shared access signature for the share.
GetSharedAccessSignature(SharedAccessFilePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)	Returns a shared access signature for the share.
GetStats(FileRequestOptions, OperationContext)	Gets stats for the share.
GetStatsAsync()	Initiates an asynchronous operation to get stats for the share.
GetStatsAsync(CancellationToken)	Initiates an asynchronous operation to get stats for the share.
GetStatsAsync(FileRequestOptions, OperationContext)	Initiates an asynchronous operation to get stats for the share.
GetStatsAsync(FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get stats for the share.
SetMetadata(AccessCondition, FileRequestOptions, OperationContext)	Sets the share's user-defined metadata.
SetMetadataAsync()	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
SetMetadataAsync(CancellationToken)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
SetPermissions(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext)	Sets permissions for the share.
SetPermissionsAsync(FileSharePermissions)	Initiates an asynchronous operation that sets permissions for the share.
SetPermissionsAsync(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation that sets permissions for the share.
SetPermissionsAsync(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that sets permissions for the share.
SetPermissionsAsync(FileSharePermissions, CancellationToken)	Initiates an asynchronous operation that sets permissions for the share.
SetProperties(AccessCondition, FileRequestOptions, OperationContext)	Updates the share's properties.
SetPropertiesAsync()	Initiates an asynchronous operation to update the share's properties.
SetPropertiesAsync(AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation to update the share's properties.
SetPropertiesAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to update the share's properties.
SetPropertiesAsync(CancellationToken)	Initiates an asynchronous operation to update the share's properties.
Snapshot(IDictionary<String,String>, AccessCondition, FileRequestOptions, OperationContext)	Creates a snapshot of the share.
SnapshotAsync()	Initiates an asynchronous operation to create a snapshot of the share.
SnapshotAsync(CancellationToken)	Initiates an asynchronous operation to create a snapshot of the share.
SnapshotAsync(IDictionary<String,String>, AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation to create a snapshot of the share.
SnapshotAsync(IDictionary<String,String>, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to create a snapshot of the share.