CloudFileClient.ListShares Method

Definition

Namespace:

Microsoft.Azure.Storage.File

Assembly:

Microsoft.Azure.Storage.File.dll

Package:

Microsoft.Azure.Storage.File v11.2.3

Returns an enumerable collection of shares, which are retrieved lazily, whose names begin with the specified prefix.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.File.CloudFileShare> ListShares (string prefix = default, Microsoft.Azure.Storage.File.ShareListingDetails detailsIncluded = Microsoft.Azure.Storage.File.ShareListingDetails.None, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListShares : string * Microsoft.Azure.Storage.File.ShareListingDetails * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.File.CloudFileShare>
override this.ListShares : string * Microsoft.Azure.Storage.File.ShareListingDetails * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.File.CloudFileShare>

Public Overridable Function ListShares (Optional prefix As String = Nothing, Optional detailsIncluded As ShareListingDetails = Microsoft.Azure.Storage.File.ShareListingDetails.None, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of CloudFileShare)

Parameters

prefix

String

The share name prefix.

detailsIncluded

ShareListingDetails

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

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

IEnumerable<CloudFileShare>

An enumerable collection of shares that are retrieved lazily.

Attributes

DoesServiceRequestAttribute