CloudFileClient.ListSharesSegmentedAsync Method
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.
Overloads
| 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. |
| 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(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, 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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (string prefix, Microsoft.Azure.Storage.File.ShareListingDetails detailsIncluded, int? maxResults, Microsoft.Azure.Storage.File.FileContinuationToken currentToken, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (prefix As String, detailsIncluded As ShareListingDetails, maxResults As Nullable(Of Integer), currentToken As FileContinuationToken, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of ShareResultSegment)Parameters
- prefix
- String
The share name prefix.
- detailsIncluded
- ShareListingDetails
A value that indicates whether to return share metadata with the listing.
A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.
- currentToken
- FileContinuationToken
A continuation token returned by a previous listing operation.
- options
- FileRequestOptions
A FileRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (string prefix, Microsoft.Azure.Storage.File.ShareListingDetails detailsIncluded, int? maxResults, Microsoft.Azure.Storage.File.FileContinuationToken currentToken, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (prefix As String, detailsIncluded As ShareListingDetails, maxResults As Nullable(Of Integer), currentToken As FileContinuationToken, options As FileRequestOptions, operationContext As OperationContext) As Task(Of ShareResultSegment)Parameters
- prefix
- String
The share name prefix.
- detailsIncluded
- ShareListingDetails
A value that indicates whether to return share metadata with the listing.
A non-negative integer value that indicates the maximum number of results to be returned in the result segment, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.
- currentToken
- FileContinuationToken
A continuation token returned by a previous listing operation.
- options
- FileRequestOptions
A FileRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (string prefix, Microsoft.Azure.Storage.File.FileContinuationToken currentToken, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.FileContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.FileContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (prefix As String, currentToken As FileContinuationToken, cancellationToken As CancellationToken) As Task(Of ShareResultSegment)Parameters
- prefix
- String
The share name prefix.
- currentToken
- FileContinuationToken
A continuation token returned by a previous listing operation.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
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.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (string prefix, Microsoft.Azure.Storage.File.FileContinuationToken currentToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.FileContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : string * Microsoft.Azure.Storage.File.FileContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (prefix As String, currentToken As FileContinuationToken) As Task(Of ShareResultSegment)Parameters
- prefix
- String
The share name prefix.
- currentToken
- FileContinuationToken
A continuation token returned by a previous listing operation.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
ListSharesSegmentedAsync(FileContinuationToken, CancellationToken)
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (Microsoft.Azure.Storage.File.FileContinuationToken currentToken, System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (currentToken As FileContinuationToken, cancellationToken As CancellationToken) As Task(Of ShareResultSegment)Parameters
- currentToken
- FileContinuationToken
A FileContinuationToken token returned by a previous listing operation.
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
ListSharesSegmentedAsync(FileContinuationToken)
Returns a task that performs an asynchronous request to return a result segment containing a collection of shares.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment> ListSharesSegmentedAsync (Microsoft.Azure.Storage.File.FileContinuationToken currentToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>
override this.ListSharesSegmentedAsync : Microsoft.Azure.Storage.File.FileContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.File.ShareResultSegment>Public Overridable Function ListSharesSegmentedAsync (currentToken As FileContinuationToken) As Task(Of ShareResultSegment)Parameters
- currentToken
- FileContinuationToken
A FileContinuationToken token returned by a previous listing operation.
Returns
A Task<TResult> object that represents the current operation.
- Attributes
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for