Azure Storage - List entities |
Declaration
<AMAZURESTORAGE ACTIVITY="list_entities" TABLE="text" RESULTDATASET="theDataset" QUERY="text" PROTOCOL="text (options)" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" TIMEOUT="number" PROXYTYPE="none" /> |
Description
Queries entities in a table and populates a dataset with results.
Practical Usage
Commonly used to retrieve entities contained in a table in order to perform other Azure Storage related operations on them.
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. |
Entity
Property |
Type |
Required |
Default |
Markup |
Description |
Table name |
Text |
Yes |
(Empty) |
TABLE="mytable" |
The unique name of the table that contains the entities to retrieve. |
Query (optional) |
Text |
No |
(Empty) |
QUERY="text" |
The query to perform. |
Create and populate dataset with entity information |
Text |
Yes |
(Empty) |
RESULTDATASET="theDataset" |
The name of the dataset to create and populate with entity information. More information about this dataset can be found below under Datasets. |
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.PartitionKey |
Text |
The entity's partition key value. A partition is a consecutive range of entities possessing the same partition key value. The partition key is a unique identifier for the partition within a given table. The partition key forms the first part of an entity's primary key. The partition key may be a string value up to 1 KB in size. |
theDataset.RowKey |
Text |
The entity's row key value. The row key is a unique identifier for an entity within a given partition. Together the PartitionKey and RowKey uniquely identify every entity within a table. |
theDataset.Timestamp |
Date |
The entity's timestamp value. The Timestamp property is a date/time value that is maintained on the server side to record the time an entity was last modified. |
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="AM5Crw6dfj34nTvVFV4QVSkTdoPdIO5XOwFh4+DKk8nmGI=aME" 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" />