Azure Storage - Download entities
Declaration
<AMAZURESTORAGE ACTIVITY="download_entities" SESSION="text" 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)" TABLE="text" FILE="text" OVERWRITE="YES/NO" INCLUDECOLUMNTYPES="YES/NO" USECOLUMNHEADER="YES/NO" INCLUDENULLVALUES="YES/NO" />
Description
Download one or more entities to a comma-separated values (.csv) file or comma-delimited text (.txt) file.
Practical usage
Used to move large amounts of cloud data to a local system.
Parameters
Connection
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Connection | --- | --- | --- | --- | Indicates where user
credentials and preferences should originate from. The available options are:
NOTE: This parameter does not contain markup and is only displayed in visual mode for task construction and configuration purposes. |
Connection - Session
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Session | Text | Yes, if Connection is set to Session | 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. |
Connection - Host > Credentials
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Account name | Text | Yes, if Connection is set to Host | (Empty) | ACCOUNTNAME="myaccount" | The globally unique name of the Windows Azure storage account. |
Access key | Text | Yes, if Connection is set to Host | (Empty) | ACCESSKEY="[AccessKey]" | The primary or secondary access key (each composed of 88 ASCII characters) used to authorize access to Azure Storage. |
Connection - Host > 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 | System default |
|
The
type of proxy required for SharePoint connections passing through
a proxy server. The available options are:
|
Use authentication | --- | No | --- | --- | 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 | Yes, if Proxy type is set to HTTP | (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. |
Entity
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Table name | Text | Yes | (Empty) | TABLE="mytable" | The unique name of the table that contains the entities to download. |
File | Text | Yes | (Empty) | FILE="c\temp\data.csv | The path and file name of the destination .csv file. In visual mode, click the folder icon to open a Save As dialog allowing navigation to the output folder/file or simply enter the path and file name in the text box. |
Overwrite | Yes/No | No | Yes | OVERWRITE="yes" | If selected, matching files found in the destination will be overwritten. If disabled, matching files will not be overwritten, however, a runtime error is thrown as a result. Disabled by default |
Use columns as first row | Yes/No | No | Yes | USECOLUMNHEADER="no" | If selected, the first row of downloaded data will be listed as a header row of column names in the .csv file (for example, PartitionKey, RowKey, Timestamp, CustId, StartDate, IsActive). Selected by default. |
Include column types | Yes/No | No | No | INCLUDECOLUMNTYPES="yes" | If selected, the header row of column names will also include column type information. (for example, CustId:int, StartDate:datetime, IsActive:bool). Disabled by default. |
Include null values | Yes/No | No | No | INCLUDENULLVALUES="no" | If selected, specifies that null values will be included in the .csv file and marked as "null". These values area translated back to null property values if the file is subsequently uploaded back into table storage. Selected by default. |
Example
NOTE:
- 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.
Description
This sample task downloads entities from a table and then stores them in a file.
Copy
<AMAZURESTORAGE ACTIVITY="download_entities" TABLE="CustData" FILE="c:\temp\CustomerData.csv" OVERWRITE="yes" INCLUDECOLUMNTYPES="yes" ACCOUNTNAME="netauto" ACCESSKEY="AM2jZq/3eKmed6Nmszdg6YY3A==aME" />