Microsoft.Azure.Storage.File.CloudFileDirectory
Represents a directory of files, designated by a delimiter character.
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.
Gets the user-defined metadata for the directory.
Gets the name of the directory.
Gets a CloudFileDirectory object that represents the parent directory for the directory.
Gets a FileDirectoryProperties object that represents the directory's system properties.
Gets a CloudFileClient object that specifies the endpoint for the File service.
Gets a CloudFileShare object that represents the share for the directory.
Gets the directory's URI for both the primary and secondary locations, including query string information if the directory's share is a snapshot.
Gets the absolute URI to the directory, including query string information if the directory's share is a snapshot.
Gets the file directory's URIs for all locations.
Gets the directory's URI for the primary location.
Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.
Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.
Initializes a new instance of the CloudFileDirectory class using an absolute URI to the directory.
public virtual ICancellableAsyncResult BeginCloseAllHandlesSegmented(FileContinuationToken token, bool? recursive, AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to close all SMB handles on this directory.
public virtual ICancellableAsyncResult BeginCloseHandleSegmented(string handleId, FileContinuationToken token, bool? recursive, AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to close the specified SMB handle on this directory.
Begins an asynchronous operation to create a directory.
public virtual ICancellableAsyncResult BeginCreate(FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to create a directory.
Begins an asynchronous request to create the directory if it does not already exist.
public virtual ICancellableAsyncResult BeginCreateIfNotExists(FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous request to create the directory if it does not already exist.
Begins an asynchronous operation to delete a directory.
public virtual ICancellableAsyncResult BeginDelete(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to delete a directory.
Begins an asynchronous request to delete the directory if it already exists.
public virtual ICancellableAsyncResult BeginDeleteIfExists(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous request to delete the directory if it already exists.
Begins an asynchronous request to check whether the directory exists.
public virtual ICancellableAsyncResult BeginExists(FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous request to check whether the directory exists.
Begins an asynchronous operation to populate the directory's properties.
public virtual ICancellableAsyncResult BeginFetchAttributes(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to populate the directory's properties and metadata.
public virtual ICancellableAsyncResult BeginListFilesAndDirectoriesSegmented(FileContinuationToken currentToken, AsyncCallback callback, object state)
Begins an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual ICancellableAsyncResult BeginListFilesAndDirectoriesSegmented(int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to return a result segment containing a collection of file items
in the share.
public ICancellableAsyncResult BeginListFilesAndDirectoriesSegmented(string prefix, int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual ICancellableAsyncResult BeginListHandlesSegmented(FileContinuationToken token, int? maxResults, bool? recursive, AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to get the SMB handles open on this directory.
Begins an asynchronous operation to update the directory's metadata.
public virtual ICancellableAsyncResult BeginSetMetadata(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state)
Begins an asynchronous operation to update the directory's metadata.
public virtual CloseFileHandleResultSegment CloseAllHandlesSegmented(FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Closes all SMB handles on this file.
public virtual Task<CloseFileHandleResultSegment> CloseAllHandlesSegmentedAsync(FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null, CancellationToken? cancellationToken = default)
Returns a task that performs an asynchronous operation to close all SMB handles on this directory.
public virtual CloseFileHandleResultSegment CloseHandleSegmented(string handleId, FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Closes the specified SMB handle on this directory.
public virtual CloseFileHandleResultSegment CloseHandleSegmented(ulong handleId, FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Closes the specified SMB handle on this directory.
public virtual Task<CloseFileHandleResultSegment> CloseHandleSegmentedAsync(string handleId, FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null, CancellationToken? cancellationToken = default)
Returns a task that performs an asynchronous operation to close the specified SMB handle on this directory.
public virtual Task<CloseFileHandleResultSegment> CloseHandleSegmentedAsync(ulong handleId, FileContinuationToken token = null, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null, CancellationToken? cancellationToken = default)
Returns a task that performs an asynchronous operation to close the specified SMB handle on this directory.
public virtual void Create(FileRequestOptions requestOptions = null, OperationContext operationContext = null)
Creates the directory.
Returns a task that performs an asynchronous operation to create a directory.
Returns a task that performs an asynchronous operation to create a directory.
Returns a task that performs an asynchronous operation to create a directory.
public virtual Task CreateAsync(FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to create a directory.
public virtual bool CreateIfNotExists(FileRequestOptions requestOptions = null, OperationContext operationContext = null)
Creates the directory if it does not already exist.
Returns a task that performs an asynchronous request to create the directory if it does not already exist.
Returns a task that performs an asynchronous request to create the directory if it does not already exist.
public virtual Task<bool> CreateIfNotExistsAsync(FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous request to create the directory if it does not already exist.
public virtual Task<bool> CreateIfNotExistsAsync(FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous request to create the directory if it does not already exist.
public virtual void Delete(AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Deletes the directory.
Returns a task that performs an asynchronous operation to delete a directory.
Returns a task that performs an asynchronous operation to delete a directory.
public virtual Task DeleteAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous operation to delete a directory.
public virtual Task DeleteAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to delete a directory.
public virtual bool DeleteIfExists(AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Deletes the directory if it already exists.
Returns a task that performs an asynchronous request to delete the directory if it already exists.
Returns a task that performs an asynchronous request to delete the directory if it already exists.
public virtual Task<bool> DeleteIfExistsAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous request to delete the directory if it already exists.
public virtual Task<bool> DeleteIfExistsAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous request to delete the directory if it already exists.
Ends an asynchronous operation to close all SMB handles on this directory.
Ends an asynchronous operation to close the specified SMB handle on this directory.
Ends an asynchronous operation to create a directory.
Returns the result of an asynchronous request to create the directory if it does not already exist.
Ends an asynchronous operation to delete a directory.
Returns the result of an asynchronous request to delete the directory if it already exists.
Returns the asynchronous result of the request to check whether the directory exists.
Ends an asynchronous operation to populate the directory's properties and metadata.
Ends an asynchronous operation to return a result segment containing a collection of file items
in the share.
Ends an asynchronous operation to get the SMB handles open on this file.
Ends an asynchronous operation to update the directory's metadata.
public virtual bool Exists(FileRequestOptions requestOptions = null, OperationContext operationContext = null)
Checks whether the directory exists.
Returns a task that performs an asynchronous request to check whether the directory exists.
Returns a task that performs an asynchronous request to check whether the directory exists.
public virtual Task<bool> ExistsAsync(FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous request to check whether the directory exists.
public virtual Task<bool> ExistsAsync(FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous request to check whether the directory exists.
public virtual void FetchAttributes(AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Populates a directory's properties.
Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
public virtual Task FetchAttributesAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
public virtual Task FetchAttributesAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to populate the directory's properties and metadata.
Returns a CloudFileDirectory object that represents a subdirectory within this directory.
Returns a CloudFile object that represents a file in this directory.
public virtual IEnumerable<IListFileItem> ListFilesAndDirectories(FileRequestOptions options = null, OperationContext operationContext = null)
Returns an enumerable collection of the files in the share, which are retrieved lazily.
public IEnumerable<IListFileItem> ListFilesAndDirectories(string prefix, FileRequestOptions options = null, OperationContext operationContext = null)
Returns an enumerable collection of the files in the share, which are retrieved lazily.
public virtual FileResultSegment ListFilesAndDirectoriesSegmented(FileContinuationToken currentToken)
Returns a result segment containing a collection of file items
in the share.
public virtual FileResultSegment ListFilesAndDirectoriesSegmented(int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext)
Returns a result segment containing a collection of file items
in the share.
public FileResultSegment ListFilesAndDirectoriesSegmented(string prefix, int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext)
Returns a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(FileContinuationToken currentToken)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(FileContinuationToken currentToken, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(string prefix, FileContinuationToken currentToken, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual Task<FileResultSegment> ListFilesAndDirectoriesSegmentedAsync(string prefix, int? maxResults, FileContinuationToken currentToken, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to return a result segment containing a collection of file items
in the share.
public virtual FileHandleResultSegment ListHandlesSegmented(FileContinuationToken token = null, int? maxResults = default, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Gets the SMB handles open on this directory.
public virtual Task<FileHandleResultSegment> ListHandlesSegmentedAsync(FileContinuationToken token = null, int? maxResults = default, bool? recursive = default, AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null, CancellationToken? cancellationToken = default)
Returns a task that performs an asynchronous operation to get the SMB handles open on this directory.
public virtual void SetMetadata(AccessCondition accessCondition = null, FileRequestOptions options = null, OperationContext operationContext = null)
Updates the directory's metadata.
Returns a task that performs an asynchronous operation to update the directory's metadata.
Returns a task that performs an asynchronous operation to update the directory's metadata.
public virtual Task SetMetadataAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext)
Returns a task that performs an asynchronous operation to update the directory's metadata.
public virtual Task SetMetadataAsync(AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)
Returns a task that performs an asynchronous operation to update the directory's metadata.
public virtual void SetProperties(FileRequestOptions options = null, OperationContext operationContext = null)
Updates the directory's properties.
public virtual Task SetPropertiesAsync(FileRequestOptions options = null, OperationContext operationContext = null, CancellationToken? cancellationToken = default)
Updates the directory's properties.