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.
Parameters
Connection
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:
|
||||
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 |
|
The type of protocol used to access Azure Storage. The available options are:
|
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://
|
|
Queue endpoint URI |
Text |
No |
(Empty) |
QUEUEENDPOINT="http://
|
The
endpoint for the Queue service, as configured for the Azure storage
account. The default Queue service endpoint is |
Table endpoint URI |
Text |
No |
(Empty) |
TABLEENDPOINT="http://
|
|
Proxy type |
Text (options) |
No |
System default |
|
The type of proxy server to connect through (if required). The available options are:
|
Proxy server |
Text |
No |
(Empty) |
|
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. |
Table
Property |
Type |
Required |
Default |
Markup |
Description |
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. |
Additional Notes
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.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
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" />
|