AzureBlob Class
Properties Methods Events Configuration Settings Errors
The AzureBlob class provides an easy to use interface to Microsoft's Azure Blob Storage service.
Syntax
ipworkscloud.azureblob()
Remarks
The AzureBlob class offers an easy-to-use API for the Microsoft Azure Blob Storage service. Capabilities include uploading and downloading blobs of all types, strong encryption support, container management, and more.
Authentication
Authentication is simple, set the Account property to the name of the Azure Storage account to operate against, and set the AccessKey property to an Azure access key associated with that account.
Alternatively, this class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:
Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQAssign this value to the Authorization property before attempting any operations. Consult the Azure Blob Storage service's documentation for more information about using OAuth authentication.
Usage
Once authenticated, you can start interacting with the Azure Blob Storage service. The following list shows some of the methods used to accomplish common tasks:
- Container management: ListContainers, GetContainerInfo, CreateContainer, DeleteContainer, GetContainerACL, SetContainerACL
- Blob management: ListBlobs, GetBlobInfo, UpdateBlobInfo, CreateBlob, CopyBlob, GetBlob, DeleteBlob, UndeleteBlob
- Block blob management: ListBlocks, PutBlock, PutBlockList
- Page blob management: ListPageRanges, PutPages, ClearPages, UpdatePageBlob
- Append blob management: AppendBlock
The class support much more than just the functionality described above; refer to the complete API, below, for more information.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AccessKey | The Azure access key to use for authentication. |
AccessPolicyCount | The number of records in the AccessPolicy arrays. |
AccessPolicyExpiryTime | The expiry time of the access policy. |
AccessPolicyId | The unique Id of the access policy. |
AccessPolicyPermissions | The permissions that the access policy grants. |
AccessPolicyStartTime | The start time of the access policy. |
Account | The Azure storage account name. |
Authorization | OAuth 2.0 Authorization Token. |
BlobData | The data that was downloaded, or that should be uploaded. |
BlobDelimiter | The delimiter string to use when listing blobs. |
BlobMarker | A marker indicating what page of blobs to return next. |
BlobCount | The number of records in the Blob arrays. |
BlobContainer | The container that the blob resides in. |
BlobContentDisposition | The blob's content disposition. |
BlobContentEncoding | The blob's content encoding. |
BlobContentLength | The size of the blob. |
BlobContentMD5 | An MD5 hash of the blob's content. |
BlobContentType | The blob's content type. |
BlobCreatedTime | The creation time of the blob. |
BlobETag | The ETag of the blob. |
BlobIsLeased | Whether the blob is current leased. |
BlobIsLeaseInfinite | Whether the blob's lease duration is infinite. |
BlobLeaseState | The lease state of the blob. |
BlobModifiedTime | The last modified time of the blob. |
BlobName | The name of the blob. |
BlobSequenceNum | The sequence number of the page blob. |
BlobSnapshot | The blob snapshot identifier. |
BlobSoftDeleted | Whether the blob has been soft-deleted. |
BlobType | The blob's type. |
BlockCount | The number of records in the Block arrays. |
BlockId | The Id of the block. |
BlockSize | The size of the block. |
BlockType | The type of block. |
Container | Selects a container. |
ContainerMarker | A marker indicating what page of containers to return next. |
ContainerCount | The number of records in the Container arrays. |
ContainerETag | The ETag of the container. |
ContainerHasImmutabilityPolicy | Whether an immutability policy is set on the container. |
ContainerHasLegalHold | Whether there are any legal holds on the container. |
ContainerIsLeased | Whether the container is currently leased. |
ContainerIsLeaseInfinite | Whether the container's lease duration is infinite. |
ContainerLeaseState | The lease state of the container. |
ContainerModifiedTime | The last modified time of the container. |
ContainerName | The name of the container. |
ContainerPublicAccess | The container's public access level. |
EncryptionAlgorithm | The encryption algorithm. |
EncryptionPassword | The encryption password. |
FirewallAutoDetect | This property tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
Idle | The current status of the class. |
LeaseId | The lease Id to include when making requests. |
LocalFile | The location of the local file. |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
MetadataCount | The number of records in the Metadata arrays. |
MetadataName | The name of the metadata item. |
MetadataValue | The value of the metadata item. |
OtherHeaders | Other headers as determined by the user (optional). |
Overwrite | Whether to overwrite the local file, or remote blob. |
PageRangeCount | The number of records in the PageRange arrays. |
PageRangeFirst | The first byte of the range. |
PageRangeLast | The last byte of the range. |
ParsedHeaderCount | The number of records in the ParsedHeader arrays. |
ParsedHeaderField | This property contains the name of the HTTP header (same case as it is delivered). |
ParsedHeaderValue | This property contains the header contents. |
Prefix | A prefix used to restrict the results returned when listing blobs or containers. |
ProxyAuthScheme | This property is used to tell the class which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the class whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
QueryParamCount | The number of records in the QueryParam arrays. |
QueryParamName | The name of the query parameter. |
QueryParamValue | The value of the query parameter. |
Range | The range of bytes to request. |
Snapshot | The blob snapshot to make requests against. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
StartByte | The byte offset from which to resume the upload or download. |
Timeout | A timeout for the class. |
UseSSL | Whether to use SSL/TLS when connecting. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AbortCopy | Aborts a copy operation. |
AddBlock | Adds a block to the Blocks properties. |
AddMetadata | Adds a metadata item to the Metadata properties. |
AddQueryParam | Adds a query parameter to the QueryParams properties. |
AppendBlock | Appends a block of data to an append blob. |
ClearPages | Clears a range of pages in a page blob. |
Config | Sets or retrieves a configuration setting. |
CopyBlob | Copies a blob. |
CreateBlob | Creates a new blob of the specified type. |
CreateContainer | Creates a new container. |
CreateSnapshot | Creates a new snapshot of a blob. |
DeleteBlob | Deletes a blob. |
DeleteContainer | Deletes a container. |
GetBlob | Downloads a blob. |
GetBlobInfo | Gets a blob's information and metadata. |
GetContainerACL | Gets the stored access policies and public access level for a container. |
GetContainerInfo | Gets a container's information and metadata. |
GetLink | Creates a link that provides access to a container, blob, or snapshot. |
GetUserDelegationKey | Requests a new user delegation key. |
Interrupt | Interrupt the current method. |
Lease | Creates or manages a lease on a blob or container. |
ListBlobs | Lists the blobs in a container. |
ListBlocks | Lists the blocks associated with a block blob. |
ListContainers | Lists the containers in the blob storage account. |
ListPageRanges | Lists the page ranges of a page blob. |
PutBlock | Uploads a new block of data to a block blob. |
PutBlockList | Commits a list of data blocks to a block blob. |
PutPages | Uploads a range of pages to a page blob. |
Reset | Resets the class to its initial state. |
SendCustomRequest | Sends a custom request to the Azure Blob Storage service. |
SetContainerACL | Sets the stored access policies and public access level for a container. |
UndeleteBlob | Undeletes a soft-deleted blob. |
UpdateBlobInfo | Updates a blob's information. |
UpdateMetadata | Sets the metadata for a blob or container. |
UpdatePageBlob | Updates a page blob's size and/or sequence number. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
BlobList | Fires once for each blob returned when listing blobs. |
BlockList | Fires once for each block returned when listing blocks. |
ContainerList | Fires once for each container returned when listing containers. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
FragmentComplete | Fires after each block in an automatic block-based upload is complete. |
Header | Fired every time a header line comes in. |
Log | Fires once for each log message. |
MetadataList | Fires once for each metadata item returned when listing metadata. |
PrefixList | Fires once for each common prefix returned when listing blobs. |
Progress | Fires during an upload or download to indicate transfer progress. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
AccumulatePages | Whether the class should accumulate subsequent pages of results when listing them. |
APIVersion | The Azure Storage REST API version being used by the class. |
AppendedBlockCount | The number of blocks that have been appended to the append blob. |
AutoAddBlocks | Whether to automatically add an item to the Blocks collection after a block is uploaded. |
BlobAccessTier[i] | The access tier of the specified blob. |
BlobAccessTierChanged[i] | The time at which the specified blob's access tier was last changed. |
BlobAccessTierInferred[i] | Whether the specified blob's access tier is inferred. |
BlobArchiveStatus[i] | The rehydration status of the specified blob. |
BlobCacheControl[i] | The Cache-Control value of the specified blob. |
BlobContentLanguage[i] | The content language of the specified blob. |
BlobRetentionDaysLeft[i] | The number of days left before the specified soft-deleted blob is permanently deleted. |
BlobSoftDeleteTime[i] | The time at which the specified blob was soft-deleted. |
BlockListStringSeparator | The separator string to use when parsing a block list string. |
CopyId | The Id of a copy operation. |
CopyProgress | The progress of a copy operation. |
CopySourceURL | The Azure storage URL to use as the copy source. |
CopyStatus | The status of a copy operation. |
CopyStatusDesc | The status description for a copy operation. |
DateFormat | The format to use for date and time. |
DownloadTempFile | The temporary file used when downloading encrypted data. |
EncodeBlockIds | Whether the class should automatically Base64-encode and -decode block Ids. |
EncryptionIV | The initialization vector to be used for encryption/decryption. |
EncryptionKey | The key to use during encryption/decryption. |
Endpoint | The Azure Storage endpoint suffix that the class should use. |
FragmentSize | The block size to use when uploading a new block blob. |
IfMatch | The ETag which the blob must currently have in order for a request to succeed. |
IncludeSnapshots | Whether blob snapshots should be included when listing blobs. |
IncludeSoftDeleted | Whether soft-deleted blobs should be included when listing blobs. |
IncludeUncommittedBlobs | Whether uncommitted block blobs should be included when listing blobs. |
LeaseBreakPeriod | The approximate number of seconds the lease will remain in the 'breaking' state. |
ListWithMetadata | Whether to include metadata items when listing blobs or containers. |
MaxResults | The maximum number of results to return when listing blobs or containers. |
PageRangeCleared[i] | Whether the specified page range has been cleared. |
Prefix[i] | The i'th common prefix returned. |
PrefixCount | The number of common prefixed returned. |
PreviousSnapshot | An opaque DateTime value that identifies the snapshot to list page range changes since. |
ProgressAbsolute | Whether the class should track transfer progress absolutely. |
ProgressStep | How often the progress event should be fired, in terms of percentage. |
RawRequest | Returns the data that was sent to the server. |
RawResponse | Returns the data that was received from the server. |
SendMetadata | Whether to send metadata items when creating blobs and containers. |
SendMetadataOnCopy | Whether to send metadata items when copying blobs. |
SendMetadataOnPutBlockList | Whether to send metadata items when committing a new block list. |
SendMetadataOnSnapshot | Whether to send metadata items when creating a blob snapshot. |
SharedAccessSignature | Specifies a SAS token to use for authentication. |
SimpleUploadLimit | The maximum data size the class should attempt to upload directly when creating a block blob. |
StorePrefixList | Whether to store the common prefixes returned when listing blobs. |
TempPath | The path to the directory where temporary files are created. |
UserDelegationKey | A user delegation key to use for constructing SAS tokens. |
XChildCount | The number of child elements of the current element. |
XChildName[i] | The name of the child element. |
XChildXText[i] | The inner text of the child element. |
XElement | The name of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the returned XML or JSON response. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the class. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the class will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the class. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the class. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the class binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACertFilePaths | The paths to CA certificate files on Unix/Linux. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |