Azure Storage - List queues

 

Declaration

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

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 (i.e. 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. 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 '[http|https]://accountname.table.core.windows.net', where 'accountname'is the name of the Azure Storage account.

Proxy type

Text (options)

No

System default

  1. PROXYTYPE="default"

  2. PROXYTYPE="none"

  3. PROXYTYPE="HTTP"

The type of proxy server to connect through (if required). The available options are:

  • System default (default) - Access always passes through a default proxy server.

  • None - No proxy server is required.

  • HTTP - Communication is through an HTTP proxy server.

Proxy server

Text

No

(Empty)

  1. PROXYSERVER="serv.domain.com"

  2. PROXYSERVER="197.264.334.21"

 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.

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
  1. LISTING="None"
  2. LISTING="Metadata"
  3. 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 (i.e. http://netauto.queue.core.windows.net/myqueue).

Example

NOTE:
  • 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 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" />