Azure Storage - Set queue metadata

Declaration

<AMAZURESTORAGE ACTIVITY="set_queue_metadata" QUEUE="text" 
CLEARMETADATA="yes" PROTOCOL="http" ACCOUNTNAME="text" 
ACCESSKEY="AM2mJqp3fumbN7smszdg6YY3g==aME" BLOBENDPOINT="text" 
QUEUEENDPOINT="text" TABLEENDPOINT="text" 
TIMOUT="number" PROXYTYPE="http" PROXYSERVER="text" 
PROXYPORT="number" PROXYUSERNAME="text" 
PROXYPASSWORD="AM2mJqp3fumbN7smszdg6YY3g==aME">
<METADATA NAME="text" VALUE="text" /></AMAZURESTORAGE>

Description: Sets user-defined metadata on the specified queue or clears a queue of existing metadata.

Practical Usage

Provide information about the contents of a queue. User-defined metadata is data that you specify on a given resource, in the form of a name-value pair.

Connection Parameters

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 Property

Resource Parameters

Property

Type

 Required

Default

 Markup

Description

Queue name

Text

Yes

(Empty)

QUEUE="myqueue"

The unique name of the queue in which metadata should be set.

Metadata Name

Text

No

(Empty)

NAME="metadataName"

The metadata name to set for the queue. User-defined metadata is data that you specify on a given resource, in the form of a name-value pair. Select Click here to add new row... to expose a grid in which to define a new metadata name-value pair. Multiple rows can be added. To delete a row, click the red 'X'.

Metadata Value

Text

No

(Empty)

VALUE="metadataValue"

The metadata value to define for the queue. User-defined metadata is data that you specify on a given resource, in the form of a name-value pair. Select Click here to add new row... to expose a grid in which to define a new metadata name-value pair. Multiple rows can be added. To delete a row, click the red 'X'.

Clear all metadata

Yes/No

No

No

CLEARMETADATA="yes"

If set to YES, all existing queue metadata will be cleared. If set to NO (default), existing queue metadata will remain.

NOTE: Existing queue metadata can also be deleted by calling this operation without specifying any metadata name-value pairs.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: This task creates an Azure Storage session which creates a queue, sets queue metadata, adds a message to the newly created queue and ends the session.

<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" 
ACCOUNTNAME="netauto" ACCESSKEY="AM2mJqp3fCmbN7smszdg6YY3g==aME" 
SESSION="myQueueSession" />
<!-- Create queue -->
<AMAZURESTORAGE ACTIVITY="create_queue" 
QUEUE="myqueue" PROVIDER="session_based" SESSION="myQueueSession" />
<!-- Set queue metadata -->
<AMAZURESTORAGE ACTIVITY="set_queue_metadata" 
QUEUE="myqueue" PROVIDER="session_based" SESSION="myQueueSession">
<METADATA NAME="Office" VALUE="Automation" /></AMAZURESTORAGE>
<!-- Add message to queue --><AMAZURESTORAGE ACTIVITY="put_message" 
QUEUE="myqueue" FILE="C:\temp\output.txt" 
PROVIDER="session_based" SESSION="myQueueSession" />
<!-- End Session --><AMAZURESTORAGE ACTIVITY="end_session" 
SESSION="myQueueSession" />