Azure Storage - Rename blob

Declaration

<AMAZURESTORAGE ACTIVITY="rename_blob" 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)" SOURCECONTAINER="text" SOURCEBLOB="text" DESTCONTAINER="text" DESTBLOB="text" DELETESNAPSHOT="text (options)" />

Related Topics    

Description

Renames and/or moves a blob to a new container by copying the original blob and its contents to the specified container and (optionally) a new blob name, and deletes the original blob.

Practical usage

Renames a blob to a new name, moves a blob to another container or both.

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. Manually enter an access key, or click the icon to select from the list of credentials variables available to you that may correspond with this activity.

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.

Blob

Property Type Required Default Markup Description
Source Container name Text Yes (Empty) SOURCECONTAINER="thecontainer" The unique name of the source container that contains the blob to rename.
Source Blob name Text Yes (Empty) SOURCEBLOB="originalblobname" The unique name of the blob to rename.
Destination Container name Text Yes (Empty) DESTCONTAINER="otherContainer" The unique name of the destination container.
Destination Blob name Text Yes (Empty) DESTBLOB="newblobname" The destination blob name. To only move the blob (without renaming it), enter the original blob name in the provided text box. To rename the blob, enter the new name in the text box.   
Delete snapshots option Text (options) No (Empty)
  • DELETESNAPSHOT="IncludeSnapshots"
  • DELETESNAPSHOT="None"
  • DELETESNAPSHOT="DeleteSnapshotsOnly"
 Sets options for deleting snapshots when a blob is to be deleted. The available options are:
  • None (default) - Delete blobs but not snapshots.
  • Include snapshots - Delete the blob and its snapshots.
  • Delete snapshots only - Delete the blob's snapshots only.

Description

Error Causes

On Error

Examples

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 renames a blob.

Copy 
<AMAZURESTORAGE ACTIVITY="rename_blob" SOURCECONTAINER="originalcontainer" SOURCEBLOB="originalblobname" DESTCONTAINER="newcontainer" DESTBLOB="newblobname" DELETESNAPSHOT="None" ACCOUNTNAME="netauto" ACCESSKEY="AM23pr+3bGmKt7emv7dsaYq3t6a/t2xpire3pr+3bGmKt7emv7dsaYq3t6a/t2xpire3pr+3bGmKt7emv7dsaYq3t6azN2DphjcaME" PROXYTYPE="" />