CloudBlobClient.ListContainersSegmentedAsync Method (String, ContainerListingDetails, Nullable(Int32), BlobContinuationToken, BlobRequestOptions, OperationContext) (Microsoft.WindowsAzure.Storage.Blob)
From Microsoft Windows Azure Storage Blob
Initiates an asynchronous operation to return a result segment containing a collection of containers.
Namespace:
Microsoft.WindowsAzure.Storage.Blob
Assembly:
Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute]
public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync(
string prefix,
ContainerListingDetails detailsIncluded,
Nullable<int> maxResults,
BlobContinuationToken continuationToken,
BlobRequestOptions options,
OperationContext operationContext
)
C++
public:
[DoesServiceRequestAttribute]
virtual Task<ContainerResultSegment^>^ ListContainersSegmentedAsync(
String^ prefix,
ContainerListingDetails detailsIncluded,
Nullable<int> maxResults,
BlobContinuationToken^ continuationToken,
BlobRequestOptions^ options,
OperationContext^ operationContext
)
[<DoesServiceRequestAttribute>]
abstract ListContainersSegmentedAsync :
prefix:string *
detailsIncluded:ContainerListingDetails *
maxResults:Nullable<int> *
continuationToken:BlobContinuationToken *
options:BlobRequestOptions *
operationContext:OperationContext -> Task<ContainerResultSegment>
[<DoesServiceRequestAttribute>]
override ListContainersSegmentedAsync :
prefix:string *
detailsIncluded:ContainerListingDetails *
maxResults:Nullable<int> *
continuationToken:BlobContinuationToken *
options:BlobRequestOptions *
operationContext:OperationContext -> Task<ContainerResultSegment>
<DoesServiceRequestAttribute>
Public Overridable Function ListContainersSegmentedAsync (
prefix As String,
detailsIncluded As ContainerListingDetails,
maxResults As Nullable(Of Integer),
continuationToken As BlobContinuationToken,
options As BlobRequestOptions,
operationContext As OperationContext
) As Task(Of ContainerResultSegment)
Parameters
- prefix
-
Type:
System.StringSystem::String^System.StringSystem.String
A string containing the container name prefix.
- detailsIncluded
-
Type:
Microsoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob::ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetails
A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.
- maxResults
-
Type:
System.Nullable<Int32>System::Nullable<Int32>System.Nullable<Int32>System.Nullable(Of 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.
- continuationToken
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob::BlobContinuationToken^Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob.BlobContinuationToken
A BlobContinuationToken object returned by a previous listing operation.
- options
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
Return Value
Type:
System.Threading.Tasks.Task<ContainerResultSegment>System.Threading.Tasks::Task<ContainerResultSegment^>^System.Threading.Tasks.Task<ContainerResultSegment>System.Threading.Tasks.Task(Of ContainerResultSegment)A Task<TResult><TResult><'TResult>(Of TResult) object of type ContainerResultSegment that represents the asynchronous operation.
See Also
ListContainersSegmentedAsync Overload
CloudBlobClient Class
Microsoft.WindowsAzure.Storage.Blob Namespace
Return to top
Initiates an asynchronous operation to return a result segment containing a collection of containers.
Syntax
[DoesServiceRequestAttribute] public virtual Task<ContainerResultSegment> ListContainersSegmentedAsync( string prefix, ContainerListingDetails detailsIncluded, Nullable<int> maxResults, BlobContinuationToken continuationToken, BlobRequestOptions options, OperationContext operationContext )
public: [DoesServiceRequestAttribute] virtual Task<ContainerResultSegment^>^ ListContainersSegmentedAsync( String^ prefix, ContainerListingDetails detailsIncluded, Nullable<int> maxResults, BlobContinuationToken^ continuationToken, BlobRequestOptions^ options, OperationContext^ operationContext )
[<DoesServiceRequestAttribute>] abstract ListContainersSegmentedAsync : prefix:string * detailsIncluded:ContainerListingDetails * maxResults:Nullable<int> * continuationToken:BlobContinuationToken * options:BlobRequestOptions * operationContext:OperationContext -> Task<ContainerResultSegment> [<DoesServiceRequestAttribute>] override ListContainersSegmentedAsync : prefix:string * detailsIncluded:ContainerListingDetails * maxResults:Nullable<int> * continuationToken:BlobContinuationToken * options:BlobRequestOptions * operationContext:OperationContext -> Task<ContainerResultSegment>
<DoesServiceRequestAttribute> Public Overridable Function ListContainersSegmentedAsync ( prefix As String, detailsIncluded As ContainerListingDetails, maxResults As Nullable(Of Integer), continuationToken As BlobContinuationToken, options As BlobRequestOptions, operationContext As OperationContext ) As Task(Of ContainerResultSegment)
Parameters
- prefix
-
Type:
System.StringSystem::String^System.StringSystem.String
A string containing the container name prefix.
- detailsIncluded
-
Type:
Microsoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob::ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetailsMicrosoft.WindowsAzure.Storage.Blob.ContainerListingDetails
A ContainerListingDetails enumeration value that indicates whether to return container metadata with the listing.
- maxResults
-
Type:
System.Nullable<Int32>System::Nullable<Int32>System.Nullable<Int32>System.Nullable(Of 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.
- continuationToken
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob::BlobContinuationToken^Microsoft.WindowsAzure.Storage.Blob.BlobContinuationTokenMicrosoft.WindowsAzure.Storage.Blob.BlobContinuationToken
A BlobContinuationToken object returned by a previous listing operation.
- options
-
Type:
Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
Return Value
Type: System.Threading.Tasks.Task<ContainerResultSegment>System.Threading.Tasks::Task<ContainerResultSegment^>^System.Threading.Tasks.Task<ContainerResultSegment>System.Threading.Tasks.Task(Of ContainerResultSegment)A Task<TResult><TResult><'TResult>(Of TResult) object of type ContainerResultSegment that represents the asynchronous operation.
See Also
ListContainersSegmentedAsync Overload
CloudBlobClient Class
Microsoft.WindowsAzure.Storage.Blob Namespace