Azure Storage - Peek message(s)

Declaration

<AMAZURESTORAGE ACTIVITY="peek_messages" 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)" QUEUE="text" RESULTDATASET="text" />

Related Topics    

Description

Retrieves one or more messages from the front of the queue, but does not alter the visibility of the message.

Practical usage

Commonly used to read the contents of a message without altering it in any way. When a message is retrieved using this activity, the visibility of the message is unchanged. The message remains available to other users of the queue.

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.

Message

Property Type Required Default Markup Description
Queue name Text Yes (Empty) QUEUE="myqueue" The unique name of the storage queue that contains the message to peek at.
Create and populate dataset with message information Text (options) Yes (Empty) RESULTDATASET="Message" The name of the dataset to create and populate with information about the message to peek at. See Datasets below for more details.

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 runtime and stored in memory. This activity creates and populates a dataset with the following fields (rows):

Name Type Return Value
theDataset.ExpiryTime Date The date/time that the policy expires (for example, 10/30/2022 7:43:00 AM)
theDataset.Name Text The policy name.
theDataset.Permissions Text The current permission level (that is, Read, Write, Delete, List).
theDataset.StartTime Date The date/time that the policy was initially set.

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

This sample task peeks messages from a queue, and then creates and populates a dataset with the results.

Copy 
<AMAZURESTORAGE ACTIVITY="peek_messages" QUEUE="myqueue" RESULTDATASET="theDataset" PROTOCOL="http" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" />