Azure Storage - List tables

Declaration

<AMAZURESTORAGE ACTIVITY="list_tables" RESULTDATASET="text" 
PREFIX="text" PROTOCOL="text (options)" ACCOUNTNAME="text" 
ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" 
QUEUEENDPOINT="text" TABLEENDPOINT="text" 
TIMEOUT="number" />

Description: Returns an enumerable collection of all table names or a collection of table names that begin with the specified prefix for the storage account and populates a dataset with the results.

Practical Usage

Used to retrieve information about a collection of tables contained in a storage account.

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. The default session name is 'AzureStorageSession1'.

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 '

Property

Prefix (optional)

Text

No

(Empty)

PREFIX="system.string"

The table name prefix to return. If this parameter is empty, all table names contained in the storage account will be returned.

Create and populate dataset with table information

Text

Yes

(Empty)

RESULTDATASET="tableinfo"

The name of the dataset to create and populate with information regarding the list of tables. For more details regarding the dataset created by this activity, see Datasets below.

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 runtime and stored in memory. This activity creates and populates a dataset with the following rows:

Name

Type

Return Value

theDataset.Name

Text

The name of the table.

Example

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

Description: A simple task that lists tables and entities. 

<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" 
ACCOUNTNAME="netauto" ACCESSKEY="AM2rpq73bKmXN7UmqHdyKZZ3qCaiN3apmzen5q83eWmU967mr7d7aZs3oma592opmjeiZqF3eymLN60mpTdtaZu3oiamN3Upk/ev5qb3eCmGNg=aME" 
PROTOCOL="http" SESSION="AzureStorageSession1" />
<!-- List Tables -->
<AMAZURESTORAGE ACTIVITY="list_tables" 
RESULTDATASET="theDataset" PROVIDER="session_based" 
SESSION="AzureStorageSession1" />
<!-- List entities -->
<AMAZURESTORAGE ACTIVITY="list_entities" 
TABLE="sampletable" RESULTDATASET="entityInfo" 
PROVIDER="session_based" SESSION="AzureStorageSession1" />
<!-- End Session -->
<AMAZURESTORAGE ACTIVITY="end_session" 
SESSION="AzureStorageSession1" />