Azure Storage - Set blob properties

 

Declaration

<AMAZURESTORAGE ACTIVITY="set_blobproperties" CONTAINER="text" BLOB="text" CACHECONTROL="text" CONTENTENCODING="text" CONTENTMD5="text" CONTENTTYPE="text" CONTENTLANGUAGE="text" 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)"><METADATA NAME="text" VALUE="text" /></AMAZURESTORAGE>

Related Topics    

Description

Sets system properties and user-defined metadata on the specified blob container. Can also be used to remove all or specific properties and/or metadata that currently exists for a blob container.

Practical Usage

Can be used to set metadata as a means to store additional values for a blob. Set system properties to correspond to certain standard HTTP headers or to allow the client to correctly handle the contents being sent.

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.

Blob

Property

Type

Required

Default

Markup

Description

Container name

Text

Yes

(Empty)

CONTAINER="mycontainer"

The unique name of the container that contains the blob in which to set properties on.

Blob name

Text

Yes

(Empty)

BLOB="myblob"

The unique name of the blob in which to set properties.

Content type

Text

No

(Empty)

CONTENTTYPE="image/png”

The blob content type. If sharing blog content with other clients, it's important to correctly define the content type of each storage blob in order for the client to correctly handle the contents being shared. If this property is not specified on the request, then the property will be cleared for the blob.

Content encoding

Text

No

(Empty)

CONTENTENCODING="utf-8"

The content-encoding for the blob. Use this value to specify the content encoding applied to the blob. This is mainly used when using compression. If this property is not specified on the request, then the property will be cleared for the blob.

Content language

Text

No

(Empty)

CONTENTLANGUAGE="value"

The content-language header for the blob, which is used to define what language the blob content is set to. If this property is not specified on the request, then the property will be cleared for the blob.

Content MD5

Text

No

(Empty)

CONTENTMD5="value

An MD5 hash of the blob content. This hash is used to verify the integrity of the blob during transport. When this header is specified, the storage service checks the hash that has arrived with the one that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). If this property is not specified on the request, then the property will be cleared for the blob.

Cache control

Text

No

(Empty)

CACHECONTROL="value"

The cache-control HTTP header for the blob, which allows you to instruct the browser to cache the blob item for a specified time. The Blob service stores this value but does not use or modify it.

Advanced

Property

Type

Required

Default

Markup

Description

Metadata Name

Text

No

(Empty)

NAME="metadataname"

The metadata name to set for the blob. User-defined metadata is data that you specify on a given resource, in the form of a name-value pair. Select Click here to add new row... to expose a grid in which to define a new metadata name-value pair. Multiple rows can be added. To delete a row, click the red 'X'.

Metadata Value

Text

No

(Empty)

VALUE="metadatavalue"

The metadata value to define for the blob. User-defined metadata is data that you specify on a given resource, in the form of a name-value pair. Select Click here to add new row... to expose a grid in which to define a new metadata name-value pair. Multiple rows can be added. To delete a row, click the red 'X'.

Clear all metadata

Text

No

(Empty)

CLEARMETADATA="YES"

If selected, clears all metadata that currently exists for the blob. If disabled, existing metadata will remain.

 

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: Set properties for blob "mylargeblob" in container "mycontainer". Azure account name is "netauto".

 

<AMAZURESTORAGE ACTIVITY="set_blobproperties" CONTAINER="mycontainer" BLOB="mylargeblob" CACHECONTROL="value" CONTENTENCODING="utf-8" CONTENTMD5="value" CONTENTTYPE="application/octet-stream" CONTENTLANGUAGE="test" CLEARMETADATA="yes" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE=""><METADATA NAME="City" VALUE="Los Angeles" /><METADATA NAME="State " VALUE="California" /></AMAZURESTORAGE>