AzureFile Class

Properties   Methods   Events   Configuration Settings   Errors  

The AzureFile class provides an easy to use interface to Microsoft's Azure File Storage service.

Syntax

AzureFile

Remarks

The AzureFile class offers an easy-to-use API for the Microsoft Azure File Storage service. Capabilities include uploading and downloading files, strong encryption support, creating folders, file manipulation, 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.

Addressing Resources

Azure File Storage accounts can contain one or more file shares. Use the ListShares method to list available shares, and select which one the class should operate against using the Share property.

After selecting a share, address the files and folders within it using Linux-style absolute paths. Unless otherwise specified, the class always works in terms of absolute paths, and will always prepend a forward slash (/) to any path passed to it that does not already start with one.

Listing Directory Contents

ListResources lists resources (files and folders) within the specified directory. Calling this method will fire the ResourceList event once for each resource, and will also populate the Resource* properties.

// ResourceList event handler.
azurefile.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

azurefile.Share = "myshare";
do {
  azurefile.ListResources("/work_files/serious_business/cats");

  for (int i = 0; i < azurefile.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(azurefile.ResourceMarker));

Downloading Files

The DownloadFile method downloads files.

If LocalFile is set, the file will be saved to the specified location; otherwise, the file data will be held by ResourceData.

To download and decrypt an encrypted file, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading a file looks like this:

azurefile.LocalFile = "../MyFile.zip";
azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download.

string downloadFile = "../MyFile.zip";
azurefile.LocalFile = downloadFile;
azurefile.DownloadFile(azurefile.Resources[0].Path);

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially downloaded file
azurefile.StartByte = new FileInfo(downloadFile).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile.

azurefile.LocalFile = "../MyFile.zip";
azurefile.EncryptionPassword = "password";
azurefile.DownloadFile(azurefile.Resources[0].Path);

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially download temp file
azurefile.StartByte = new FileInfo(azurefile.Config("DownloadTempFile")).Length;
azurefile.DownloadFile(azurefile.Resources[0].Path);

Uploading Files

The UploadFile method uploads new files.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ResourceData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

Upload Notes

The UploadFile method is a convenience method that performs a resumable file upload. When called, the class first uses CreateFile to initialize a new file entry on the server; and then it fragments the file data into smaller pieces and calls PutRange multiple times in succession to upload those fragments. The fragment size is fixed at 4MB (this is a server limitation that cannot be changed).

During the upload, the FragmentComplete event fires after each fragment is uploaded to indicate overall progress. The class also updates StartByte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that StartByte is populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call UploadFile again to resume the upload at the specified StartByte offset.

azurefile.LocalFile = "../MyFile.zip";
azurefile.UploadFile("MyFile.zip");

//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte is already populated from the previous upload attempt.
azurefile.UploadFile("MyFile.zip");

Additional Functionality

The AzureFile class offers advanced functionality beyond simple uploads and downloads. For instance:

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AccessKeyThe Azure access key to use for authentication.
AccountThe Azure storage account name.
EncryptionAlgorithmThe encryption algorithm.
EncryptionPasswordThe encryption password.
FirewallAutoDetectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdleThe current status of the class.
LocalFileThe location of the local file.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
MetadataCountThe number of records in the Metadata arrays.
MetadataNameThe name of the metadata item.
MetadataValueThe value of the metadata item.
OtherHeadersOther headers as determined by the user (optional).
OverwriteDetermines if local files are overwritten.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
PrefixA prefix used to restrict the results returned when listing resources or shares.
ProxyAuthSchemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
QueryParamCountThe number of records in the QueryParam arrays.
QueryParamNameThe name of the query parameter.
QueryParamValueThe value of the query parameter.
RangeCountThe number of records in the Range arrays.
RangeFirstThe first byte of the range.
RangeLastThe last byte of the range.
ResourceDataThe data that was downloaded, or that should be uploaded.
ResourceMarkerA marker indicating what page of resources to return next.
ResourceCountThe number of records in the Resource arrays.
ResourceContentMD5An MD5 hash of the file's content.
ResourceContentTypeThe content type of the resource.
ResourceETagThe ETag of the resource.
ResourceModifiedTimeThe last modified time of the resource.
ResourceNameThe name of the resource.
ResourcePathThe path of the resource.
ResourceShareThe name of the share the resource resides in.
ResourceSizeThe size of the file.
ResourceTypeThe resource's type.
ShareSelects a share.
ShareMarkerA marker indicating what page of shares to return next.
ShareCountThe number of records in the Share arrays.
ShareETagThe ETag of the share.
ShareModifiedTimeThe last modified time of the share.
ShareNameThe name of the share.
ShareQuotaThe share's space quota, in GB.
ShareSpaceUsedThe amount of storage space consumed by the share.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartByteThe byte offset from which to start the upload or download.
TimeoutA timeout for the class.
UseSSLWhether 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.

AbortCopyAborts a copy operation.
AddMetadataAdds a metadata item to the Metadata properties.
AddQueryParamAdds a query parameter to the QueryParams properties.
ClearRangeClears a range of bytes from a file.
ConfigSets or retrieves a configuration setting.
CopyFileCopies a file.
CreateFileInitializes a new file.
CreateFolderCreates a new folder.
CreateShareCreates a new share.
DeleteFileDeletes a file.
DeleteFolderDeletes a folder.
DeleteShareDeletes a share.
DownloadFileDownloads a file.
GetFileInfoGets a file's information and metadata.
GetFolderInfoGets a folder's information and metadata.
GetLinkCreates a link that provides access to a share or file.
GetRangesGets the list of allocated data ranges in a file.
GetShareInfoGets a share's information and metadata.
InterruptInterrupt the current method.
ListResourcesLists resources in a given folder.
ListSharesLists shares in the file storage account.
PutRangeUploads a range of data to a file.
ResetResets the class to its initial state.
ResizeFileResizes a file.
SetShareQuotaSets a share's space quota.
UpdateMetadataSets the metadata for a file, folder, or share.
UploadFileUploads a new file resource.

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.

EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
FragmentCompleteFires after each fragment of a resumable upload is completed.
HeaderFired every time a header line comes in.
LogFires once for each log message.
ProgressFires during an upload or download to indicate transfer progress.
ResourceListFires once for each resource returned when listing resources.
ShareListFires once for each share returned when listing shares.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
TransferFired 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.

AccumulatePagesWhether the class should accumulate subsequent pages of results when listing them.
APIVersionThe Azure Storage REST API version being used by the class.
CopyIdThe Id of a copy operation.
CopyProgressThe progress of a copy operation.
CopyStatusThe status of a copy operation.
CopyStatusDescThe status description for a copy operation.
CreateShareQuotaSpecifies an initial space quota to impose when creating shares.
DeleteShareSnapshotsWhether to automatically delete share snapshots when deleting a share.
DownloadTempFileThe temporary file used when downloading encrypted data.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during encryption/decryption.
EndpointThe Azure Storage endpoint suffix that the class should use.
MaxResultsThe maximum number of results to return when listing resources or shares.
ProgressAbsoluteWhether the class should track transfer progress absolutely.
ProgressStepHow often the progress event should be fired, in terms of percentage.
RawRequestReturns the data that was sent to the server.
RawResponseReturns the data that was received from the server.
SendMetadataWhether to send metadata items when creating files and folders.
SendMetadataOnCopyWhether to send metadata items when copying files.
SharedAccessSignatureSpecifies a SAS token to use for authentication.
TempPathThe path to the directory where temporary files are created.
XChildCountThe 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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the returned XML or JSON response.
XSubTreeA snapshot of the current element in the document.
XTextThe text of the current element.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to true the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Qt Edition - Version 20.0 [Build 8265]