Data.Cloud.AzureAPI.TAzureBlobService.ListBlobsXML

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function ListBlobsXML(ContainerName: string; OptionalParams: TStrings = nil;  ResponseInfo: TCloudResponseInfo = nil): string; overload; deprecated 'Use overloaded method instead';

C++

System::UnicodeString __fastcall ListBlobsXML _DEPRECATED_ATTRIBUTE1("Use overloaded method instead") (System::UnicodeString ContainerName, System::Classes::TStrings* OptionalParams = (System::Classes::TStrings*)(0x0), Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

Properties

Type Visibility Source Unit Parent
function public
Data.Cloud.AzureAPI.pas
Data.Cloud.AzureAPI.hpp
Data.Cloud.AzureAPI TAzureBlobService

Description

Warning: ListBlobsXML is deprecated.

Returns the list of blobs for the given container in XML representation.

ListBlobsXML is used to return the XML representation of the container's blobs.

The following table describes the parameters:

Parameter Description

ContainerName

The container to get the blobs for, or $root for the root container.

OptionalParams

The optional parameter name/value pairs.

ResponseInfo

The optional class for storing response info into.

The following optional parameters are supported: prefix, delimiter, marker, maxresults, include={snapshots,metadata,uncommittedblobs}.

If prefix is specified, only blobs with names starting with the specified prefix are shown.

If delimiter is specified, then any blob with a name (after the prefix string) containing the delimiter string will be grouped into a 'BlobPrefix' node, as appropriate. The grouping provides a way to view the blobs with a virtual directory structure, where you can then take the values of the returned 'BlobPrefix' name nodes, and use those as prefix values for subsequent calls.

If marker is specified, it is used as a continuation token to retrieve more blobs from where a previous invocation left off when it was not able to return all the blobs.

If maxresults is specified, then it is treated as an integer representing the maximum number of blobs to return. The default (and maximum) is 5000. If more blobs exist than maxresults allows, then the NextMarker in the XML will be populated, and you can use this as the value of marker in a future call.

If include is specified, it can have a comma-separated values (CSV) string of one or more of the following:

  • snapshots—include blob snapshots in the response (ordered oldest to newest).
  • metadata—include each blob's metadata in the response.
  • uncommittedblobs—include blobs with uncommitted sections in the response.

Warning: Note that blobs under the $root container cannot have a slash in their name.

See Also