CloudFileDirectory Class

Reference

Definition

Namespace:: Microsoft.Azure.Storage.File

Assembly:: Microsoft.Azure.Storage.File.dll

Package:: Microsoft.Azure.Storage.File v11.2.3

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.

Represents a directory of files, designated by a delimiter character.

public class CloudFileDirectory : Microsoft.Azure.Storage.File.IListFileItem

type CloudFileDirectory = class
    interface IListFileItem

Public Class CloudFileDirectory
Implements IListFileItem

Inheritance: Object
CloudFileDirectory

Implements: IListFileItem

Remarks

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

Constructors

CloudFileDirectory(StorageUri, StorageCredentials)	Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.
CloudFileDirectory(Uri)	Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.
CloudFileDirectory(Uri, StorageCredentials)	Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.

Properties

FilePermission	Gets or sets the file permission for this directory. This field will be null after Directory.Create, Directory.SetProperties, Directory.GetProperties, and Directory.Get calls.
Metadata	Gets the user-defined metadata for the directory.
Name	Gets the name of the directory.
Parent	Gets a CloudFileDirectory object that represents the parent directory for the directory.
Properties	Gets a FileDirectoryProperties object that represents the directory's system properties.
ServiceClient	Gets a CloudFileClient object that specifies the endpoint for the File service.
Share	Gets a CloudFileShare object that represents the share for the directory.
SnapshotQualifiedStorageUri	Gets the directory's URI for both the primary and secondary locations, including query string information if the directory's share is a snapshot.
SnapshotQualifiedUri	Gets the absolute URI to the directory, including query string information if the directory's share is a snapshot.
StorageUri	Gets the file directory's URIs for all locations.
Uri	Gets the directory's URI for the primary location.

Methods

