Azure Storage - List containers |
Declaration
<AMAZURESTORAGE RESULTDATASET="text" PREFIX="text" LISTING="text (options)" PROTOCOL="text (options)" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" TIMEOUT="number" /> |
Description
Lists all containers in a storage account or all containers whose names begin with the specified prefix, and optionally returns container metadata. Results are populated into a dataset.
Practical Usage
Used to retrieve information about specific containers within an 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. |
Container
Property |
Type |
Required |
Default |
Markup |
Description |
Prefix (optional) |
Text |
No |
(Empty) |
PREFIX="text" |
Filters the results to return only containers whose name begins with the specified prefix. If this parameter is empty, all containers will be listed. |
Listing details |
Text (options) |
No |
None |
|
Denotes which container details to include in the response (if any). The available options are:
|
Create and populate dataset with container information |
Text |
Yes |
(Empty) |
RESULTDATASET="myDataset" |
The name of the dataset to create and populate with container information. For details regarding the dataset names/return values this activity creates, see Datasets below. |
Additional Notes
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 container's Etag value (i.e. 0x8CE71042DD2B12A). |
theDataset.LastModifiedUTC |
Date |
The last-modified date/time for the container (i.e. 11/14/2012 4:47:06 PM). |
theDataset.Metadata |
Text |
The container's metadata (if any). |
theDataset.Name |
Text |
The unique name of the container. |
theDataset.Uri |
Text |
The URI of the container (i.e. http://netauto.blob.core.windows.net/$root). |
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: Create and populate dataset "theDataset" with containers information. Azure account name is "netauto".
<AMAZURESTORAGE RESULTDATASET="theDataset" PREFIX="mycontainer" LISTING="All" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE="" /> |