Azure Storage - Download blob

Declaration

<AMAZURESTORAGE ACTIVITY="donwload_blob" CONTAINER="text" 
BLOB="text" FILE="text" OVERWRITE="yes/no" 
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)" />

Description: Downloads a blob's contents to a file or existing variable.

Practical Usage

Used to download large chunks backup data or retrieve files initially stored for distributed access.

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	PROTOCOL="HTTPS" 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	PROXYTYPE="default" PROXYTYPE="none" 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)	PROXYSERVER="serv.domain.com" 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.

Blob Parameters

Property	Type	Required	Default	Markup	Description
Container name	Text	Yes	(Empty)	CONTAINER="muOwnContainer"	The unique name of the container from which to download the blob.
Blob name	Text	Yes	(Empty)	BLOB="myBlob"	The unique name of the Bob to download.
Store Blob content in file	Text	No	(Empty)	FILE="c:\temp\myFile.txt"	If enabled, specifies that blob content will be downloaded to a file in the local file system. Enter the path and file name of the target file in the provided text box. Enabling this parameter automatically disables the Populate variable with content parameter and vice versa. This parameter is enabled by default.
Overwrite	Yes/No	No	No	OVERWRITE="no"	If set to YES, matching files that exist in the destination folder are to be overwritten. If set to NO (default), matching files will not be overwritten, however, an error will occur as a result of a matching file found.
Populate variable with blob content	Text	No	(Empty)	PASSWORD="encrypted"	If enabled, blob content will be saved in the variable specified. Enter the name of an existing variable in the provided text box. Enabling this parameter automatically disables the Store Blob content into file parameter and vice versa. This parameter is disabled by default.

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: Sample Azure Storage blob operations (step description embedded in task).

<!--Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" 
ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" 
SESSION="AzureSession" />
<!-- Download blob -->
<AMAZURESTORAGE ACTIVITY="donwload_blob" 
CONTAINER="mycontainer" BLOB="mylargeblob" 
FILE="C:\temp\blobcontent.txt" OVERWRITE="yes" 
PROVIDER="session_based" SESSION="AzureSession" />
<!-- Snapshot blob -->
<AMAZURESTORAGE ACTIVITY="snapshot_blob" 
CONTAINER="mycontainer" BLOB="mylargeblob" 
PROVIDER="session_based" SESSION="AzureSession" />
<!-- Delete blob -->
<AMAZURESTORAGE ACTIVITY="delete_blob" 
CONTAINER="mycontainer" BLOB="mylargeblob" 
DELETESNAPSHOT="None" PROVIDER="session_based" 
SESSION="AzureSession" />
<!-- End session -->
<AMAZURESTORAGE ACTIVITY="end_session" 
SESSION="AzureSession" />

v10 | 202208121109

Copyright Help/Systems LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.