Azure Storage - Delete blob |
Declaration
<AMAZURESTORAGE ACTIVITY="delete_blob" CONTAINER="text" BLOB="text" DELETESNAPSHOT="text (options)" 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="test (encrypted)" /> |
Description
Deletes a specific blob from a given container.
Practical Usage
Commonly used to delete old or unused blobs.
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:
|
||||
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 |
|
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://
|
|
Queue endpoint URI |
Text |
No |
(Empty) |
QUEUEENDPOINT="http://
|
The
endpoint for the Queue service, as configured for the Azure storage
account. The default Queue service endpoint is |
Table endpoint URI |
Text |
No |
(Empty) |
TABLEENDPOINT="http://
|
|
Proxy type |
Text (options) |
No |
System default |
|
The type of proxy server to connect through (if required). The available options are:
|
Proxy server |
Text |
No |
(Empty) |
|
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 name of the container that houses the blob to delete. |
Blob name |
Text |
Yes |
(Empty) |
BLOB="myblob" |
The name of the blob to delete. |
Delete snapshots option |
Text (options) |
No |
(Empty) |
|
Sets options for deleting snapshots when a blob is to be deleted. The available options are:
|
Examples
- 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.
Example 1: Delete blob "myblob" from container "mycontainer". Azure account name is "netauto."
<AMAZURESTORAGE ACTIVITY="delete_blob" CONTAINER="mycontainer" BLOB="myblob" DELETESNAPSHOT="IncludeSnapshots" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" PROXYTYPE="" />
Example 2: Example blob session (step description embedded in task).
<!-- Create session -->
<AMAZURESTORAGE ACTIVITY="create_session" ACCOUNTNAME="netauto" ACCESSKEY="AM3kbFvH+pgzDo=aME" SESSION="AzureSession" />
<!-- Download blob -->
<AMAZURESTORAGE ACTIVITY="download_blob" SESSION="AzureStorageSession1" CONTAINER="MyContainer" BLOB="MyLargeBlob" FILE="C:\temp\blobcontent.txt" OVERWRITE="YES" />
<!-- Snapshot blob -->
<AMAZURESTORAGE ACTIVITY="snapshot_blob" CONTAINER="mycontainer" BLOB="mylargeblob" PROVIDER="session_based" SESSION="AzureSession" />
<!-- Delete blob -->
<AMAZURESTORAGE ACTIVITY="delete_blob" CONTAINER="mycontainer" BLOB="mylargeblob" DELETESNAPSHOT="None" PROVIDER="session_based" SESSION="AzureSession" />
<!-- End session -->
<AMAZURESTORAGE ACTIVITY="end_session" SESSION="AzureSession" />