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" TIMEOUT="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.
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:
|
||||
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 |
|
The type of protocol used to access Azure Storage. The available options are:
|
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://
|
|
Queue endpoint URI |
Text |
No |
(Empty) |
QUEUEENDPOINT="http://
|
The
endpoint for the Queue service, as configured for the Azure storage
account. The default Queue service endpoint is |
Table endpoint URI |
Text |
No |
(Empty) |
TABLEENDPOINT="http://
|
|
Proxy type |
Text (options) |
No |
System default |
|
The type of proxy server to connect through (if required). The available options are:
|
Proxy server |
Text |
No |
(Empty) |
|
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. |
Resource
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 selected, all existing queue metadata will be cleared. If disabled (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. |
Example
- 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 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" /> |