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)" SESSION="text" />
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.
Parameters
Credentials
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Account name | Text | Yes | (Empty) | ACCOUNTNAME="myaccount" | The globally unique name of the Windows Azure storage account. |
Access key | Text | Yes | (Empty) | ACCESSKEY="[AccessKey]" | The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. |
Session | Text | Yes | 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. |
Advanced
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
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 [http|https]://accountname.table.core.windows.net, where accountname is the name of the Azure Storage account. |
Proxy type | Text (options) | Yes | Default |
|
The
type of proxy required for SharePoint connections passing through
a proxy server. The available options are:
|
Use authentication | --- | --- | --- | --- | 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 | No | (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. |
Examples
- 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.
Example 1: Sample Blob Session (step description embedded in task).
<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto" ACCESSKEY="AM2rpq73bKmXN7UmqHdyKZZ3qCaiN3apmzen5q83eWmU967mr7d7aZs3oma592opmjeiZqF3eymLN60mpTdg6YY2g==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" />