GetBlob Method

Reads or downloads a blob, including its metadata and properties.

Syntax

azureblob.getBlob(blobName, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method will read or download the blob specified by blobName. If LocalFile is set to an empty string, the blob content will be stored in BlobData. Otherwise the content of the blob will be written directly to the specified file.

BlobSnapshot can be specified to retrieve the content of a specific snapshot.

Optionally, LeaseId can be set in which case the operation will only be performed if the following two conditions are met;

• The blob's lease is currently active.
• The lease ID specified in the request matches that of the blob.

To decrypt blob content, EncryptionPassword can be set to the needed password value.