Azure Storage - Insert entity

 

Declaration

<AMAZURESTORAGE ACTIVITY="insert_entity" TABLE="text" PARTITIONKEY="text" ROWKEY="text" PROTOCOL="text (options)" ACCOUNTNAME="text" ACCESSKEY="text (encrypted)" BLOBENDPOINT="text" QUEUEENDPOINT="text" TABLEENDPOINT="text" TIMEOUT="number"><PROPERTY NAME="text" TYPE="text (options)" VALUE="text" /></AMAZURESTORAGE>

Related Topics    

Description

Inserts one or more new entities into a table. Entities are similar to rows.

Practical Usage

Can be used to insert entities into a table as a means to update records or enter supplemental data. An entity has a primary key and a set of properties. A property is a name, typed-value pair, similar to a column. Each entity also has 3 system properties that specify a partition key, a row key, and a timestamp. Entities with the same partition key can be queried more quickly, and inserted/updated in atomic operations. An entity's row key is its unique identifier within a partition.

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:

  • 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
  1. PROTOCOL="HTTPS"
  2. 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

  1. PROXYTYPE="default"

  2. PROXYTYPE="none"

  3. 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)

  1. PROXYSERVER="serv.domain.com"

  2. 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.

Resource

Property

Type

Required

Default

Markup

Description

Table name

Text

Yes

(Empty)

TABLE="mytable"

The unique name of the table in which to insert an entity.

Partition key

Text

Yes

(Empty)

 PARTITIONKEY="[system string]"

The partition key of the entity to insert. A partition is a successive range of entities that have the same partition key value. The partition key is a unique identifier for a partition within a given table.

Row key

Text

 Yes

(Empty)

ROWKEY="[system string]"

The row key of the entity to insert. The row key is a unique identifier for an entity within a given partition.

Property Name

Text

 Yes

(Empty)

NAME="Last Name"

The name of the entity to insert. Select Click here to add new row... to add a new row of data to specify the entity name, content type and value.

Property Type

Text

Yes

(Empty)

TYPE="string"

The entity type to insert. Select Click here to add new row... to add a new row of data to specify the entity name, content type and value.

Property Value

Text

 Yes

(Empty)

VALUE="Smith"

The entity value to insert. Select Click here to add new row... to add a new row of data to specify the entity name, content type and value.

 

Description

Error Causes

On Error

Example

NOTE:
  • 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 sample task demonstrates use of the 'Insert Entity' activity. It initially creates an Azure Storage session as the first step. Within the session, the task creates a new table and inserts an entity into the newly created table. The last step ends the session as well as the task.

<!-- Create session -->

<AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto" ACCESSKEY="AM2rpq73bKmXN7UmqHdyKZZ3qCaiN3apmzen5q83eWmU967mr7d7aZs3oma592opmjeiZqF3eymLN60mpTdtaZu3oiamN3Upk/ev5qb3YOmGNo=aME" PROTOCOL="http" SESSION="MyAzureSession" />

<!-- Create table -->

<AMAZURESTORAGE ACTIVITY="create_table" TABLE="CustomerInformation" PROVIDER="session_based" SESSION="MyAzureSession" />

<!-- Insert entity -->

<AMAZURESTORAGE ACTIVITY="insert_entity" TABLE="CustomerInformation" PARTITIONKEY="2" ROWKEY="3" PROVIDER="session_based" SESSION="MyAzureSession"><PROPERTY NAME="customer1.email" TYPE="string" VALUE="customer@domain.com" /><PROPERTY NAME="customer1.phone" TYPE="string" VALUE="510-555-1212" /><PROPERTY NAME="customer1.city" TYPE="string" VALUE="Los Angeles" /></AMAZURESTORAGE>

<!-- End session -->

<AMAZURESTORAGE ACTIVITY="end_session" SESSION="MyAzureSession" />