Storage Client Library for Windows Phone (Version 7.0)

Represents a share in the Windows Azure File service.

Namespace:   Microsoft.WindowsAzure.Storage.File
Assembly:  Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Inheritance Hierarchy

System.::..Object
  Microsoft.WindowsAzure.Storage.File.::..CloudFileShare

Syntax

C#

Copy Code

 

public class CloudFileShare

C++

Copy Code

 

public ref class CloudFileShare 

F#

Copy Code

 

type CloudFileShare = class end

VB

Copy Code

 

Public Class CloudFileShare

Constructors

	Name	Description
	CloudFileShare(StorageUri, StorageCredentials)(StorageUri^, StorageCredentials^)(StorageUri, StorageCredentials)(StorageUri, StorageCredentials)	Initializes a new instance of the CloudFileShare class.
	CloudFileShare(Uri)(Uri^)(Uri)(Uri)	Initializes a new instance of the CloudFileShare class.
	CloudFileShare(Uri, StorageCredentials)(Uri^, StorageCredentials^)(Uri, StorageCredentials)(Uri, StorageCredentials)	Initializes a new instance of the CloudFileShare class.

Properties

	Name	Description
	MetadataMetadataMetadataMetadata	Gets the share's metadata.
	NameNameNameName	Gets the name of the share.
	PropertiesPropertiesPropertiesProperties	Gets the share's system properties.
	ServiceClientServiceClientServiceClientServiceClient	Gets the service client for the share.
	StorageUriStorageUriStorageUriStorageUri	Gets the list of URIs for all locations.
	UriUriUriUri	Gets the share's URI.

