send_custom_request Method

Sends a custom request to the Azure Blob Storage service.

Syntax

def send_custom_request(http_method: str, blob: str, request_body: str) -> None: ...

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:

1. Builds a request URL, including query parameters, using the following:
   • use_ssl
   • account (must be non-empty)
   • container (if non-empty)
   • Blob (if non-empty)
   • snapshot (if both it and Blob are non-empty)
   • QueryParam*
2. Adds request headers from:
   • APIVersion
   • lease_id (if non-empty)
   • IfMatch (if non-empty)
   • other_headers
3. Authenticates the request using authorization (if non-empty), or access_key (in which case the request is signed).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file, or blob_data (using the same logic as get_blob).

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.