CloudBlobClient.ListContainers Method

  • Reference

Definition

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

Returns an enumerable collection of containers whose names begin with the specified prefix and that are retrieved lazily.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.CloudBlobContainer> ListContainers (string prefix = default, Microsoft.Azure.Storage.Blob.ContainerListingDetails detailsIncluded = Microsoft.Azure.Storage.Blob.ContainerListingDetails.None, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListContainers : string * Microsoft.Azure.Storage.Blob.ContainerListingDetails * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Blob.CloudBlobContainer>
override this.ListContainers : string * Microsoft.Azure.Storage.Blob.ContainerListingDetails * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Blob.CloudBlobContainer>
Public Overridable Function ListContainers (Optional prefix As String = Nothing, Optional detailsIncluded As ContainerListingDetails = Microsoft.Azure.Storage.Blob.ContainerListingDetails.None, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of CloudBlobContainer)

Parameters

prefix
String

A string containing the container name prefix.

detailsIncluded
ContainerListingDetails

A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.

options
BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext
OperationContext

An OperationContext object that represents the context for the current operation.

Returns

IEnumerable<CloudBlobContainer>

An enumerable collection of CloudBlobContainer objects that are retrieved lazily.

Attributes
DoesServiceRequestAttribute

Applies to