Azure Storage - List blobs

Declaration

<AMAZURESTORAGE ACTIVITY="list_blobs" RESULTDATASET="text" 
CONTAINER="text" LISTING="text (options)" 
USEFLATLISTING="yes/no" PROTOCOL="text (options)" 
ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" 
BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" 
TIMOUT="number" />

Description: Enumerates the list of blobs under the specified container.

Practical Usage

Commonly used to add header or footer information to a new or existing PDF document which can be used to present consistent data, such as date, time, document title or company logo.

Connection Parameters

Property Type

Required

Default

Markup

Description

Connection

 

 

 

 

Indicates where user credentials and preferences should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are:

  • Host (default) - Specifies that user credentials and/or advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation.

  • Session - Specifies that user credentials and/or advanced preferences are obtained from a pre-configured session created in a prior step with the use of the Azure Storage - Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.

Session

Text

Yes if connection is session-based

AzureStorageSession1

SESSION="MyAzureSession"

The name of an existing session to associate this activity with. This parameter is active only if the Connection parameter is set to Session.

Account name

Text

Yes if connection is host-based

(Empty)

ACCOUNTNAME="myaccount"

The globally unique name of the Windows Azure storage account. This parameter is active only if the Connection parameter is set to Host.

Access key

Text

Yes if connection is host-based

(Empty)

ACCESSKEY="[AccessKey]"

The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. This parameter is active only if the Connection parameter is set to Host.

Protocol

Text (options)

No

HTTPS

  1. PROTOCOL="HTTPS"

  2. PROTOCOL="HTTP"

The type of protocol used to access Azure Storage. The available options are:

  • HTTPS (default) - Hypertext Transfer Protocol Secure

  • HTTP - Hypertext Transfer Protocol

Timeout (seconds)

Number

No

90

TIMEOUT="180"

The timeout interval (in seconds) for requests made to the storage service. If the timeout elapses before a server response is returned, the operation times out and the service returns an error. The default timeout value is 90 seconds.

Blob endpoint URI

Text

No

(Empty)

BLOBENDPOINT="http://accnt

.blob.core.windows.net"

The endpoint for the Blob service, as configured for the Azure Storage account. The default Blob service endpoint is '[http/https]://accountname.blob.core.windows.net', where 'accountname' is the name of the Azure Storage account.

Queue endpoint URI

Text

No

(Empty)

QUEUEENDPOINT="http://accnt

.queue.core.windows.net"

The endpoint for the Queue service, as configured for the Azure storage account. The default Queue service endpoint is '[http/https]://accountname.queue.core.windows.net', where 'accountname'is the name of the Azure Storage account.

Table endpoint URI

Text

No

(Empty)

TABLEENDPOINT="http://accnt

.table.core.windows.net"

The endpoint for the Table service, as configured for the Azure storage account. The default Table service endpoint is '[http|https]://accountname.table.core.windows.net', where 'accountname' is the name of the Azure Storage account.

Proxy type

Text (options)

No

System default

  1. PROXYTYPE="default"

  2. PROXYTYPE="none"

  3. PROXYTYPE="HTTP"

The type of proxy server to connect through (if required). The available options are:

  • System default (default) - Access always passes through a default proxy server.

  • None - No proxy server is required.

  • HTTP - Communication is through an HTTP proxy server.

Proxy server

Text

No

(Empty)

  1. PROXYSERVER="serv.domain.com"

  2. PROXYSERVER="197.264.334.21"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is active only if the Proxy type parameter is set to HTTP.

Proxy port

Number

No

808

PROXYPORT="8080"

The port that is used by the proxy server for client connections. The default value is 808. This parameter is active only if the Proxy type parameter is set to HTTP.

Use authentication

 

 

 

 

If enabled, specifies that the proxy requires authentication before granting access to resources. If disabled (default), no authentication is required. This parameter is active only if the Proxy type parameter is set to HTTP. This is a visual mode parameter only used during design time, therefore, contains no markup.

Proxy username

Text

No

(Empty)

PROXYUSERNAME="theUsername"

The username to authenticate with the proxy server. This parameter is active only if Use authentication parameter is enabled.

Proxy password

Text

No

(Empty)

PROXYPASSWORD="[encrypted]"

The password to authenticate with the proxy server. This parameter is active only if Use authentication parameter is enabled.

Blob Parameters

Property

Type

Required

Default

Markup

Description

Container name

Text

Yes

(Empty)

CONTAINER="mycontainer"

The unique name of the container in which to retrieve the list of blobs from.

Listing details

Text (options)

No

None

  1. LISTING="None"

  2. LISTING="Snapshots"

  3. LISTING="Metadata"

  4. LISTING="UncommittedBlobs"

  5. LISTING="All"

Specifies one or more blob details to include in the response. The available options are:

  • None(details) - No blob details should be included in the response.

  • Snapshots - Snapshots should be included in the enumeration. Snapshots are listed from oldest to newest in the response.

  • Metadata - Blob metadata should be included in the response

  • Uncommitted blobs - Blobs for which blocks have been uploaded, but which have not been committed should be included in the response.

  • All - All blob details should be included in the response.

Use flat listing

Yes/No

No

Yes

SOURCE="C:\PDFFileName.pdf"

If set to Yes, the blob listing operation will list all blobs within a container via a flat listing. If set to No, it will list blobs hierarchically, by virtual directory.

Create and populate dataset with blob names

Text

Yes

(Empty)

RESULTDATASET="theBlobInfo"

The name of the dataset to create and populate with blob information. Details regarding the dataset names/return values that this activity creates can be found below under Datasets.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Datasets

A dataset is a multi-column, multi-row object that contains a collection of information gathered during execution of an activity and stored in memory. This activity creates and populates a dataset with the following fields (rows):

Name

Type

Return Value

theDataset.ETag

Text

The blob's Etag value (e.g., 0x8CE71042DD2B12A).

theDataset.LastModifiedUTC

Date

The last modified date/time for the blob (e.g., 11/14/2012 4:47:06 PM).

theDataset.Metadata

Text

The blob's metadata (if any).

theDataset.Name

Text

The unique name of the blob.

theDataset.Uri

Text

The blob address.

theDataset.Snapshot

Date

The snapshot date time value.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: List blobs from container "mycontainer" and store its information into dataset "theDataset". Azure account name is "netauto".

<AMAZURESTORAGE ACTIVITY="list_blobs" RESULTDATASET="theDataset" 
CONTAINER="mycontainer" LISTING="All" ACCOUNTNAME="netauto" 
ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE="none" />