Azure Storage - Update container

Declaration

<AMAZURESTORAGE ACTIVITY="update_container" 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)" CONTAINER="text" ACCESSLEVEL="text (options)" CLEARMETADATA="YES/NO" CLEARSAP="YES/NO"><METADATA NAME="text" VALUE="text" /><SHAREDACCESSPOLICY NAME="text" READ="True/False" WRITE="True/False" DELETE="True/False" LIST="True/False" STARTTIME="date time" EXPIRYTIME="date time" /></AMAZURESTORAGE>

Related Topics   

Description

Updates public access permissions, shared access policies and one or more user-defined name-value pairs for the specified container.  

Practical usage

Useful for updating information or synchronizing data on a preset schedule or on demand.

Parameters

Connection

Property Type Required Default Markup Description
Connection --- --- --- --- Indicates where user credentials and preferences should originate from. The available options are:
  • Host (default) - Specifies that user credentials and 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 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.
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
  • 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) Yes System default
  • PROXYTYPE="none"
  • PROXYTYPE="http"
 The type of proxy required for SharePoint connections passing through a proxy server. The available options are:
  • System default (default) - Points to the default proxy used by the system.
  • None - No proxy authentication required.
  • HTTP - Proxy type is HTTP.
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.

Container

Property Type Required Default Markup Description
Container name Text Yes (Empty) CONTAINER="mycontainer" The unique name of the container to update.
Public access Text (options) No Private
  • ACCESSLEVEL="publicblob"
  • ACCESSLEVEL="publiccontainer"
  • ACCESSLEVEL="private"
 If enabled, specifies the public access permissions level to set for the container, which determine whether container data and blob resources are available for anonymous access. This parameter is disabled by default. The available options are:
  • Public blob - Public read access for blobs only. Blob data within this container can be read by way of anonymous request, but container data is not available. Clients cannot enumerate blobs within the container by way of anonymous request.
  • Public container - Full public read access. Container and blob data can be read by way of anonymous request. Clients can enumerate blobs within the container by way of anonymous request, but cannot enumerate containers within the storage account.
  • Private (default) - No public read access. Container and blob data can be read by the account owner only.

Advanced

Property Type Required Default Markup Description
Metadata Name Text No (Empty) NAME="theName" The metadata name to define for the container. 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 inserted. To delete a row, click the red 'X'.
Metadata Value Text No (Empty) VALUE="theValue" The metadata value to define for the container. 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 inserted. To delete a row, click the red 'X'.
Policy Text No (Empty) NAME="mypolicy" The name of the container-level access policy to define. This policy can be used to specify parameters for the container's shared access signature. Select Click here to add new row to expose a grid in which to define new container-level access policy. Multiple rows can be inserted. To delete a row, click the red 'X'.
Read True/False No False READ="True" If TRUE, read operations are permitted on the shared resource. If FALSE (default), read operations are prohibited. This parameter is active only if the Allowed read operations include:
  • Read the content, properties, metadata or block list of any blob in the container.
  • Use any blob in the container as the source of a copy operation.
Write True/False No False WRITE="True" If TRUE, write operations are permitted on the shared resource. If FALSE (default), write operations are prohibited. Allowed write operations include:
  • Create or write content, properties, metadata, or block list for any blob in the container.
  • Snapshot or lease the blob.
Delete True/False No False DELETE="False" If TRUE, delete operations are permitted on the shared resource. If FALSE (default), delete operations are prohibited. Allowed delete operations include the ability to delete any blob in the container.
List True/False No False LIST="True" If TRUE, list operations are permitted on the shared resource. If FALSE (default), list operations are prohibited. Allowed list operations include the ability to list blobs in the container.
Start time Text No (Empty) STARTTIME="2012-10-01" The date/time at which the shared access signature becomes valid. Press the down button to open a date/time window in which to select a start time.
Expiry time Text No (Empty) EXPIRYTIME="2012-10-01" The time at which the shared access signature becomes invalid. Press the down button to open a date/time window in which to select a expiry time.
Clear all metadata Yes/No No No CLEARMETADATA="yes" If selected, all metadata that currently exist for the container will be cleared. If disabled (default), existing metadata will not be cleared.
Clear all shared access policies Yes/No No No CLEARSAP="yes" If selected, all shared access policies that currently exist for the container will be cleared. If disabled (default), existing shared access policies will not be cleared.

Description

Error Causes

On Error

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 task creates an Azure Storage session, creates a container, updates the container, uploads a blob onto the container, and finally, ends the session.

Copy 
<!-- 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" />