BeginCloseAllHandlesSegmented(FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to close all SMB handles on this directory.
BeginCloseHandleSegmented(String, FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to close the specified SMB handle on this directory.
BeginCreate(AsyncCallback, Object)	Begins an asynchronous operation to create a directory.
BeginCreate(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to create a directory.
BeginCreateIfNotExists(AsyncCallback, Object)	Begins an asynchronous request to create the directory if it does not already exist.
BeginCreateIfNotExists(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to create the directory if it does not already exist.
BeginDelete(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to delete a directory.
BeginDelete(AsyncCallback, Object)	Begins an asynchronous operation to delete a directory.
BeginDeleteIfExists(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to delete the directory if it already exists.
BeginDeleteIfExists(AsyncCallback, Object)	Begins an asynchronous request to delete the directory if it already exists.
BeginExists(AsyncCallback, Object)	Begins an asynchronous request to check whether the directory exists.
BeginExists(FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous request to check whether the directory exists.
BeginFetchAttributes(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to populate the directory's properties and metadata.
BeginFetchAttributes(AsyncCallback, Object)	Begins an asynchronous operation to populate the directory's properties.
BeginListFilesAndDirectoriesSegmented(FileContinuationToken, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of file items in the share.
BeginListFilesAndDirectoriesSegmented(Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of file items in the share.
BeginListFilesAndDirectoriesSegmented(String, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to return a result segment containing a collection of file items in the share.
BeginListHandlesSegmented(FileContinuationToken, Nullable<Int32>, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to get the SMB handles open on this directory.
BeginSetMetadata(AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)	Begins an asynchronous operation to update the directory's metadata.
BeginSetMetadata(AsyncCallback, Object)	Begins an asynchronous operation to update the directory's metadata.
CloseAllHandlesSegmented(FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext)	Closes all SMB handles on this file.
CloseAllHandlesSegmentedAsync(FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Returns a task that performs an asynchronous operation to close all SMB handles on this directory.
CloseHandleSegmented(String, FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext)	Closes the specified SMB handle on this directory.
CloseHandleSegmented(UInt64, FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext)	Closes the specified SMB handle on this directory.
CloseHandleSegmentedAsync(String, FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Returns a task that performs an asynchronous operation to close the specified SMB handle on this directory.
CloseHandleSegmentedAsync(UInt64, FileContinuationToken, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Returns a task that performs an asynchronous operation to close the specified SMB handle on this directory.
Create(FileRequestOptions, OperationContext)	Creates the directory.
CreateAsync()	Returns a task that performs an asynchronous operation to create a directory.
CreateAsync(CancellationToken)	Returns a task that performs an asynchronous operation to create a directory.
CreateAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to create a directory.
CreateAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to create a directory.
CreateIfNotExists(FileRequestOptions, OperationContext)	Creates the directory if it does not already exist.
CreateIfNotExistsAsync()	Returns a task that performs an asynchronous request to create the directory if it does not already exist.
CreateIfNotExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to create the directory if it does not already exist.
CreateIfNotExistsAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to create the directory if it does not already exist.
CreateIfNotExistsAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to create the directory if it does not already exist.
Delete(AccessCondition, FileRequestOptions, OperationContext)	Deletes the directory.
DeleteAsync()	Returns a task that performs an asynchronous operation to delete a directory.
DeleteAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to delete a directory.
DeleteAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to delete a directory.
DeleteAsync(CancellationToken)	Returns a task that performs an asynchronous operation to delete a directory.
DeleteIfExists(AccessCondition, FileRequestOptions, OperationContext)	Deletes the directory if it already exists.
DeleteIfExistsAsync()	Returns a task that performs an asynchronous request to delete the directory if it already exists.
DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to delete the directory if it already exists.
DeleteIfExistsAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to delete the directory if it already exists.
DeleteIfExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to delete the directory if it already exists.
EndCloseAllHandlesSegmented(IAsyncResult)	Ends an asynchronous operation to close all SMB handles on this directory.
EndCloseHandleSegmented(IAsyncResult)	Ends an asynchronous operation to close the specified SMB handle on this directory.
EndCreate(IAsyncResult)	Ends an asynchronous operation to create a directory.
EndCreateIfNotExists(IAsyncResult)	Returns the result of an asynchronous request to create the directory if it does not already exist.
EndDelete(IAsyncResult)	Ends an asynchronous operation to delete a directory.
EndDeleteIfExists(IAsyncResult)	Returns the result of an asynchronous request to delete the directory if it already exists.
EndExists(IAsyncResult)	Returns the asynchronous result of the request to check whether the directory exists.
EndFetchAttributes(IAsyncResult)	Ends an asynchronous operation to populate the directory's properties and metadata.
EndListFilesAndDirectoriesSegmented(IAsyncResult)	Ends an asynchronous operation to return a result segment containing a collection of file items in the share.
EndListHandlesSegmented(IAsyncResult)	Ends an asynchronous operation to get the SMB handles open on this file.
EndSetMetadata(IAsyncResult)	Ends an asynchronous operation to update the directory's metadata.
Exists(FileRequestOptions, OperationContext)	Checks whether the directory exists.
ExistsAsync()	Returns a task that performs an asynchronous request to check whether the directory exists.
ExistsAsync(CancellationToken)	Returns a task that performs an asynchronous request to check whether the directory exists.
ExistsAsync(FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous request to check whether the directory exists.
ExistsAsync(FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous request to check whether the directory exists.
FetchAttributes(AccessCondition, FileRequestOptions, OperationContext)	Populates a directory's properties.
FetchAttributesAsync()	Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
FetchAttributesAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
FetchAttributesAsync(CancellationToken)	Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
GetDirectoryReference(String)	Returns a CloudFileDirectory object that represents a subdirectory within this directory.
GetFileReference(String)	Returns a CloudFile object that represents a file in this directory.
ListFilesAndDirectories(FileRequestOptions, OperationContext)	Returns an enumerable collection of the files in the share, which are retrieved lazily.
ListFilesAndDirectories(String, FileRequestOptions, OperationContext)	Returns an enumerable collection of the files in the share, which are retrieved lazily.
ListFilesAndDirectoriesSegmented(FileContinuationToken)	Returns a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmented(Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext)	Returns a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmented(String, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext)	Returns a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(FileContinuationToken)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(FileContinuationToken, CancellationToken)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(String, FileContinuationToken, CancellationToken)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListFilesAndDirectoriesSegmentedAsync(String, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items in the share.
ListHandlesSegmented(FileContinuationToken, Nullable<Int32>, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext)	Gets the SMB handles open on this directory.
ListHandlesSegmentedAsync(FileContinuationToken, Nullable<Int32>, Nullable<Boolean>, AccessCondition, FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Returns a task that performs an asynchronous operation to get the SMB handles open on this directory.
SetMetadata(AccessCondition, FileRequestOptions, OperationContext)	Updates the directory's metadata.
SetMetadataAsync()	Returns a task that performs an asynchronous operation to update the directory's metadata.
SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to update the directory's metadata.
SetMetadataAsync(AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to update the directory's metadata.
SetMetadataAsync(CancellationToken)	Returns a task that performs an asynchronous operation to update the directory's metadata.
SetProperties(FileRequestOptions, OperationContext)	Updates the directory's properties.
SetPropertiesAsync(FileRequestOptions, OperationContext, Nullable<CancellationToken>)	Updates the directory's properties.

Applies to