Azure Storage - List queues

Declaration

<AMAZURESTORAGE ACTIVITY="list_queue" SESSION="text" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" PROTOCOL="text (options)" TIMEOUT="number" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" PREFIX="text" RESULTDATASET="text" LISTING="text (options)" />

Related Topics    

Description

Lists all of the queues in a given storage account or a collection of queues with names that begin with the specified prefix and populates a dataset with results.

Practical usage

Used to retrieve information regarding a collection of queues. Other Azure Storage activities can be performed on the queues upon retrieval (for example, Delete queue, Set queue metadata, Clear queue, etc.).

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where user credentials and preferences should originate from. The available options are:
  • Host (default) - Specifies that user credentials and 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 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.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.

Connection - Session

Property Type Required Default Markup Description
Session Text Yes, if Connection is set to Session AzureStorageSession1 SESSION="MyAzureSession" The name of the Azure Storage session to create. The default value is AzureStorageSession1.
NOTE: Use the Azure Storage - End session activity to end an active Azure Storage session.

Connection - Host > Credentials

Property Type Required Default Markup Description
Account name Text Yes, if Connection is set to Host (Empty) ACCOUNTNAME="myaccount" The globally unique name of the Windows Azure storage account.
Access key Text Yes, if Connection is set to Host (Empty) ACCESSKEY="[AccessKey]" The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. 

Connection - Host > Advanced

Property Type Required Default Markup Description
Protocol Text (options) No HTTPS
  • PROTOCOL="HTTPS"
  • 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) Yes System default
  • PROXYTYPE="none"
  • PROXYTYPE="http"
 The type of proxy required for SharePoint connections passing through a proxy server. The available options are:
  • System default (default) - Points to the default proxy used by the system.
  • None - No proxy authentication required.
  • HTTP - Proxy type is HTTP.
Use authentication --- No --- --- If enabled, specifies proxy authentication is required, enabling authentication-based parameters (disabled by default). It is active only if the Proxy type parameter is set to HTTP.
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes.
Proxy server Text Yes, if Proxy type is set to HTTP (Empty) PROXYSERVER="proxy.host.com" The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP.
Proxy username Text No (Empty) PROXYUSERNAME="username" The proxy username to authenticate with. This parameter is available only if Use authentication is enabled.
Proxy port Number No 808 PROXYPORT="8080" The port number to use to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 808.
Proxy password Text No (Empty) PROXYPASSWORD="encrypted" The proxy password to authenticate with. This parameter is available only if Use authentication is enabled.

Queue

Property Type Required Default Markup Description
Prefix (optional) Text No (Empty) PREFIX="myqueue" Filters the results to return only queues whose name begins with the specified prefix. If this parameter is empty, all queues will be listed.
Listing details Text (options) Yes None
  • LISTING="None"
  • LISTING="Metadata"
  • LISTING="All"
 Denotes which queue details to include in the response (if any). The available options are:
  • None (default) - No container details should be included in the response.
  • Metadata - The container's metadata should be returned as part of the response body.
  • All - All container metadata should be returned as part of the response body.
Create and populate dataset with queue information Text Yes (Empty) SOURCE="C:\PDFFileName.pdf" The name of the dataset to create and populate with queue information. For details regarding the dataset names/return values this activity creates, see Datasets below.

Description

Error Causes

On Error

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.EncodeMessage Text The encode message of the queue.      
theDataset.Metadata Text The queue's metadata.      
theDataset.Name Text The unique name of the queue.      
theDataset.TotalMessages Number The total number of messages contained in the queue.      
theDataset.Uri Text The URI of the queue (for example, http://netauto.queue.core.windows.net/myqueue).      

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

A sample task that populates a dataset with queue information. A Loop Dataset activity is then used to loop through the list of queues. During each iteration, a message box is displays information about the current queue.

Copy 
<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" SESSION="myQueueSession" />
<!-- List queues -->
<AMAZURESTORAGE ACTIVITY="list_queue" SESSION="myQueueSession" RESULTDATASET="queueInfo" LISTING="None" />
<!-- Loop dataset -->
<AMLOOP ACTIVITY="dataset" DATASET="queueInfo"><!-- Display message box with information on current queue  --><AMSHOWDIALOG WINDOWTITLE="Queue information">Queue name: %queueInfo.Name%Queue address: %queueInfo.URI%Total messages: %queueInfo.TotalMessages%</AMSHOWDIALOG><!-- End loop --></AMLOOP>
<!-- Display message box with information on current queue  -->
<AMSHOWDIALOG WINDOWTITLE="Queue information">Queue name: %queueInfo.Name%Queue address: %queueInfo.URI%Total messages: %queueInfo.TotalMessages%</AMSHOWDIALOG>
<!-- End loop -->
<AMLOOP ACTIVITY="end" />
<!-- End session -->
<AMAZURESTORAGE ACTIVITY="end_session" SESSION="myQueueSession" />