Azure Storage - Delete message

Declaration

<AMAZURESTORAGE ACTIVITY="delete_message" QUEUE="text" ID="text" POSTRECEIPT="text" PROTOCOL="text (options)" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" TIMEOUT="number" PROXYTYPE="text (options)" PROXYSERVER="text" PROXYPORT="number" PROXYUSERNAME="text" PROXYPASSWORD="text (encrypted)" />

Related Topics   

Description

Deletes a specific message from the queue based on the message ID and post receipt value. These values are returned by the Get message activity in the form of a dataset.

Practical Usage

Commonly used to delete a message after it has been retrieved and processed. When a message is successfully deleted, it is immediately marked for deletion and is no longer accessible to clients. The message is later removed from the queue during garbage collection.

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.

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.

Message

Property

Type

Required

Default

Markup

Description

Queue name

Text

Yes

 (Empty)

QUEUE="myQueue"

The unique name of the storage queue containing the message to delete.

Message ID

Text

Yes

 (Empty) ID="[SystemString]"

The message ID value. This is a system string value returned by a subsequent Get message step that identifies the message in the queue.

Post receipt

Text

Yes

 (Empty) POSTRECEIPT="[SystemString]"

The post or pop receipt value. This receipt indicates that the message has been retrieved and its value can be used to delete it. In order for this delete operation to succeed, the pop receipt specified on the request must match the pop receipt returned by the Get all messages  activity.

Description

Error Causes

On Error

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: This sample task creates an Azure storage session, retrieves all messages from a specified queue and populates a dataset with results. It then loops through the dataset of retrieved queue messages and deletes a message with a specific ID/POP receipt. An End session activity marks the end of the session as well as the task.

Copy 
<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto2004" ACCESSKEY="AM2rpq73bKmXN7UmqHdyKZZ3qCaiN3apmzen5q83eWmU967mr7d7aZs3oma592opmjeiZqF3eymLN60mpTdtaZu3oiamN3Upk/ev5qb3eCmK96Vmq7dzqZO3pyant3vplfeq5q23fGmYN7HmuPdyqZZ3tyajt3UpnHevJqg3femed6impnd7KZ+3r2aht3pplnevJr43aimat7Ymvvd4aZz3sOai93KpmjepJq73b6mJd7smszdg6YY3g==aME" PROTOCOL="http" SESSION="myQueueSession" />
<!-- Get all messages from queue -->
<AMAZURESTORAGE ACTIVITY="get_all_message" QUEUE="myqueue" RESULTDATASET="theDataset" DELETE="no" PROVIDER="session_based" SESSION="myQueueSession" />
<!-- Loop dataset -->
<AMLOOP ACTIVITY="dataset" DATASET="theDataset"><!-- Delete message with specific ID/Pop receipt --><AMAZURESTORAGE ACTIVITY="delete_message" QUEUE="myqueue" ID="3b402357-2f5c-4b10-ae71-d9aca57e3f4e" POSTRECEIPT="AgAAAAEAAACzOQAALzOCMJGkzAE=" PROVIDER="session_based" SESSION="myQueueSession" /><!-- End loop --></AMLOOP>
<!-- Delete message with specific ID/Pop receipt -->
<AMAZURESTORAGE ACTIVITY="delete_message" QUEUE="myqueue" ID="3b402357-2f5c-4b10-ae71-d9aca57e3f4e" POSTRECEIPT="AgAAAAEAAACzOQAALzOCMJGkzAE=" PROVIDER="session_based" SESSION="myQueueSession" />
<!-- End loop -->
<AMLOOP ACTIVITY="end" />
<!-- End session -->
<AMAZURESTORAGE ACTIVITY="end_session" SESSION="myQueueSession" />