SendCustomRequest Method
Sends a custom request to the Azure Blob Storage service.
Syntax
azureblob.sendCustomRequest(httpMethod, blob, requestBody, [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 can be used to send arbitrary requests to the Azure Blob Storage service.
Valid values for HttpMethod are:
- GET (default if empty)
- HEAD
- POST
- PUT
- DELETE
The Blob and RequestBody parameters may be empty if not needed.
Usage
When this method is called, the class does the following:
- Builds a request URL, including query parameters, using the following:
- Adds request headers from:
- APIVersion
- LeaseId (if non-empty)
- IfMatch (if non-empty)
- OtherHeaders
- Authenticates the request using Authorization (if non-empty), or AccessKey (in which case the request is signed).
- Sends the request, including RequestBody if non-empty.
- Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or BlobData (using the same logic as GetBlob).
If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.