Share via

CloudFileClient.ListSharesSegmented Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.File
Assembly:
Microsoft.Azure.Storage.File.dll
Package:
Microsoft.Azure.Storage.File v11.2.3

Overloads

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.

ListSharesSegmented(FileContinuationToken)

Returns a result segment containing a collection of shares.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.File.ShareResultSegment ListSharesSegmented (Microsoft.Azure.Storage.File.FileContinuationToken currentToken);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmented : Microsoft.Azure.Storage.File.FileContinuationToken -> Microsoft.Azure.Storage.File.ShareResultSegment
override this.ListSharesSegmented : Microsoft.Azure.Storage.File.FileContinuationToken -> Microsoft.Azure.Storage.File.ShareResultSegment
Public Overridable Function ListSharesSegmented (currentToken As FileContinuationToken) As ShareResultSegment

Parameters

currentToken
FileContinuationToken

A FileContinuationToken token returned by a previous listing operation.

Returns

ShareResultSegment

A result segment of shares.

Attributes
DoesServiceRequestAttribute

Applies to

ListSharesSegmented(String, FileContinuationToken)

Returns a result segment containing a collection of shares.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.File.ShareResultSegment ListSharesSegmented (string prefix, Microsoft.Azure.Storage.File.FileContinuationToken currentToken);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmented : string * Microsoft.Azure.Storage.File.FileContinuationToken -> Microsoft.Azure.Storage.File.ShareResultSegment
override this.ListSharesSegmented : string * Microsoft.Azure.Storage.File.FileContinuationToken -> Microsoft.Azure.Storage.File.ShareResultSegment
Public Overridable Function ListSharesSegmented (prefix As String, currentToken As FileContinuationToken) As ShareResultSegment

Parameters

prefix
String

The share name prefix.

currentToken
FileContinuationToken

A continuation token returned by a previous listing operation.

Returns

ShareResultSegment

A result segment of shares.

Attributes
DoesServiceRequestAttribute

Applies to

ListSharesSegmented(String, ShareListingDetails, Nullable<Int32>, FileContinuationToken, FileRequestOptions, OperationContext)

Returns a result segment containing a collection of shares whose names begin with the specified prefix.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.File.ShareResultSegment ListSharesSegmented (string prefix, Microsoft.Azure.Storage.File.ShareListingDetails detailsIncluded, int? maxResults, Microsoft.Azure.Storage.File.FileContinuationToken currentToken, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListSharesSegmented : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.File.ShareResultSegment
override this.ListSharesSegmented : string * Microsoft.Azure.Storage.File.ShareListingDetails * Nullable<int> * Microsoft.Azure.Storage.File.FileContinuationToken * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.File.ShareResultSegment
Public Overridable Function ListSharesSegmented (prefix As String, detailsIncluded As ShareListingDetails, maxResults As Nullable(Of Integer), currentToken As FileContinuationToken, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As ShareResultSegment

Parameters

prefix
String

The share name prefix.

detailsIncluded
ShareListingDetails

A value that indicates whether to return share metadata with the listing.

maxResults
Nullable<Int32>

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

ShareResultSegment

A result segment of shares.

Attributes
DoesServiceRequestAttribute

Applies to