Methods

	Name	Description
	BeginCreate(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to create a share.
	BeginCreate(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a share.
	BeginCreateIfNotExists(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous request to create the share if it does not already exist.
	BeginCreateIfNotExists(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the share if it does not already exist.
	BeginDelete(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a share.
	BeginDelete(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to delete a share.
	BeginDeleteIfExists(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to delete the share if it already exists.
	BeginDeleteIfExists(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous request to delete the share if it already exists.
	BeginExists(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous request to check whether the share exists.
	BeginExists(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to check whether the share exists.
	BeginFetchAttributes(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to retrieve the share's attributes.
	BeginFetchAttributes(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to retrieve the share's attributes.
	BeginGetPermissions(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the share.
	BeginGetPermissions(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous request to get the permissions settings for the share.
	BeginGetStats(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to get stats for the share.
	BeginGetStats(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(FileRequestOptions, OperationContext, AsyncCallback, Object)(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get stats for the share.
	BeginSetMetadata(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the share.
	BeginSetMetadata(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to set user-defined metadata on the share.
	BeginSetPermissions(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(FileSharePermissions^, AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the share.
	BeginSetPermissions(FileSharePermissions, AsyncCallback, Object)(FileSharePermissions^, AsyncCallback^, Object^)(FileSharePermissions, AsyncCallback, Object)(FileSharePermissions, AsyncCallback, Object)	Begins an asynchronous request to set permissions for the share.
	BeginSetProperties(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to update the share's properties.
	BeginSetProperties(AsyncCallback, Object)(AsyncCallback^, Object^)(AsyncCallback, Object)(AsyncCallback, Object)	Begins an asynchronous operation to update the share's properties.
	CreateAsync()()()()	Returns a task that performs an asynchronous operation to create a share.
	CreateAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous operation to create a share.
	CreateAsync(FileRequestOptions, OperationContext)(FileRequestOptions^, OperationContext^)(FileRequestOptions, OperationContext)(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to create a share.
	CreateAsync(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions^, OperationContext^, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to create a share.
	CreateIfNotExistsAsync()()()()	Returns a task that performs an asynchronous request to create the share if it does not already exist.
	CreateIfNotExistsAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
	CreateIfNotExistsAsync(FileRequestOptions, OperationContext)(FileRequestOptions^, OperationContext^)(FileRequestOptions, OperationContext)(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
	CreateIfNotExistsAsync(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions^, OperationContext^, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to create the share if it does not already exist.
	DeleteAsync()()()()	Returns a task that performs an asynchronous operation to delete a share.
	DeleteAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to delete a share.
	DeleteAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to delete a share.
	DeleteAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous operation to delete a share.
	DeleteIfExistsAsync()()()()	Returns a task that performs an asynchronous request to delete the share if it already exists.
	DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to delete the share if it already exists.
	DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to delete the share if it already exists.
	DeleteIfExistsAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous request to delete the share if it already exists.
	EndCreate(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous operation to create a share.
	EndCreateIfNotExists(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Returns the result of an asynchronous request to create the share if it does not already exist.
	EndDelete(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous operation to delete a share.
	EndDeleteIfExists(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Returns the result of an asynchronous request to delete the share if it already exists.
	EndExists(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Returns the asynchronous result of the request to check whether the share exists.
	EndFetchAttributes(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous operation to retrieve the share's attributes.
	EndGetPermissions(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Returns the asynchronous result of the request to get the permissions settings for the share.
	EndGetStats(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous operation to get stats for the share.
	EndSetMetadata(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous request operation to set user-defined metadata on the share.
	EndSetPermissions(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Returns the result of an asynchronous request to set permissions for the share.
	EndSetProperties(IAsyncResult)(IAsyncResult^)(IAsyncResult)(IAsyncResult)	Ends an asynchronous operation to update the share's properties.
	Equals(Object)(Object^)(Object)(Object)	(Inherited from Object.)
	ExistsAsync()()()()	Returns a task that performs an asynchronous request to check whether the share exists.
	ExistsAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous request to check whether the share exists.
	ExistsAsync(FileRequestOptions, OperationContext)(FileRequestOptions^, OperationContext^)(FileRequestOptions, OperationContext)(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to check whether the share exists.
	ExistsAsync(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions^, OperationContext^, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to check whether the share exists.
	FetchAttributesAsync()()()()	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
	FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
	FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
	FetchAttributesAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous operation to retrieve the share's attributes.
	Finalize()()()()	(Inherited from Object.)
	GetHashCode()()()()	(Inherited from Object.)
	GetPermissionsAsync()()()()	Initiates an asynchronous operation that gets the permissions settings for the share.
	GetPermissionsAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation that gets the permissions settings for the share.
	GetPermissionsAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that gets the permissions settings for the share.
	GetPermissionsAsync(CancellationToken)(CancellationToken)(CancellationToken)(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)(SharedAccessFilePolicy^)(SharedAccessFilePolicy)(SharedAccessFilePolicy)	Returns a shared access signature for the share.
	GetSharedAccessSignature(SharedAccessFilePolicy, String)(SharedAccessFilePolicy^, String^)(SharedAccessFilePolicy, String)(SharedAccessFilePolicy, String)	Returns a shared access signature for the share.
	GetSharedAccessSignature(SharedAccessFilePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)(SharedAccessFilePolicy^, String^, Nullable<SharedAccessProtocol>, IPAddressOrRange^)(SharedAccessFilePolicy, String, Nullable<SharedAccessProtocol>, IPAddressOrRange)(SharedAccessFilePolicy, String, Nullable(Of SharedAccessProtocol), IPAddressOrRange)	Returns a shared access signature for the share.
	GetStatsAsync()()()()	Initiates an asynchronous operation to get stats for the share.
	GetStatsAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Initiates an asynchronous operation to get stats for the share.
	GetStatsAsync(FileRequestOptions, OperationContext)(FileRequestOptions^, OperationContext^)(FileRequestOptions, OperationContext)(FileRequestOptions, OperationContext)	Initiates an asynchronous operation to get stats for the share.
	GetStatsAsync(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions^, OperationContext^, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)(FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to get stats for the share.
	GetType()()()()	(Inherited from Object.)
	MemberwiseClone()()()()	(Inherited from Object.)
	SetMetadataAsync()()()()	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
	SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
	SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
	SetMetadataAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Returns a task that performs an asynchronous operation to set user-defined metadata on the share.
	SetPermissionsAsync(FileSharePermissions)(FileSharePermissions^)(FileSharePermissions)(FileSharePermissions)	Initiates an asynchronous operation that sets permissions for the share.
	SetPermissionsAsync(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext)(FileSharePermissions^, AccessCondition^, FileRequestOptions^, OperationContext^)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation that sets permissions for the share.
	SetPermissionsAsync(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(FileSharePermissions^, AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(FileSharePermissions, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that sets permissions for the share.
	SetPermissionsAsync(FileSharePermissions, CancellationToken)(FileSharePermissions^, CancellationToken)(FileSharePermissions, CancellationToken)(FileSharePermissions, CancellationToken)	Initiates an asynchronous operation that sets permissions for the share.
	SetPropertiesAsync()()()()	Initiates an asynchronous operation to update the share's properties.
	SetPropertiesAsync(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition^, FileRequestOptions^, OperationContext^)(AccessCondition, FileRequestOptions, OperationContext)(AccessCondition, FileRequestOptions, OperationContext)	Initiates an asynchronous operation to update the share's properties.
	SetPropertiesAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition^, FileRequestOptions^, OperationContext^, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to update the share's properties.
	SetPropertiesAsync(CancellationToken)(CancellationToken)(CancellationToken)(CancellationToken)	Initiates an asynchronous operation to update the share's properties.
	ToString()()()()	(Inherited from Object.)

Remarks

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

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.WindowsAzure.Storage.File Namespace

Return to top