Azure Storage - Create session
Declaration
<AMAZURESTORAGE ACTIVITY="create_session" 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)" />
Description: Creates a unique session in which to attach subsequent Azure Storage activities to. This allows a single task the ability to execute numerous Azure Storage operations that exist in multiple sessions simultaneously. To end a session, use the End session activity.
Practical Usage
Commonly used as a means of organizing and encapsulating a collection of related activities required to accomplish a particular task or process. The use of sessions can ensure consistency and eliminate redundancy.
Connection Parameters
Property | Type | Required | Default | Markup | Descrpition |
---|---|---|---|---|---|
Account name |
Text |
Yes if connection is host-based |
(Empty) |
ACCOUNTNAME="myaccount" |
The globally unique name of the Windows Azure storage account. |
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. |
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:// 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 |
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 theProxy |
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 theProxy |
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 |
Proxy password |
Text |
No |
(Empty) |
PROXYPASSWORD="[encrypted]" |
The password to authenticate with the proxy server. This parameter is active only ifUse authenticationparameter is enabled. |
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.)
Examples
The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.
Example 1: Sample Blob Session (step description embedded in task).
<!-- Create session --> <AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto" ACCESSKEY="AM2rpq73bKmXN7UmqHdyKZZ3qCaiN3 apmzen5q83eWmU967mr7d7aZs3oma592opmjeiZqF3eymLN60mpTdg6YY2g==aME" PROTOCOL="http" SESSION="MySession" /> <!-- Create container --> <AMAZURESTORAGE ACTIVITY="create_container" CONTAINER="mycontainer" ACCESSLEVEL="publiccontainer" PROVIDER="session_based" SESSION="MySession"><METADATA NAME="Data" VALUE="Documents" /></AMAZURESTORAGE> <!-- Update container --> <AMAZURESTORAGE ACTIVITY="update_container" CONTAINER="mycontainer" ACCESSLEVEL="publiccontainer" PROVIDER="session_based" SESSION="MySession"><SHAREDACCESSPOLICY NAME="mypolicy" READ="True" WRITE="True" DELETE="True" LIST="True" STARTTIME="11/13/2011 12:00:00 AM" EXPIRYTIME="11/15/2011 12:00:00 AM" /></AMAZURESTORAGE> <!-- Upload blob --> <AMAZURESTORAGE ACTIVITY="upload_blob" CONTAINER="mycontainer" FILE="C:\temp\sourceForm.pdf" PROVIDER="session_based" SESSION="MySession" /> <!-- End Session --> <AMAZURESTORAGE ACTIVITY="end_session" SESSION="MySession" /> |
Example 2: Sample Queue Session (step description embedded in task).
<!-- 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" /> |