CloudFileClient Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides a client-side logical representation of the Microsoft Azure File service. This client is used to configure and execute requests against the File service.
public class CloudFileClienttype CloudFileClient = classPublic Class CloudFileClient- Inheritance
-
CloudFileClient
Remarks
The service client encapsulates the base URI for the File service. If the service client will be used for authenticated access, it also encapsulates the credentials for accessing the storage account.
Constructors
| CloudFileClient(StorageUri, StorageCredentials, DelegatingHandler) |
Initializes a new instance of the CloudFileClient class using the specified File service endpoint and account credentials. |
| CloudFileClient(Uri, StorageCredentials, DelegatingHandler) |
Initializes a new instance of the CloudFileClient class using the specified File service endpoint and account credentials. |
Properties
| AuthenticationScheme |
Gets or sets the authentication scheme to use to sign HTTP requests. |
| BaseUri |
Gets the base URI for the File service client. |
| BufferManager |
Gets or sets a buffer manager that implements the IBufferManager interface, specifying a buffer pool for use with operations against the File service client. |
| Credentials |
Gets the account credentials used to create the File service client. |
| DefaultRequestOptions |
Gets or sets the default request options for requests made via the File service client. |
| StorageUri |
Gets the list of URIs for all locations. |
Methods
| BeginGetServiceProperties(AsyncCallback, Object) |
Begins an asynchronous operation to get service properties for the File service. |
| BeginGetServiceProperties(FileRequestOptions, OperationContext, AsyncCallback, Object) |
Begins an asynchronous operation to get service properties for the File service. |
| BeginListSharesSegmented(FileContinuationToken, AsyncCallback, Object) |
Begins an asynchronous request to return a result segment containing a collection of shares. |
| BeginListSharesSegmented(String, FileContinuationToken, AsyncCallback, Object) |
Begins an asynchronous request to return a result segment containing a collection of shares. |
| BeginListSharesSegmented(String, ShareListingDetails, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, AsyncCallback, Object) |
Begins an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix. |
| BeginSetServiceProperties(FileServiceProperties, AsyncCallback, Object) |
Begins an asynchronous operation to set service properties for the File service. |
| BeginSetServiceProperties(FileServiceProperties, FileRequestOptions, OperationContext, AsyncCallback, Object) |
Begins an asynchronous operation to set service properties for the File service. |
| EndGetServiceProperties(IAsyncResult) |
Ends an asynchronous operation to get service properties for the File service. |
| EndListSharesSegmented(IAsyncResult) |
Ends an asynchronous operation to return a result segment containing a collection of shares. |
| EndSetServiceProperties(IAsyncResult) |
Ends an asynchronous operation to set service properties for the Blob service. |
| GetServiceProperties(FileRequestOptions, OperationContext) |
Gets service properties for the File service. |
| GetServicePropertiesAsync() |
Initiates an asynchronous operation to get service properties for the File service. |
| GetServicePropertiesAsync(CancellationToken) |
Initiates an asynchronous operation to get service properties for the File service. |
| GetServicePropertiesAsync(FileRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to get service properties for the File service. |
| GetServicePropertiesAsync(FileRequestOptions, OperationContext) |
Initiates an asynchronous operation to get service properties for the File service. |
| GetShareReference(String, Nullable<DateTimeOffset>) |
Returns a reference to a CloudFileShare object with the specified name and snapshot time. |
| GetShareReference(String) |
Returns a reference to a CloudFileShare object with the specified name. |
| ListShares(String, ShareListingDetails, FileRequestOptions, OperationContext) |
Returns an enumerable collection of shares, which are retrieved lazily, whose names begin with the specified prefix. |
| ListSharesSegmented(FileContinuationToken) |
Returns a result segment containing a collection of shares. |
| ListSharesSegmented(String, FileContinuationToken) |
Returns a result segment containing a collection of shares. |
| ListSharesSegmented(String, ShareListingDetails, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext) |
Returns a result segment containing a collection of shares whose names begin with the specified prefix. |
| ListSharesSegmentedAsync(FileContinuationToken, CancellationToken) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares. |
| ListSharesSegmentedAsync(FileContinuationToken) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares. |
| ListSharesSegmentedAsync(String, FileContinuationToken, CancellationToken) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix. |
| ListSharesSegmentedAsync(String, FileContinuationToken) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix. |
| ListSharesSegmentedAsync(String, ShareListingDetails, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, CancellationToken) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix. |
| ListSharesSegmentedAsync(String, ShareListingDetails, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext) |
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares whose names begin with the specified prefix. |
| SetServiceProperties(FileServiceProperties, FileRequestOptions, OperationContext) |
Sets service properties for the File service. |
| SetServicePropertiesAsync(FileServiceProperties, CancellationToken) |
Initiates an asynchronous operation that sets service properties for the Blob service. |
| SetServicePropertiesAsync(FileServiceProperties, FileRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation that sets service properties for the File service. |
| SetServicePropertiesAsync(FileServiceProperties, FileRequestOptions, OperationContext) |
Initiates an asynchronous operation that sets service properties for the File service. |
| SetServicePropertiesAsync(FileServiceProperties) |
Initiates an asynchronous operation that sets service properties for the Blob service. |
Applies to
Azure SDK for .NET